DocumentationAEM as a Cloud ServiceUser Guide

Component & GraphQL Clear Cache clear-cache

Last update: Tue Aug 12 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Applies to:
  • Experience Manager as a Cloud Service

CREATED FOR:

  • Admin

This document provides a comprehensive guide on enabling and verifying the clear-cache feature in AEM CIF.

NOTE
This feature is experimental.

Enabling Clear Cache Feature in CIF Configuration enable-clear-cache

By default, the clear-cache feature is disabled in CIF configuration. To enable it, you need to add the following to your corresponding projects:

  • Enable the servlet /bin/cif/invalidate-cache which helps you triggering the clear-cache API with their corresponding requests by adding the com.adobe.cq.cif.cacheinvalidation.internal.InvalidateCacheNotificationImpl.cfg.json configuration in your project as shown here.

    note note
    NOTE
    Configuration needs to be enabled only for the author instances.

  • Enable the listener to clear cache from each instance of AEM (publish and author) by adding the com.adobe.cq.commerce.core.cacheinvalidation.internal.InvalidateCacheSupport.cfg.json configuration in your project as shown here.

    • Configuration should be enabled for both author and publish instances.

    • Enable the Dispatcher cache (Optional): you can enable the dispatcher clear cache setting by setting the enableDispatcherCacheInvalidation property to true in the above configuration. This provides functionality to clear the cache from the dispatcher.

      note note
      NOTE
      This only works with publish instances.

    • Also, make sure to give the corresponding pattern which suits your product, category and CMS page needs to be added to the above configuration file to remove it from the dispatcher cache.

  • To improve the SQL queries performance for finding the corresponding page related with product and category, add the corresponding index in your project (recommended). Fore more information, see cifCacheInvalidationSupport.

Verifying Clear Cache Feature verify-clear-cache

To verify that everything is set up properly:

  • Trigger the corresponding servlet to the Author Instance AEM, for example http://localhost:4502/bin/cif/invalidate-cache and you should get a 200 HTTP response.
  • Verify that a node has been created under the following path in author instances: /var/cif/cacheinvalidation. The node name follows this pattern: cmd_{{timestamp}}.
  • Verify that the same node has been created in each publish instance.

Now, to check whether the caches are getting cleared properly:

  1. Navigate to the corresponding PLP and PDP pages.

  2. Update a product or category name in the commerce engine. The changes are not reflected in AEM immediately based on cache configurations.

  3. Trigger the servlet API as shown here:

    code language-none 
    curl --location '{Author AEM Instance Url}/bin/cif/invalidate-cache' \
--header 'Content-Type: application/json' \
--header 'Authorization: ******' \ // Mandatory
--header 'Cookie: private_content_version=0299c5e4368a1577a6f454a61370317b' \
--data '{
    "productSkus": ["Sku1", "Sku2"], // Optional: Pass the corresponding sku which got updated.
    "categoryUids":["CategoryUid"], // Optional : Pass the corresponding category-uid which got updated.
    "storePath": "/content/venia/us/en", // Mandatory : Needs to be given to know for which site we are removing the clear cache.
}'

If everything goes well, the new changes are reflected in every instance. If the changes are not visible on the publish instance, please try accessing the relevant PLP and PDP pages in a private/incognito browser window.

NOTE
Publish instances can have multiple level of cache layers. The feature is only responsible for clear cache from AEM internal memory and dispatcher.

Clear Cache Invalidation API clear-cache-api

This is the API which you need to trigger whenever you wanted to clear cache of commerce related data from AEM.

Request Type: POST

Headers headers

Parameter
Value
Required/Mandatory
Comment
Content-Type
application/json
Required
Authorization
Corresponding Author’s User credentials (Auth Type: Basic Auth)
Required
Add the corresponding username and password.

Payload payload

The following table shows existing attributes which the feature is giving out-of-the-box. These InvalidateType properties need to be given in combination with mandatory attribute (such as storePath).

