|Important||The state of configuration files for customer accounts is in transition from version 1 to a new version 2 that enables our new self-service performance and delivery rule builder.
All the configuration controls for accounts with the v1 configuration schema are accessed from the Available Settings tab on the Property Overview screen for a particular property:
Click on the cards to open the configuration screens for each feature.
Each configuration allows you to set up the corresponding feature for the entire property, and then create property and domain exceptions if needed.
The following sections describe the configuration screens for each feature. The workflow for exceptions is essentially the same for all features, so that is described once below after the feature configurations.
Configuring Object Caching
|Note||If you have the V2 config framework, this document is superseded by Configuring Object Caching with the Performance & Delivery Rule Builder.|
Under Caching Configuration are controls to set Cache Time, Protocol Settings, and Query String in Cache Lookup ID for the entire property.
Cache settings are described in detail in How the Instart Service Handles Caching.
Cache Time sets a TTL for objects in the property. The available settings are:
- Use headers: objects will be cached according to the guidelines given in the HTTP headers from the origin; this is the default setting
- 1 day
- 1 week
- 30 days
- Don't cache: nothing in this property will be cached
- Custom: selecting this opens two more fields immediately below: the first accepts an integer value and the second is a pulldown with the time units: day, hr, minute, or sec.
You can also affect how the lookup ID is generated for the object in the cache. By default both the protocol of the request URL, and any query string that might be appended to it, are included in the cache lookup ID, which means that a request for the same object by either HTTP or HTTPS and/or with different query strings will be cached as separate objects. Excluding the protocol means that a request for an object by either HTTP or HTTPS will be served with the same identical object in the cache.
You need to take care to ensure this option is used correctly. For example, you should never exclude the protocol from the cache lookup ID for cacheable HTML pages.
Similarly, you can exclude or include the Query String in Cache Lookup ID (or parts of it). You can select Exclude, Include, or Custom.
If you select Custom, an additional input field labeled Include All Query Parameters Except appears:
Enter the name of the query parameter you want to exclude; if there are more than one, click the + button to add an additional input field, and repeat as necessary.
Once you have defined the caching policy for the property, click Save Settings.
SmartVision Transcoding Configuration
What Image Transcoding with SmartVision is and what it does are described in What is Image Transcoding?
To the right of the label Advanced SmartVision Transcoding Settings is a pair of radio buttons that allow you to turn SmartVision ON or OFF by default for the entire property. If you click the ON radio button, you will also see settings for Profile and Advanced Image Formats:
These can be individually disabled for either JPGs or PNGs with the toggle button on the left.
Profile is a slider that allows you to choose how the transcoding feature is applied to images. The choices are
- Lossless: with this setting images will not lose any quality and the file size benefit of Image Transcoding is minimal
- Safe: sets the safe quality profile for SmartVision. Choosing this or either of the next two profiles offers a tradeoff between the size of the transcoded images and the quality of experience. This value to used when a customer wants to have minimal impact to image quality, but results in a smaller byte reduction
- Standard: this is middle ground between safe and aggressive. This results in a small impact to quality with a better chance of byte reduction. This is the default value.
- Aggressive: this results in a maximal byte reduction but will potentially have a visible impact on image quality for some images.
- Manual: this allows you to override SmartVision with a single quality level that will be applied in transcoding all JPG and PNG images.
Advanced Image Formats is a series of radio buttons that let you control whether or not JPG and PNG images will be transcoded to WebP or JPEG XR images when the requesting browser is Google Chrome (for WebP) or Microsoft Internet Explorer 10.0 and above or Microsoft Edge (for JPEG XR). You can choose Enabled for both, WebP-only, JPEG XR-only, or Disabled for neither.
Once you have adjusted the desired parameters, click Save Settings.
To save any changes, click the Save Settings button below and to the right.
Configuring Brotli Compression
What Brotli Compression is and what it does are described in What is Brotli Compression?
To the right of the label Brotli Compress Settings are a pair of radio buttons that allow you to turn Brotli compression ON or OFF by default for the entire property.
To save any changes, click the Save Settings button below and to the right.
Configuring Exceptions for all features
Configuring property or domain and path exceptions for feature configuration appear at the bottom part of each feature's configuration screen. The workflow is exactly the same for each, except that the actions you get to choose when creating or editing depend on which feature you are configuring.
Exceptions at the property level allows you to create some very specific actions that depend on conditions other than in which domain and path, using expressions to test for those conditions; when the expressions match, the action is taken.
The Domain and Path Exceptions section displays a list of any exceptions that have already been defined (if any). By default it displays the domain exception only; to see any path exceptions within a domain, click the right arrow icon to expand it:
Creating a new exception
To create a new exception, click the Add New Exception button. This will open a Create Exception form:
In step 1, you choose an existing domain. You can also choose an existing path pattern from the pulldown, or enter a new one in the Edit Patterns field to the right, then click the Add Path button beneath the field to add it. You can repeat this action for as many paths as you need to have in this exception.
When ready, click the Next: Create Exceptions button. This takes you to step 2, where you can turn HTML Streaming on or off, and change the HTML Change Frequency if you select Custom HTML Streaming. (The choices are the same as described above for overall settings at the property level.) You can also go back to step 1 if needed by clicking Edit Domain/Path (Cancel will cancel the entire exception creation process, not the current step):
When ready, click Next: Review Exception. This takes you to step 3, where you can check that everything is as desired. If so, click Create Exception:
The portal will acknowledge that your configuration update request has been submitted by displaying a temporary message like this near the top of the window:
At the same time, the Running Tasks icon displays a number (this is the number of tasks currently running). If you hover the mouse pointer over the icon, a task message will be displayed.
Editing an existing exception
To edit a domain exception, click on the Edit button to the right.
To edit a path exception within a specific domain, first click on the expand button icon at the left of the domain. This displays all the paths within this domain and any exceptions that currently exist:
You cannot edit existing paths in exceptions, only add new ones.
Choose the path you want to edit and click the Edit button to its right. This will open a form to edit the exception:
In step 1, you can enter a new one in the Edit Patterns field to the right, then click the Add Path button beneath the field to add it. You can repeat this action for as many paths as you need to have in this exception.
When ready, click Next: Create Exceptions. This takes you to step 2, where you can turn HTML Streaming on or off, and change the HTML Change Frequency if you select Custom HTML Streaming. (The choices are the same as described above for overall settings at the property level.) You can also go back to step 1 if needed by clicking Edit Domain/Path (Cancel will cancel the entire exception creation process, not the current step).
When ready, click Next: Review Exception. This takes you to step 3, where you can check that everything is as desired. If so, click Create Exception.
As with adding a new rule, the portal will acknowledge that your configuration update request has been submitted by displaying a temporary message near the top of the window and the Running Tasks icon displays a number (this is the number of tasks currently running). If you hover the mouse pointer over the icon, a task message will be displayed to the effect that the configuration is being updated.
Deleting an existing exception
To delete a path exception, click the red Delete button to the right: