CX Works

A single portal for curated, field-tested and SAP-verified expertise for your SAP C/4HANA suite. Whether it's a new implementation, adding new features, or getting additional value from an existing deployment, get it here, at CX Works.

External Campaigns in SAP Marketing Cloud Using Khoros (2/4)

A how-to on executing external campaigns in SAP Marketing Cloud using Khoros | Part 2: SAP Marketing Cloud and Khoros Configurations

This is the second article in the series to explain how external campaigns can be created in SAP Marketing Cloud for the social media management platform - Khoros. In this article, SAP Marketing Cloud and Khoros related configurations will be explained. To better understand the external campaign use case using SAP Marketing Cloud and Khoros, please visit Part 1 of this series. The usage of SAP Cloud Platform Integration (CPI) as a middleware and the corresponding integration flows will be discussed in the subsequent articles in this series.


The scenario described in this article was built using SAP Marketing Cloud 1811 release, SAP Cloud Platform Integration (CPI) build number 2.46.16 and Khoros Conversations V2 API.

Table of Contents

SAP Marketing Cloud Configuration

According to the concept of external campaigns in SAP Marketing Cloud, the campaigns created in SAP Marketing Cloud will be linked with the external campaigns created and executed in Khoros. SAP Marketing Cloud campaigns will behave as a proxy to the Khoros campaigns. Additionally, the campaigns will be created in SAP Marketing Cloud without a target group. SAP Marketing Cloud configurations will be divided into two parts for building this end-to-end scenario with Khoros:

Configurations for custom campaign category for external campaigns

Configurations to integrate with Khoros

Configurations for Custom Campaign Category for External Campaigns

As a first step to build this use case, it is required to create a custom campaign category in SAP Marketing Cloud. In general, the SAP Marketing Cloud solution comes with a predefined external campaign category that can be set up for use with the external system of your choice. It is possible to use the standard campaign category provided for external campaign with campaign category ID as EEC or you can create an additional campaign category.

Below is a view of a standard campaign category for externally executed campaigns:


If you need an additional external campaign category for Khoros related campaigns, please open a ticket with the component XX-S4C-SRV-CON. You will need to provide the desired ID and name for the new category. For this use case, a new campaign category called EES has been created with name Khoros Campaign - Test.



Note: In future releases, as a part of the standard SAP Marketing Cloud, if a campaign category is provided for Khoros related external campaigns, this step will not be required.

Configurations to Integrate with Khoros

For external campaign execution using Khoros, it is required to set up a communication system and a communication arrangement in SAP Marketing Cloud using the Communication Management App. The following steps that are required are as follows:

Create a Communication System

Log on to SAP Marketing Cloud as an Administrator user and go to the SAP Marketing Cloud App Communication Systems:


Create a communication system and provide the following information:

System ID: Can be freely named, for example, <Name of external system>.

System Name: Can be freely named, for example, <Name of external system>.

Host Name: Instance of CPI Cloud tenant, for example, vXXXX-iflmap.axxxxxx.eu1.hana.ondemand.com>.

HTTPS Port: Needs to be provided by customer, for example, <443>.

User for Outbound Communication (User): It is required to enter customer’s user name for CPI tenant.

User for Outbound Communication (Password): It is required to enter corresponding password for CPI tenant.

Note that it is possible to communicate between SAP Marketing Cloud and SAP CPI using a client certificate. We recommend using a client certificate for this communication in place of using a User ID and Password-based authentication.

Note: The role ESBMessaging.send must be assigned to the user in SAP CPI that makes the call to CPI from SAP Marketing Cloud.


Create a Communication Arrangement

Log on to SAP Marketing Cloud as an Administrator user and go to the SAP Marketing Cloud App Communication Arrangements:



Create a communication arrangement and provide the following information:

  1. Communication Scenario ID: Choose Marketing - External Campaign Execution Integration (SAP_COM_0037) communication scenario.
  2. Communication Arrangement Name (Common Data): The name of the communication arrangement must follow this pattern: ExtCampaignExec_<Your Campaign Category ID>. For a campaign of a given campaign category, the matching communication arrangement is determined by this naming convention. For example, the communication arrangement for the campaign category EES – Khoros Campaign - Test has to be named ExtCampaignExec_EES.
  3. Communication System ID (Common Data): The communication system created for the corresponding CPI system needs to be selected. For example, the communication system CPI_V0546 needs to be selected for this case.

  4. User Name (Outbound Communication): One of the outbound users maintained in the communication system needs to be selected.
  5. Authentication Method (Outbound Communication): User ID and Password based on Basic Authentication.

  6. Campaign Parameter (Outbound Services): The path '/http/sfast2/CampaignParameterSet' points to the desired parameters of the external system.

  7. Value Help for Campaign Assignment (Outbound Services): The path '/http/sfast2/campaignset' points to the desired parameters of the external system.

  8. Marketing Success: The path '/http/sfast2/MarketingSuccessSet' points to the desired parameters of the external system.


Khoros (Formerly Spredfast) Configurations

It is required to have a Khoros developer account to check the available APIs. Also, we recommend to check the Khoros documentation in the attached link to better understand the concept of API authentication, data model, and input parameters.

Khoros API documentation: https://devcenter.spredfast.com/api

To check the APIs and to execute, the following credentials are required:

  • clientId - Your personal API key for Khoros.
  • clientSecret - Your personal API secret for Khoros.
  • loginEmail - The e-mail address you use to log in to Khoros.
  • loginPassword - The password you use to log in to Khoros.

Khoros uses oAuth2 for authentication. To get an oAuth token, you need to follow the below steps: 

  1. Log on to the Khoros developer account: https://devcenter.spredfast.com/_/login

  2. Go to API and open one of the APIs. For example, we will be testing Initiative API. Click on  the Get Access Token.
  3. Click on the Get Access Token again after providing correct credentials.

  4. Click on the Grant Access to get the oAuth access token which will be generated if the credentials are correct.





    This oauth_access_token can be used in the integration flow in SAP Cloud Platform Integration to authenticate Spredfast's API calls.

Khoros's API Details

 The https://api.spredfast.com/v2/conversations/initiative API could be used to read initiatives.


The https://api.spredfast.com/v2/conversations/initiative/{initiativeId}/plan API could be used to read campaigns (Plans in Khoros).

Conclusion

In this article, you learned about the configurations required in SAP Marketing Cloud and Khoros to build the external campaign scenario. Also, Khoros APIs mentioned in this article will be used in next section for building the CPI integration flow. In Part 3, you will learn about the configurations required in SAP Cloud Platform Integration (CPI) for this external campaign scenario.