Set CDN Cache Duration in SuiteScript for Enhanced Suitelet

TL;DR Opening

Setting the CDN cache duration in SuiteScript allows developers to control how long content is cached. This enhances performance, especially for Suitelets, by reducing the need for repetitive processing and improving load times.

What is CDN Caching?

CDN (Content Delivery Network) caching is a technique that allows frequently accessed content to be stored temporarily to minimize server load and improve response times for users. By setting an appropriate caching duration, developers can ensure that cached responses are delivered quickly without unnecessary delays.

Method Description

The setCdnCacheable method is used to specify CDN caching for a designated time period. It can be invoked within server scripts, enhancing Suitelet performance by reducing the load on server resources when the same content is repeatedly requested.

Returns

• Returns void

Supported Script Types

• This method is applicable for server scripts.

Governance

• There are no governance limits associated with this method.

Module

• N/http Module

Parent Object

• This method belongs to the http.ServerResponse object.

Parameters

The method accepts an options parameter, which is a JavaScript object that determines the caching behavior. The following table outlines the parameters:

Error Handling

When using this method, developers should be aware of potential error codes:

• Error Code: SSS_MISSING_REQD_ARGUMENT
  • Message: Missing a required argument: {param name}
  • Thrown If: The options.type parameter is not specified.

Syntax Example

This code snippet demonstrates how to use the setCdnCacheable method within your script:

// Example SuiteScript code
serverResponse.setCdnCacheable({
    type: http.CacheDuration.MAX
});

This example sets the caching duration to the maximum allowed, optimizing the Suitelet responses.

Related Topics

• http.ServerResponse
• N/http Module
• SuiteScript 2.x Modules

Key Takeaways

• The setCdnCacheable method enables dynamic CDN caching management.
• Use it to enhance Suitelet performance by avoiding redundant processing.
• Developers must specify the options.type to avoid errors related to missing parameters.