Fine-grained cache invalidation

The custom template format consists of two parts,Names:{Variables} where:

• Names: usually be dictated by the cache spec
• Variables: the following product and category variables from the processor:
  • Product variables

    Variable name	Description
    supportedStoreId	Get the list of store Id of a specific catentry from Elasticsearch product index.
    partNumber	Get the normalized partNumberof the specific updated item.
    parentCategoryId	Get the list of parent category that the specific product belongs to.
    skuCatentryId	Get the list of catentries showing products sku.
    productPartNumber	Get the normalized partNumber of the specific updated item based on its type: product = product partNumber sku = find its parent product and return that partNumber .
    catentryId	Get the catentry of the specific updated item.
    productId	Get the catentry of the specific updated item based on its type: product = acts the same as catentryId sku = find its parent product and return that catentryId

  • Category variables

    Variable name	Description
    supportedStoreId	Get the list of store Id of a specific catgroup from Elasticsearch category index.
    categoryId	Get the catgroup id of a specific category.
    childCategoryId	Get the list of child categories of the specified category.

Here is an example of the custom template. The first part of it is the Name and can be customized with any text. The second part is the Variables which has to follow a certain name.

storeId:partNumber:{supportedStoreId}:{partNumber}

The aforementioned custom template generates the following invalidation:

storeId:partNumber:1:test_10001

In the case of multiple storeIDs the invalidation is triggered in the following manner:

storeId:partNumber:1:test_10001
storeId:partNumber:10501:test_10001

Here is an example of the multi invalidation custom template:

storeId:partNumber:{supportedStoreId}:{partNumber};categoryId:{parentCategoryId}

The aforementioned multi invalidation custom template generates the following invalidation:

storeId:partNumber:1:test_10001
categoryId:10001

Once you create custom templates for product and category invalidation, use the following JSON to customize the fine-grained cache invalidation. For detailed instructions on customizing processors, connectors, refer to Extending Ingest connectors.

{
    "name": "push-to-live",
    "pipes": [
        {
            "name": "WorkspacePublishing",
            "properties": [
                {
                    "name": "properties.Product Invalidation Template",
                    "value": "storeId:partNumber:{supportedStoreId}:{partNumber}",
                    "scope": {
                        "name": "Workspace Publishing Invalidations.WorkspacePublishInvalidation",
                        "type": "PROCESSOR"
                    }
                },
                {
                    "name": "properties.Category Invalidation Template",
                    "value": "storeId:category:{supportedStoreId}:{categoryId}",
                    "scope": {
                        "name": "Workspace Publishing Invalidations.WorkspacePublishInvalidation",
                        "type": "PROCESSOR"
                    }
                },
                {
                    "name": "properties.Cache Name",
                    "value": "someCache",
                    "scope": {
                        "name": "Workspace Publishing Invalidations.WorkspacePublishInvalidation",
                        "type": "PROCESSOR"
                    }
                }
            ]
        }
    ]
}