Integrations and Data Management
Integrations and Data Management
Content
Integrations & Data Management
Introduction to SAP Commerce Cloud Integrations
Integrations Compatibility Matrix
Integration API Module
Integration API Features
About Integration Objects
Integration Object Modeling
Creating a Simple Integration Object
Modeling Best Practices
Modeling using the Meta API
Advanced Integration Object Modeling
Integration Object Modeling Features
IsUnique
Deep Persistence
Root Items for Integration Objects
Classification Attributes
Configuring an Integration Object with Classification Attributes
References
Multivalue Enumerations
ValueLists
Classification Attribute Architecture Enhancements
Model Classification Attributes by Meta API
Map Attributes
Runtime Attributes
Runtime Attribute Meta API
Virtual Attributes
Script Service Meta API for Virtual Attributes
Creating Virtual Attributes in the Backoffice Integration UI Tool
Configuring Item Type Match for Integration Objects and Items
OData Services
Integration Objects and OData
Getting the Service Document for an Integration Object
Creating an EDMX Schema
The EDMX Key Value
EDMX Schema Collections
Configuration Changes to Support Integration
IsLanguageDependent
Nullable
The POST API and Persistence
How Integration API Persistence Works
Referencing Outer Items
Item Persistence
Batch and Bulk Persistence
Batch Performance
Attribute Handling
Autocreate Attributes
Circular Reference Attributes
Collection Attributes
Map Attributes for POST
Multivalue Attributes
Primitive Attributes
Reference Attributes
ValueList Attributes
Persistence Hooks
Creating a Persistence Hook
Persistence Hook Example
Localization for POST requests
The PATCH API
Localization for PATCH Requests
Map Attributes for PATCH
Using the OData2 GET API with Defined Integration Objects
Getting a Single Entity using a Defined Integration Object
Getting Multiple Entities using Defined Integration Objects
Query Options
Filter
Top and Skip
Count and Inline Count
Expand
Order By
Getting an Attribute from an Integration Object
Map and Collection Attributes for GET
Localization for GET requests
GET for Virtual Attributes
The OData2 DELETE API
Deleting an Integration Object Item
Error Messages
Outbound Features
Integration Object Outbound Services
Outbound Sync
Outbound Sync Attempt Retry
Change Log
Outbound Response Handling
Localization
Setting Maximum HTTP Connections for Outbound Services
Webhooks
Webhook Configuration
Item Filtering for Webhooks
Event Type for Webhooks
Immediate Retry for Webhooks
Performance Implications and Best Practices for Webhooks
Webhook Service Meta API
Creating Webhooks Using the Backoffice Integration UI Tool
Validating Webhook Configurations
Integration Object Modeling via Backoffice
Modeling Features
Modeling Integration Object Metadata
Integration Object Authentication
Integration Object Authorization
Integration API Request Monitoring
Inbound Monitoring
Inbound Batch API Monitoring
Inbound Bulk API Monitoring
Troubleshooting Inbound Request Errors
Outbound Monitoring
Monitoring Retention Policy
Configuring Payload Retention
Integration API Security
Authentication
Legacy Authentication
Enhanced Authentication
Authorization
Access Rights
Setting Up Access Rights for Integration Objects
Search Restrictions
Users and Group Authorization
SSL
Creating Integration API Users
Integration Backoffice Security
Integration API Meta APIs
Exporting Configuration Types
Exporting Configuration Types Using the Backoffice Integration UI Tool
Integration API Architecture
integrationservices Extension
integrationbackoffice Extension
inboundservices Extension
outboundservices Extension
odata2services Extension
odata2webservices Extension
outboundsync Extension
integrationmonitoringbackoffice Extension
outboundsyncbackoffice Extension
odata2webservicesfeaturetests Extension
integrationbackofficetest Extension
webhookbackoffice Extension
webhookservices Extension
Integration API Implementation
Integration Installation and Configuration
Installing the Integration Extensions
Updating the Log Level to Debug
Tutorial: Creating and Managing Integration Objects and Items
Creating and Viewing a Product Integration Object
Creating and Viewing a Product Integration Item
Monitoring Integration API Requests
Managing Data Retention for Inbound Requests
Troubleshooting Guide
How to Import Discount Value with Order Entry via API
Can't See the Backoffice Integration UI Tool After Installing integrationbackoffice
Can't See the Integration UI Tool in Backoffice Due to Limited Permission
Stack Traces are not Logged
Exposing an Integration Object as an API
Exposing an Integration Object Using Backoffice
Exposing an Integration Object using the Meta API
Adding the Integration API to a Destination Target
Outbound Sync Implementation
Configuring Outbound Sync
Autogenerate an Outbound Sync Configuration
Outbound Sync Meta API
Creating Outbound Sync Configurations
Retrieving Outbound Sync Configurations
Updating Outbound Sync Configurations
Deleting Outbound Sync Configurations
Outbound Sync Backoffice Configuration
Creating an Outbound Sync Channel
Creating a Container for Outbound Sync Integrations
Creating an Outbound Sync Stream
Creating a Sync Job
Configuring Root Item Grouping Sizes and Timeouts
Scheduling Outbound Sync
Aborting a Running Outbound Sync Cron Job
Troubleshooting a Cron Job
Managing Item Processing Concurrency
Setting the Outbound Sync Retry Record Retention Period
Setting the Outbound Sync Retry Maximum Attempts
Tutorial: Outbound Sync to SCI Integration Flow
Configuring OAuth for Outbound Sync to SCI
Configuring the SAP Cloud Integration Flow
Configuring the Outbound Sync to SCI Endpoint
Configuring SSL for Outbound Sync
Configuring Outbound Sync to send outbound requests to SCI
Testing a Connection from SAP Commerce Cloud to SCI using an OAuth Token
Runtime Attribute Meta API Implementation Examples
Runtime Attribute Implementation Examples
Primitive Type Runtime Attribute
Composed Type Runtime Attribute
Localized Type Runtime Attribute
Outbound Sync with Runtime Attributes
A Missing Required Runtime Attribute (Error)
Unique Runtime Attribute
Filter Runtime Attribute and orderBy Runtime Attribute
Collection Runtime Attribute
Script Service Meta API Implementation Examples
Virtual Attribute Implementation Examples
Webhook Service Meta API Implementation Examples
Modifying Outbound Requests
Configuring RestTemplate Caching for Outbound Services
Configuring CSRF Token Caching for Outbound Services
Monitoring and Clearing the Cache
Tutorial: Using the Outbound Service
Configuring Integration API Cron Jobs
Date, Time, and Time Zone Handling
Intelligent Selling Services Foundation Integration
Intelligent Selling Services Foundation Integration Features
Intelligent Selling Services Foundation Integration Overview
Intelligent Selling Services Foundation Integration Architecture
profileservices Extension
profiletagaddon AddOn
Intelligent Selling Services Foundation Integration Implementation
Consent Management
Installing Intelligent Selling Services Foundation Integration with B2C Accelerator
Installing the Intelligent Selling Services Foundation Integration Using the Installer
Manually Installing the Intelligent Selling Services Foundation Integration
Configuring Intelligent Selling Services Foundation and SAP Commerce Cloud
Setting up a Client
Setting up SAP Commerce Cloud
Merchandising Module
Merchandising Module Features
Merchandising Integration Configuration
Merchandising Module Architecture
merchandisingaddon Extension
merchandisingservices Extension
merchandisingservicesbackoffice Extension
merchandisingsmartedit Extension
merchandisingcmswebservices Extension
merchandisingstorefrontsampledataaddon Extension
Merchandising Module Implementation
Installation of Merchandising with B2C Accelerator
Install Merchandising Using the Installer
Install Merchandising Manually
Install Merchandising without Intelligent Selling Services Foundation
Merchandising Configuration Setup
Create an Integration Client
Configure Merchandising Service Clients
Catalog Synchronization Configuration
Product Directory Configuration
Synchronize Product Directories and Catalog Content
Configure SAP Commerce Cloud to Communicate with Intelligent Selling Services
Configuration of Product Directories
Set up Configuration through Backoffice
Attribute Configuration
Variant Rollup
Configure Variant Rollup
Set up Configuration with ImpEx
Product Catalog Synchronization (Deprecated)
Category Structure Synchronization (Deprecated)
SmartEdit Configuration
Configure SmartEdit to Launch Merchandising Strategy Builder
Verify SmartEdit Settings
Configurator for Complex Products Module
configurator-complex-products Architecture
ysapproductconfigaddon AddOn
sapproductconfigocc Extension
sapproductconfigocctests Extension
sapproductconfigfacades Extension
sapproductconfigservices Extension
sapproductconfigruntimeinterface Extension
sapproductconfigruntimemock Extension
sapproductconfigb2baddon AddOn
sapproductconfigb2bservices Extension
sapproductconfigrules Extension
sapproductconfigrulesbackoffice Extension
SAP BTP Extensions Integration Module
SAP BTP Extensions Integration Module Features
SAP BTP Extensions Integration
One-Click Integration
Retrieving Client Certificate
Automatic Certificate Renewal
One-Click Client Reset
Resetting the Client
Health Check
Business Process Monitoring Integration
BPM Event Configuration
Extending BPM Processes
CA Certificate Revocation Check
SAP BTP Extensions Integration Module Architecture
kymaintegrationbackoffice Extension
kymaintegrationservices Extension
SAP BTP Extensions Integration Module Implementation
Installing the Module
Configuring the Client Credential Reset
Configuring Certificate Retrieval
Configuring Automatic Certificate Renewal
Automatic Certificate Renewal
Configuring CA Certificate Revocation Check
Configuring Event Exporting
SAP Data Hub Adapter Module
SAP Data Hub Adapter Features
The Data Hub Adapter
Data Hub Adapter Connection Retry
SAP Data Hub Adapter Architecture
datahubbackoffice Extension
datahubclient Extension
dataimportcommons Extension
datahubadapter Extension
SAP Data Hub Adapter Implementation
Tutorial: Defining a Data Hub Adapter OAuth Client
Tutorial: Using and Configuring Connection Retry
HTTPS and SSL
Advanced Data Hub Adapter Topics
Getting Data from SAP Commerce Cloud into Data Hub
Pushing Data into SAP Commerce Cloud
Using Distributed ImpEx
Data Hub Adapter Import Error Limit
Tutorial: Using the Data Hub Adapter