This article describes how to follow the connector's synchronization, where to find its logs, and what to do when an import fails. The SFCC B2C Commerce Connector is installed on the customer's eCommerce platform, and its maintenance is the responsibility of the integrator.
Monitoring the synchronization
Each job reports its status and produces a log file at the end of its execution. To review past executions and download the log file of a given run, use the Job History panel. See Configuration panels of the connector.
Each job that converts Akeneo data into Salesforce-compatible XML also keeps a history of the imported and archived XML files.
Logs
Log level
The log level is set per job step, in the Log Level parameter of the step. See Synchronization: load and transfer data for the parameters of each job step.
- ERROR – default value. Only ERROR messages will be visible
- INFO – INFO, WARN and ERROR messages will be displayed in the log files
- WARN – only WARN and ERROR messages will be displayed in the log files
Enable service communication logs
Go to Business Manager Menu > Administration > Operations > Services > AkeneoGetGeneral
Tick the Communication Log Enabled checkbox if you want API communication to be logged. Repeat the same for AkeneoGetToken.
Enable custom info or debug logs
Go to Business Manager Menu > Administration > Operations > Custom Log Settings
Adjust the log settings by either creating a custom log category with a specific log level, or modifying the root log level to Debug or Info. Additionally, make sure that the Info and/or Debug options are selected in the Log Files section.
When synchronization fails
Why the cartridge may stop
There are several potential reasons why the Akeneo SFCC cartridge may fail to function:
- Network issues: connectivity problems between SFCC and the Akeneo PIM
- Akeneo PIM platform unavailability
- Data issues: blocking errors in the data received from the Akeneo PIM
- Configuration issues: misconfiguration of the Akeneo SFCC cartridge, or incorrect SFCC configuration
When any of these issues occur, the cartridge stops synchronizing data between the Akeneo PIM and SFCC, and errors are logged.
Impact on the storefront
The SFCC storefront remains accessible and continues to work normally. Only the SFCC product data is no longer updated.
Restarting the synchronization
As soon as the problem is solved, the synchronization can be restarted normally, manually or automatically.
If an import file is abruptly stopped, it is automatically deleted the next time an import runs, and synchronization can be restarted normally.
We strongly recommend configuring notifications on all the jobs you use, so that a failure does not go unnoticed.
Akeneo service availability
The Akeneo service is generally available with minimal downtime. However, this solution does not include a fallback mechanism. In the event of an extended outage, please get in touch with Akeneo support for assistance.
How the connector stores its data
To interact with Akeneo's API, a token must first be retrieved. This token can be reused across all defined jobs, so it is stored in a custom object (AkeneoToken) with a single entry. There is no need to clear this custom object.
Product media files are managed within catalogs using WebDAV.
Reporting a problem to Akeneo
Akeneo supports the standard, unaltered (vanilla) version of the connector. Before opening a ticket, reproduce the issue on a vanilla version and export your logs and configuration. See Support access for the full procedure and the list of information to provide.