Invalidating the CDN cache by way of Dynamic Media
Dynamic Media assets are cached by the CDN (Content Delivery Network) for fast delivery to your customers. However, when you make updates to those assets, you may want those changes to take effect immediately on your website. Purging or invalidating the CDN cache lets you quickly update assets that are delivered by Dynamic Media. Instead of waiting for the cache to expire using a TTL (Time To Live) value (default is 10 hours), you can send a request from within Dynamic Media user interface to have the cache expire within minutes.
The following steps apply only to Dynamic Media on AEM as a Cloud Service. This feature also requires that you use the out-of-the-box CDN that is bundled with AEM Dynamic Media; any other custom CDN is not supported.
See also Caching overview in Dynamic Media .
To invalidate the CDN cache by way of Dynamic media
Part 1 of 2: Creating a CDN Invalidation template
- In AEM as a Cloud Service, tap Tools > Assets > CDN Invalidation Template.
- On the CDN Invalidation template page, do one of the following options based on your scenario:ScenarioOptionI have already created a CDN invalidation template in the past using Dynamic Media Classic.The Create Template text field is pre-populated with your template data. In such case, you can either edit the template, or continue to the next step.I need to create a template. What do I enter?In the Create Template text field, enter an image URL (including image presets or modifiers) referencing <ID> , instead of a specific image ID as in the following example:https://my.publishserver.com/is/image/company_name/<ID>?$product$If the template contains just <ID> , then Dynamic Media fills in https://<publishserver_name>/is/image/<company_name>/<ID> where <publishserver_name> is the name of your Publish Server that is defined in General Settings in Dynamic Media Classic; the <company_name> is the name of your company root associated with this AEM instance, and <ID> is the selected assets through the asset picker to be invalidated.Any presets/modifiers post <ID> are copied as-is in the URL definition.Only images–that is, /is/image –can be auto formed based on the template.For /is/content/ , adding assets such as videos or PDFs using the asset picker does not auto generate URLs. Instead, you must specify such assets either in the CDN Invalidation template, or you can manually add the URL to such assets in Part 2 of 2: Setting CDN Invalidation options .Examples:In this first example, the invalidation template contains <ID> along with the asset URL having /is/content . For example, http://my.publishserver.com:8080/is/content/dms7snapshot/<ID> . Dynamic Media forms the URL based on this, with <ID> being the assets selected through the asset picker that you want invalidated.In this second example, the invalidation template contains the full URL of the asset used in your web properties with /is/content (not dependent on the asset picker). For example, http://my.publishserver.com:8080/is/content/dms7snapshot/backpack where backpack is the asset ID.Asset formats that are supported in Dynamic Media are eligible for invalidation. Asset file types that are not supported for CDN invalidation include Postscript, Encapsulated Postscript, Adobe Illustrator, Adobe InDesign, Microsoft Powerpoint, Microsoft Excel, Microsoft Word, and Rich Text Format.When you create the template, but sure you pay careful attention to syntax and typos; Dynamic Media does not do any template validation.Note that you must specify URLs for image smart crops either in this CDN Invalidation template, or in the Add URL text field in Part 2: Setting CDN Invalidation options.Important: Each entry in a CDN Invalidation template must be on its own line.The following template example is for illustration purposes only.
- In the upper-right corner of the CDN Invalidation template page, tap Save , then tap OK.Part 2 of 2: Setting CDN Invalidation options
- In AEM as a Cloud Service, tap Tools > Assets > CDN Invalidation.
- On the CDN Invalidation – Add Details page, select the assets for CDN invalidation.If you decide to leave the options Invalidate asset associated image presets in CDN and Invalidate based on template unchecked, then the base URL of the selected assets is formed for invalidation. You should use this option arrangement for images only.OptionDescriptionInvalidate asset associated image presets in CDN(Optional) When you check this option, selected assets and all their associated image preset URLs are auto-formed for cache invalidation.Assets and their associated pre-defined preset URLs are auto formed for invalidation. This option works only for image assets.Invalidation based on template(Optional) Check this option to use only the defined template for URL formation.Add AssetsUse the Asset Picker to select assets you want to invalidate. You can select either published or unpublished assets.Caching at the CDN is URL-based, not asset-based. Therefore, it is necessary for you to be aware of the complete URLs that are on your website. After you determine those URLs, you can add them to the template. Then, you can select and add those assets and invalidate the URLs in one step.Use this option in conjunction with Invalidate asset associated image presets in CDN , or Invalidation based on template , or both.Add URLManually add or paste full URL paths to Dynamic Media assets whose CDN cache you want to invalidate. Use this option if you did not create a CDN Invalidation Template in Part 1 of 2: Creating a CDN Invalidation template , and have only a few assets to invalidate.Important: Each URL that you add must be on its own line.You can invalidate up to 1000 URLs at a give time. If the number of URLs in the Add URL text field is greater than 1000, you are unable to tap Next . In such cases, you must tap X to the right of a selected asset or a manually added URL to delete it from the invalidation list.Note that you must specify URLs for image smart crops either in the CDN Invalidation template, or in this Add URL text field.
- Near the upper-right corner of the page, tap Next.
- On the CDN Invalidation – Confirm page, in the URLs list box, you will see a list of one or more URLs generated from the CDN Invalidation Template you created earlier and the assets you just added.For example, using the CDN Invalidation Template example that was shown in the steps earlier, suppose you added a single asset named spinset . When you tap Tools > Assets > CDN Invalidation it results in the following five generated URLs in the CDN Invalidation - Confirm user interface:If necessary, tap X to the right of a URL to delete it from invalidation process.
- Near the upper-right corner of the page, tap Submit to begin the CDN invalidation process.
Troubleshooting CDN Invalidation errors
In all cases, either the entire batch is processed for invalidation, or the entire batch is failed.
Failed to retrieve URL(s) for selected asset(s).
Occurs if any of the following scenarios are met:
– A Dynamic Media configuration is not found.
– There is a exception while retrieving a service user through which the Dynamic Media configuration is read.
– The publish server or the company root used to form the URLs is missing in the Dynamic Media configuration.
Some URLs are not defined correctly. Please correct and re-submit.
Occurs if the IPS CDN cache invalidation API returns an error that the URL is referring to a different company or if the URL is not valid as per the validation done by the IPS cdnCacheInvalidation API.
Failed to invalidate CDN cache.
Occurs if the CDN cache invalidation request fails for any other reason.
No URL(s) entered to be invalidated.
Occurs if there are no URLs present in the CDN Invalidation – Confirm page, and you tap Submit.