Review user-defined variables for Virtual Waiting Room (Standalone)

The Virtual Waiting Room Standalone uses the following list of user-defined variables.
These variables can be defined and set using an EdgeWorkers script. A link to the procedure on how to add user-defined variables is provided at the end of this page.

  • PMUSER_WR_ORIGIN_LIMIT

    The expected maximum number of new visitors allowed to access the Origin per second. If the number of visitors per second exceeds the value you set, new visitors are sent to the waiting room.

📘

Due to latency, some initial visitors may enter the waiting room (for up to 5 seconds), even when the PMUSER_WR_ORIGIN_LIMIT value has not been exceeded.

Variable name

Required value format

Value (visitors per second) and example

PMUSER_WR_ORIGIN_LIMIT

Integer

10 (minimum)
10, 000, 000 (maximum)
1000 (example)

  • PMUSER_WR_COOKIE_DOMAIN_CONFIG

    The cookie domain configuration mode. When set as HOST_HEADER, the cookie domain attribute is automatically set to the incoming request host header for basic domain auto-detection. When this variable is set as CUSTOM, the cookie domain uses the value of the PMUSER_WR_COOKIE_DOMAIN variable.

Variable name

Value (select one)

PMUSER_WR_COOKIE_DOMAIN_CONFIG

HOST_HEADER
CUSTOM

  • PMUSER_WR_COOKIE_DOMAIN

    When PMUSER_WR_COOKIE_DOMAIN_CONFIG is set to CUSTOM this variable contains a custom domain attribute for all session cookies. Make sure this domain is correctly accepted by the user agent for any request matching with this behavior. When multiple property hostnames are configured, the cookie domain is the common domain. Do not use only the Top-level Domains (TLDs) for the cookie domain.

Variable name

Cookie domain example

PMUSER_WR_COOKIE_DOMAIN

mydomain.com

📘

If PMUSER_WR_COOKIE_DOMAIN_CONFIG is set to HOST_HEADER the PMUSER_WR_COOKIE_DOMAIN variable is ignored.

  • PMUSER_WR_ID

    The waiting room unique identifier. One waiting room unique identifier is required for each waiting room queue. A waiting room unique identifier can be used for one property, or for multiple properties. When the same waiting room unique identifier is used for multiple properties, all visitors from the multiple properties are placed in the same Virtual Waiting Room queue. You can customize the virtual waiting room page and assets for each property to give your visitors a unique customer experience.

Variable name

Required value format

Value and example

PMUSER_WR_ID

Integer

1 through 100
99 (example)

  • PMUSER_WR_PATH

    The path to the waiting room main page on the Origin. For blocked requests when the Origin reaches its limit, the outgoing request path and cache key is rewritten to this path value as waiting room main page requests. The waiting room path is not visible to visitors.

Variable name

Waiting room path example

PMUSER_WR_PATH

/fifo/waiting-room.html

📘

You can use match criteria to further customize the behaviors for Any Waiting Room Request, Waiting Room Main Page and Waiting Room Assets. For example, you can set the match criteria for the Waiting Room Main Page so that the page is served from: Your Origin, or NetStorage.

  • PMUSER_WR_ASSETS_PATHS

    The space-separated list of base paths for waiting room assets such as; javascript, css files and images that are referenced in the waiting room HTML. Each path may contain an asterisk (*) for wildcards. Requests matching with any of these paths are not blocked, but marked as Waiting Room Assets requests and passed through to the Origin.

Variable name

Waiting room assets path examples

PMUSER_WR_ASSETS_PATHS

/static/* /wr*

📘

You can use match criteria to further customize the behaviors for Any Waiting Room Request, Waiting Room Main Page and Waiting Room Assets. Waiting Room requests are customizable to include or not include the waiting room main page or assets. For example, you can set the match criteria for Waiting Room Assets so that the waiting room page assets like images are served from one of the following; Your Origin, or NetStorage.

  • PMUSER_WR_SESSION_DURATION

    Defines how long access should be granted (in seconds) for inactive visitors at the origin.
    - If the duration expires and there are visitors in your waiting room, the visitor is sent to the end of the waiting room line.
    - If the duration expires and there are no visitors in your waiting room, the duration is reset and the visitor is allowed to stay on the origin.

Variable name

Required value format

Value (seconds)

PMUSER_WR_SESSION_AUTO_DURATION

Integer

0 through 86400
600 (example)

  • PMUSER_WR_SESSION_AUTO_PROLONG

    Automatically prolong session access when the visitor is still active.

Variable name

Value (select one)

PMUSER_WR_SESSION_AUTO_PROLONG

true
false


Did this page help you?