Documentation | Support

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Creating Custom Block Pages : Block page content variables
Block page content variables
Custom Block Pages | Web Protection Solutions | v8.5.x | 29-Apr-2022
Content variables control the information displayed on HTML block pages. The following variables are included with the default block message code.
Variable Name
Content Displayed
WS_DATE
Current date
WS_USERNAME
Current user name (excluding domain name)
WS_USERDOMAIN
Domain name for the current user
WS_IPADDR
IP address of the requesting source machine
WS_WORKSTATION
Machine name of the blocked computer (if no name is available, IP address is displayed)
WS_CASB_IS_BLOCK
If the page was blocked as a cloud application, "true". If the page was not blocked as a cloud application, "false".
WS_CASB_RISKLEVEL
Low, medium, or high risk level.
WS_CASB_APP
Name of the cloud application.
WS_CASB_APPTYPE
Category of the cloud application.
To use a variable, insert the variable name between the $* *$ symbols in the appropriate HTML tag:
<p id="UserName">$*WS_USERNAME*$</p>
Here, WS_USERNAME is the variable.
The block message code includes additional variables, described below. You may find some of these variables useful in constructing your own, custom block messages. When you see these variables in default block message files, however, please do not modify them. Because Filtering Service uses these variables when processing blocked requests, they must remain in place.
 
Variable Name
Purpose
WS_URL
Displays the requested URL
WS_BLOCKREASON
Displays why the site was blocked (i.e., which action was applied)
WS_ISSECURITY
Indicates whether the requested site belongs to any of the categories in the Security Risk class. When TRUE, the security block page is displayed.
WS_PWOVERRIDECGIDATA
Populates an input field in the block page HTML code with information about use of the Password Override button
WS_QUOTACGIDATA
Populates an input field in the block page HTML code with information about use of the Use Quota Time button
WS_PASSWORDOVERRIDE-BEGIN, WS_PASSWORDOVERRIDE-END
Involved in activating password override functionality
WS_MOREINFO
Displays detailed information (shown after the More information link is clicked) about why the requested site was blocked
WS_POLICYINFO
Populates the hidden "more information" section in block page source code
WS_MOREINFOCGIDATA
Sends data to Filtering Service about use of the More information link
WS_QUOTATIME
Displays the amount of quota time remaining for the requesting client
WS_QUOTAINTERVALTIME
Displays quota session length configured for the requesting client
WS_QUOTABUTTONSTATE
Indicates whether the Use Quota Time button is enabled or disabled for a particular request
WS_SESSIONID
Acts as an internal identifier associated with a request
WS_TOPFRAMESIZE
Indicates the size (as a percentage) of the top portion of a block page sent by a custom block server, if one is configured
WS_BLOCKMESSAGE_PAGE
Indicates the source to be used for a block page's top frame
WS_CATEGORY
Displays the category of the blocked URL
WS_CATEGORYID
The unique identifier for the requested URL category

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Creating Custom Block Pages : Block page content variables
Copyright 2022 Forcepoint. All rights reserved.