Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titledatasource.write.hybrismarketing

Write data to the SAP Marketing Cloud platform (previously Hybris Marketing). For the full guide for setting up the implementation, see SAP Marketing Cloud

RequiredParameter NameTypeDefaultDescription
Yes
contactFieldstring The field that contains the unique identifier(e.g: Gigya's UID).
Yes
endpointstring The SAP Marketing Cloud authentication endpoint.
Yes
passwordstring The SAP Marketing Cloud password.
Yes
usernamestring The SAP Marketing Cloud user name.
No
emailFieldstring The name of the Gigya field that contains the contact's email. The value is mapped to the "ContactPermissionID" field in SAP Marketing Cloud.
No
marketingAreaFieldstring The name of the Gigya field that contains the marketing area information. The value is mapped to the "MarketingArea" field in SAP Marketing Cloud.
No
mobileFieldstring The name of the Gigya field that contains the contact's mobile phone number. The value is mapped to the "MobileNumber" field in SAP Marketing Cloud.
No
timeoutinteger The timeout (in seconds) to wait for a response from SAP Marketing Cloud.
No
subscriptionsarray of objects 

An array of JSON objects that contain the subscription properties:

  • newsletterField (string): The Gigya field to use for subscription status
  • communicationCategory (string): The Marketing Cloud Communication Category ID

To include a period in the name of the target field, surround the field name with single apostrophes. For example:

Code Block
"subscriptions":[
      {
        "newsletterField":"data.myNewsletterField",
        "communicationCategory":"41"
      }
    ]
No
consentarray of objects 

An array of JSON objects that contain the consent properties:

  • consentField (string): The Gigya field to use for the consent status
  • communicationMedium (string): The marketing cloud communication medium. The default value is "EMAIL". Acceptable values: "EMAIL", "FBFACEBOOK", "GOOGLE_ADS", "YOUTUBE", "INSTAGRAM", "SMS", "PHONE".
  • communicationType (string): Marketing cloud communication medium type. The default value is "EMAIL". Acceptable values are "EMAIL" and "MOBILE".

To include a period in the name of the target field, surround the field name with single apostrophes. For example:

Code Block
"consent":[
      {
        "consentField":"preferences.terms.isConsentGranted",
        "communicationMedium":"EMAIL",
		"communicationType" : "EMAIL"
      }
    ]
No
maxConnectionsinteger1The maximum number of connections that can be opened concurrently. Accepts values between 1 and 100.

Following is a sample dataflow that writes the user's UID, email, first name and last name from Gigya to Hybris:

Code Block
languagejs
linenumberstrue
{
    "name": "Hybris Marketing outbound",
    "description": "account > rename > hybris",
    "steps": [{
            "id": "account",
            "type": "datasource.read.gigya.account",
            "params": {
                "select": "UID,profile.email,profile.firstName,profile.lastName" // read these fields from the Gigya database
            },
            "next": ["rename"]
        }, {
            "id": "rename",
            "type": "field.rename", // rename the fields to match the Hybris field format
            "params": {
                "fields": [{
                        "sourceField": "profile.email",
                        "targetField": "EmailAddress"
                    }, {
                        "sourceField": "profile.firstName",
                        "targetField": "FirstName"
                    }, {
                        "sourceField": "profile.lastName",
                        "targetField": "LastName"
                    }
                ]
            },
            "next": ["hybris"]
        }, {
            "id": "hybris",
            "type": "datasource.write.hybrismarketing", // write to Hybris Marketing
            "params": {
                "username": "...",
                "password": "...",
                "endpoint": "...",
                "contactIdField": "UID" // match between Gigya's UID field and Hybris' contact ID. 
            }
        }
    ]
}

...