SAP Commerce, formerly known as Hybris, is a cloud-based e-commerce platform solution for B2B and B2C enterprises and available as part of the SAP Customer Experience portfolio. SAP Subscription Billing is a product under the portfolio and enables complete subscription lifecycle management with simplified selling and payment experiences through standardized integrations.
This Adobe Experience Platform destination uses the SAP Subscription Billing customer management API, to update your customer details within SAP Commerce from an existing Experience Platform audience after activation.
Instructions to authenticate to your SAP Commerce instance are further below, in the Authenticate to destination section.
To help you better understand how and when you should use the SAP Commerce destination, here is a sample use case that Adobe Experience Platform customers can solve by using this destination.
SAP Commerce customers store information about individuals or organizational entities who interact with your business. Your team uses the customers existing in SAP Commerce to build the Experience Platform audiences. After sending these audiences to SAP Commerce, their information is updated and each customer is assigned a property with its value as the audience name that indicates which audience the customer belongs to.
Refer to the sections below for any prerequisites that you must set up in Experience Platform and SAP Commerce and for information that you must gather before working with the SAP Commerce destination.
Before activating data to the SAP Commerce destination, you must have a schema, a dataset, and audiences created in Experience Platform.
Refer to Experience Platform documentation for Audience Membership Details schema field group if you need guidance on audience statuses.
Note the following prerequisites in order to export data from Platform to your SAP Commerce account:
In order to export data from Platform to your SAP Commerce account, you need to have an SAP Subscription Billing account. If you do not have a valid billing account, contact your SAP account manager. Refer to the SAP Platform Configuration document for additional details.
https://subscriptionbilling.authentication.eu10.hana.ondemand.com
. This value will be used later to obtain values for Region
and Endpoint
.{
"url": "https://eu10.revenue.cloud.sap/api",
"uaa": {
"clientid": "XXX",
"clientsecret": "XXX",
"url": "https://subscriptionbilling.authentication.eu10.hana.ondemand.com",
"identityzone": "subscriptionbilling",
"identityzoneid": "XXX",
"tenantid": "XXX",
"tenantmode": "dedicated",
"sburl": "https://internal-xsuaa.authentication.eu10.hana.ondemand.com",
"apiurl": "https://api.authentication.eu10.hana.ondemand.com",
"verificationkey": "XXX",
"xsappname": "XXX",
"subaccountid": "XXX",
"uaadomain": "authentication.eu10.hana.ondemand.com",
"zoneid": "XXX",
"credential-type": "binding-secret"
},
"vendor": "SAP"
}
To update the Experience Platform audience status in SAP Subscription Billing, you need a custom reference field for each audience selected in Platform.
To create the custom references, Login to your SAP Subscription Billing account and navigate to the [Master Data and Configuration] > [Custom References] page. Next, select Create to add a new reference for each audience selected in Platform. You will require these reference field names in the subsequent Schedule audience export and example step.
An example of how to create a custom Reference Type within SAP Subscription Billing is shown below:
For additional guidance, refer to the SAP Subscription Billing custom references documentation.
To connect SAP Commerce to Experience Platform, you must provide values for the following connection properties:
Credential | Description |
---|---|
Client ID | The value of clientId from the service key. |
Client secret | The value of clientSecret from the service key. |
Endpoint | The value of url from the service key, it is similar to https://subscriptionbilling.authentication.eu10.hana.ondemand.com . |
Region | Your data center location. The region is present in the url and has a value similar to eu10 or us10 . For example if the url is https://eu10.revenue.cloud.sap/api you need eu10 . |
API requests to the SAP Cloud Management service are subject to Rate Limits. When the rate limit is exceeded, you will encounter a HTTP 429 Too Many Requests
response status code .
SAP Commerce supports update of identities described in the table below. Learn more about identities.
Target Identity | Description | Considerations |
---|---|---|
customerNumberSAP |
A customer identifier of the individual or corporate customer already present in your SAP Commerce account. | Mandatory |
This section describes all the audiences that you can export to this destination.
This destination supports the activation of all audiences generated through the Experience Platform Segmentation Service.
This destination also supports the activation of the audiences described in the table below.
Audience type | Supported | Description |
---|---|---|
Segmentation Service | ✓ | Audiences generated through the Experience Platform Segmentation Service. |
Custom uploads | ✓ | Audiences imported into Experience Platform from CSV files. |
Refer to the table below for information about the destination export type and frequency.
Item | Type | Notes |
---|---|---|
Export type | Profile-based |
|
Export frequency | Streaming |
|
To connect to the destination, you need the Manage Destinations access control permission. Read the access control overview or contact your product administrator to obtain the required permissions.
To connect to this destination, follow the steps described in the destination configuration tutorial. In the configure destination workflow, fill in the fields listed in the two sections below.
Within Destinations > Catalog, search for SAP Commerce. Alternatively you can locate it under the eCommerce category.
Fill in the required fields below. Refer to the Generate a service key section for any guidance.
Field | Description |
---|---|
Client ID | The value of clientId from the service key. |
Client secret | The value of clientSecret from the service key. |
Endpoint | The value of url from the service key, it is similar to https://subscriptionbilling.authentication.eu10.hana.ondemand.com . |
Region | Your data center location. The region is present in the url and has a value similar to eu10 or us10 . For example if the url is https://eu10.revenue.cloud.sap/api you need eu10 . |
To authenticate to the destination, select Connect to destination.
If the details provided are valid, the UI displays a Connected status with a green check mark. You can then proceed to the next step.
To configure details for the destination, fill in the required and optional fields below. An asterisk next to a field in the UI indicates that the field is required.
customerType
attribute. If the selection is Corporate, then the mandatory mappings like firstName
and lastName
required for an individual customer will be ignored and company
becomes mandatory and vice-versa.You can enable alerts to receive notifications on the status of the dataflow to your destination. Select an alert from the list to subscribe to receive notifications on the status of your dataflow. For more information on alerts, see the guide on subscribing to destinations alerts using the UI.
When you are finished providing details for your destination connection, select Next.
Read Activate profiles and audiences to streaming audience export destinations for instructions on activating audiences to this destination.
To correctly send your audience data from Adobe Experience Platform to the SAP Commerce destination, you must go through the field mapping step. Mapping consists of creating a link between your Experience Data Model (XDM) schema fields in your Platform account and their corresponding equivalents from the target destination. To correctly map your XDM fields to the SAP Commerce destination fields, follow the steps below:
customerNumberSAP
identityThe customerNumberSAP
identity is a mandatory mapping for this destination. Follow the steps below to map it:
customerNumberSAP
.customerNumber
identity.Source Field | Target Field | Mandatory |
---|---|---|
IdentityMap: customerNumberSAP |
Identity: customerNumber |
Yes |
An example with the identity mapping is shown below:
To add any other attributes you want to update between your XDM profile schema and your SAP Subscription Billing account, repeat the steps below:
Target field names are case sensitive and should match the SAP Subscription Billing attribute names. The only exception for this is country
where you should use countryCode
instead. SAP Subscription Billing supports alpha-2 (ISO 3166) country codes. The value is case sensitive and must be between 0-3 characters, hence ensure you provide exactly as defined else you would encounter errors: The country code {} does not exist
or size must be between 0 and 3
.
mandatory
attributes for the selected customer typeMandatory attribute mappings depend on the Type of Customer that you had selected. To map the mandatory attributes, select from the below:
Source Field | Target Field | Mandatory |
---|---|---|
xdm: person.lastName |
Attribute: lastName |
Yes |
xdm: workAddress.countryCode |
Attribute: countryCode |
Yes |
Source Field | Target Field | Mandatory |
---|---|---|
xdm: b2b.companyName |
Attribute: company |
Yes |
xdm: workAddress.countryCode |
Attribute: countryCode |
Yes |
You can then add any additional mappings between your XDM profile schema and the SAP Subscription Billing schema attributes for a customer as shown below:
Source Field | Target Field | Mandatory |
---|---|---|
xdm: person.name.firstName |
Attribute: firstName |
No |
xdm: workAddress.street1 |
Attribute: street |
No |
xdm: workAddress.city |
Attribute: city |
No |
An example with both mandatory and optional attribute mappings where the customer is an individual is shown below:
Source Field | Target Field | Mandatory |
---|---|---|
xdm: workAddress.street1 |
Attribute: street |
No |
xdm: workAddress.city |
Attribute: city |
No |
An example with both mandatory and optional attribute mappings where the customer is a corporate is shown below:
When you are finished providing the mappings for your destination connection, select Next.
When performing the Schedule audience export step, you must manually map Platform audiences to the attributes in SAP Subscription Billing.
An example of the Schedule audience export step, with the location of the SAP Commerce Mapping ID highlighted, is shown below:
To do this, select each segment, then enter name of the custom reference from SAP Subscription Billing in the SAP Commerce Mapping ID destination connector field. For guidance on creating custom references, refer to the Create custom references in SAP Subscription Billing section.
Do not use the custom reference label as the value.
For example, if your selected Experience Platform audience is sap_audience1
and you want its status to be updated into the SAP Subscription Billing custom reference SAP_1
, specify this value in the SAP_Commerce Mapping ID field.
An example Reference Type from SAP Subscription Billing is shown below:
An example of the Schedule audience export step, with an audience selected and its corresponding SAP Commerce Mapping ID highlighted, is shown below:
As shown the value within the Mapping ID field should exactly match the SAP Subscription Billing Reference Type value .
Repeat this section for each activated Platform audience.
Based on the image shown above where you have selected two audiences, the mapping would be as below:
SAP Commerce audience name | SAP Subscription Billing Reference Type | SAP Commerce Mapping ID value |
---|---|---|
sap_audience1 | SAP_1 |
SAP_1 |
SAP Audience2 | SAP_2 |
SAP_2 |
To validate that you have correctly set up the destination, follow the steps below:
Log in to the SAP Subscription Billing account, then navigate to the Contacts page to check the audience statuses. The list can be configured to display columns for the custom references and display the corresponding audience statuses.
All Adobe Experience Platform destinations are compliant with data usage policies when handling your data. For detailed information on how Adobe Experience Platform enforces data governance, see the Data Governance overview.
Refer to the SAP Subscription Billing Error Types documentation page for a list of possible error types and their response codes.
Additional useful information from the SAP documentation is below:
This section captures the functionality and significant documentation updates made to this destination connector.
Release month | Update type | Description |
---|---|---|
January 2024 | Initial release | Initial destination release and documentation publish. |