Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 5.66 KB

SYNC_OPTIONS.md

File metadata and controls

84 lines (60 loc) · 5.66 KB
Raw

Sync Options

errorCallback

a callback that is called whenever an error event occurs during the sync process. It contains the following information about the error-event:

  • sync exception
  • the resource draft of the source project
  • the resource of the target project
  • the update-actions, which failed

warningCallback

a callback that is called whenever a warning event occurs during the sync process. It contains the following information about the warning message:

  • sync exception
  • the resource draft of the source project
  • the resource of the target project

beforeUpdateCallback

during the sync process, if a target resource and a resource draft are matched, this callback can be used to intercept the update request just before it is sent to CTP. It contains information about the resource draft, the target resource, and the update actions that were calculated after comparing both.

beforeCreateCallback

during the sync process, if a resource draft should be created, this callback can be used to intercept the create request just before it sent to CTP. It contains information about the resource draft that should be created.

batchSize

a number that could be used to set the batch size with which resources are fetched and processed, as resources are obtained from the target CTP project in batches for better performance. The algorithm accumulates up to batchSize resources from the input list, then fetch the corresponding resources from the target CTP project in a single request. Playing with this option can slightly improve or reduce processing speed.

cacheSize

In the service classes of the commercetools-sync-java library, we have implemented an in-memory LRU cache to store a map used for the reference resolution of the library. The cache reduces the reference resolution based calls to the commercetools API as the required fields of a resource will be fetched only one time. These cached fields then might be used by another resource referencing the already resolved resource instead of fetching from commercetools API. It turns out, having the in-memory LRU cache will improve the overall performance of the sync library and commercetools API. which will improve the overall performance of the sync and commercetools API.

Playing with this option can change the memory usage of the library. If it is not set, the default cache size is 10.000 for the sync.

syncFilter (Only for Product Sync Options)

represents either a blacklist or a whitelist for filtering certain update action groups.

  • Blacklisting an update action group means that everything in products will be synced except for any group in the blacklist. A typical use case is to blacklist prices when syncing products. In other words, syncing everything in products except for prices.

  • Whitelisting an update action group means that the groups in this whitelist will be the only group synced in products. One use case could be to whitelist prices when syncing products. In other words, syncing prices only in products and nothing else.

  • The list of action groups allowed to be blacklisted or whitelisted on products can be found here.

ensureChannels (Only for Product and Inventory Sync Options)

a flag that represents a strategy to handle syncing inventory entries with missing channels. Having an inventory entry or a product, with a missing channel reference, could be processed in either of the following ways:

  • If ensureChannels is set to false this inventory entry/product won't be synced and the errorCallback will be triggered.
  • If ensureChannels is set to true the sync will attempt to create the missing channel with the given key. If it fails to create the supply channel, the inventory entry/product won't sync and errorCallback will be triggered.
  • If not provided, it is set to false by default.

Examples

1. Using errorCallback and warningCallback for logging

 final Logger logger = LoggerFactory.getLogger(MySync.class);
 final ProductSyncOptions productsyncOptions = ProductSyncOptionsBuilder
         .of(sphereClient)
         .errorCallback((syncException, draft, product, updateActions) -> 
            logger.error(syncException.getMessage(), syncException))
         .warningCallback((exception, oldResource, newResources) -> 
            logger.warn(exception.getMessage(), exception))
         .build();

2. Using beforeUpdateCallback for syncing a single locale.

3. Using beforeUpdateCallback for keeping other variants.

4. Using syncFilter for blacklisting product categories while syncing products.

5. Using syncFilter for whitelisting product names while syncing products.