CheetahMail

Skip to end of metadata
Go to start of metadata

 

Overview

Gigya’s integration with CheetahMail combines Gigya's rich, permission-based social and other profile info with CheetahMail's enterprise email marketing service solutions. 

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

  • Creating and updating users in CheetahMail based on information from Gigya.
  • Updating user data in Gigya based on information from CheetahMail.
  • Extracting segments using filter criteria.

Integration with CheetahMail does not require any implementation. Just contact your Gigya Implementation Consultant and we will handle the details. You can specify exactly which social and site data you want Gigya to synchronize.

Integration with CheetahMail is a premium service requiring activation. For more information, please contact your Gigya Implementation Consultant 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.

For inbound user synchronization, the integration with Gigya can only update data for users already existing in Gigya's database. New users are not created.

Setting up a Gigya-Cheetah mail 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.