API
TrainingSupportCommunity

Script Management concepts

Familiarize yourself with some of the common terms used in this API.

  • Service worker. Script Management installs a JavaScript service worker called akam-sw.js. It's used to apply a policy that you'll create to manage scripts.

  • Policy. This is a list of scripts you set up to defer or block their usage on your site or app.

  • Insights. With Script Management enabled, you can review script usage data on your site or app. This data is also referred to as insights.

  • Hostname. When you create your Ion property and enable Script Management, you'll also include one or more hostnames. Each hostname represents a domain that clients use to access your site or app. An individual hostname can have its own policy set up to defer or block problematic scripts.

  • Single Point of Failure (SPOF). SPOF helps protect against outages caused by third-party JavaScripts. A call for a script is moved to the background if that script is slowing down page load times for your site. SPOF dynamically sets a timeout value based on current network conditions. If a script takes longer to load than this timeout period, it moves the script to the background. The timeout value is adjusted automatically if network conditions change. You can also manually set a range for this timeout.

  • First-party script. A script that's hosted on the same domain as your site or app.

  • Third-party script. A script that's hosted on a different domain from your site or app.

  • Block. An action you can apply to a script in a policy. A blocked script is not simply skipped. Blocking happens as soon as the service worker encounters the request for the script. You should check for dependencies — blocking one script that another script calls causes that script to fail. Scripts can only be blocked when serviceworker is set to YES_SERVER_WORKER.

  • Defer. An action you can apply to a script in a policy. This delays loading and executing the script until after the page itself has loaded. Deferring scripts doesn't change their order relative to each other. Scripts can only be deferred when serviceworker is set to YES_SERVER_WORKER.

  • Group. This is a set of third-party scripts with common functionality. Typically, the scripts in a group are part of the same application.