invalidateType
Value
Type (Array/String/Boolean)
Will this clear the dispatcher cache?
Comment
productSkus
Product’s sku - which needs to be invalidated from the cache.
Array
Yes

Clear the cache from internal memory using the following pattern:
"\"sku\":\\s*\""
Dispatcher

  • Clear the PDP page cache of the corresponding SKUs
  • Clear cache of the corresponding categories page in which they exists(Based on the graphql response from commerce)
  • Clear cache based on the following query:

SELECT content.[jcr:path] FROM [nt:unstructured] AS content<br>WHERE ISDESCENDANTNODE(content, '{storePath}')<br>AND ( (content.[product] IN ('sku1','sku2') AND content.[productType] = 'combinedSku')<br> OR (content.[selection] IN ('sku1','sku2') AND content.[selectionType] IN ('combinedSku', 'sku')))

categoryUids
Category’s uid - which needs to be invalidated from the cache.
Array
Yes

Clear the cache from internal memory using the following pattern:
"\"uid\"\\s*:\\s*\\{\"id\"\\s*:\\s*\""
Dispatcher

  • Clear the category pages cache for corresponding data(including its children category page)
  • Clear all the PDP pages which have the corresponding categories
  • Clear cache based on the following query:

SELECT content.[jcr:path] FROM [nt:unstructured] AS content<br>WHERE ISDESCENDANTNODE(content,'{storePath}')<br>AND ((content.[categoryId] in ('category1','category2')<br>AND content.[categoryIdType] in ('uid'))<br>OR (content.[category] in ('category1','category2') AND content.[categoryType] in ('uid')))

regexPatterns
If you need to clear the GraphQL response data based on regex pattern, use this.
Array
No
cacheNames
This values are defined under the corresponding CIF GraphQL client configuration factory >> Corresponding StorePath GraphQL configuration >> GraphQL cache configurations
Array
No
invalidateAll
True or false
Boolean
Yes

This table shows the mandatory property that needs to be passed in every API call:

Property
Value
Type (Array/String/Boolean)
Will this clear the dispatcher cache?
Comment
storePath
Corresponding value of the site path from where the cache needs be removed (Example : /content/venia/us/en as reference with venia project).
String
Yes
This needs to be given with the combination of invalidateType.

Sample API Request sample-request

curl --location 'https://author-p10603-e145552-cmstg.adobeaemcloud.com/bin/cif/invalidate-cache' \
--header 'Content-Type: application/json' \
--header 'Authorization: ******' \
--header 'Cookie: private_content_version=0299c5e4368a1577a6f454a61370317b' \
--data '{
"productSkus": ["VP01", "VT10"], // This will clear cache for the corresponding pages related with mentioned skus.
"categoryUids":["Mjk="], // This will clear cache for the corresponding pages related with mentioned categories.
"regexPatterns":["\"uid\"\\s*:\\s*\\{\"id\"\\s*:\\s*\"(Mjk=)\"", "\"sku\":\\s*\"(VP02|VP03)\""],
"cacheNames": ["venia/components/commerce/product"], // If this been added then it will clear respective caches for the corresponding storepath
"storePath": "/content/venia/us/en"
}'

Extensibility clear-cache-extensibility

This feature not only delivers its core functionality but also offers extensibility, allowing developers to build upon and customize it further as needed.

Extending the Existing Attribute existing-attribute

In cases where the cache needs to be cleared that are not currently covered by the existing attribute-based functionality (such as categoryUids), you can refer to this reference file to add new patterns and define additional invalidatePaths that should be cleared from the cache beyond what the current implementation handles.

Adding New Custom Attribute new-custom-attribute

If, for example, you don’t want to use the existing attribute for clearing the cache, then you have the flexibility to create your own attribute and define its corresponding functionality.

  • If you only need to clear cache from the internal memory of AEM (the graphql response), then you need to follow this reference.

  • If you need to clear cache from the internal memory and the dispatcher cache, then you need to follow this reference.

    note note
    NOTE
    You can ignore the internal clear cache by returning null for the getPatterns() method.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab