Configuring HTML Streaming in the Portal

Note

If you have the V2 config framework, this document is superseded by Configuring HTML Streaming with the Performance & Delivery Rule Builder.

There are two sections to this page: HTML Streaming Configuration, which is for setting change frequency (caching TTL) for HTML Streaming fragments for the entire property, and Exceptions, which is for overriding the HTML Streaming settings in specific domains and/or in specific paths in domains.

HTML Streaming configuration screen

What HTML Streaming does and how it works is described in this document.


HTML Streaming Configuration

To the right of the Advanced HTML Streaming Settings heading is a switch that you can use to disable HTML Streaming for the entire property.

Below that are settings for the HTML Change Frequency (which corresponds to the TTL for HTML Streaming fragments). Its possible values are Low, Medium, and High. These correspond to the TTL for the streaming stub; Low = 432000s, Medium = 86400s, High = 3600s.

There are two ways to set the HTML Change Frequency:

  • If Auto HTML Streaming is selected, the change frequency is set to Medium:
  • If Custom HTML Streaming is selected, the change frequency can be set to Low or High as well as Medium using the slider control:

To save any changes, click the Save Settings button below and to the right.


Exceptions

Under Exceptions are displayed Property Exceptions, followed by Domain and Path Exceptions (if any).

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 current release of the Portal does not support editing of domains and paths that include such rules. Please contact Support if you want to have further control over caching settings than currently allowed by the Portal.

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:

Create a new HTML Streaming exception step 1

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 canturn 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).

Create a new HTML Streaming exception step 2

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:

Create a new HTML Streaming exception step 3

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:

Message from system when a HTML Streaming config change has been submitted

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:

Task list displayed when you click on the Tasks icon, showing a HTML Streaming configuration change is pending completion


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:

Editing a HTML Streaming exception in a existing IP blocking rule step 2

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).

Editing a HTML Streaming exception in a existing IP blocking rule step 2

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.


Editing a HTML Streaming exception in a existing IP blocking rule step 3

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:

Deleting an existing HTML Streaming configuration exception