Help: HTTP Proxy Template

For more help, visit the WebGUI Community Wiki.

The following variables are available in templates for HTTP Proxies:

header
The header from the proxied URL.
content
The content from the proxied URL. If the Search for or Stop at properties are used, then the content will not contain either of those.
search.for
The string used to start the content search.
stop.at
The string used to stop the content search.
content.leading
Any text before the Search For string.
content.trailing
Any text after the Stop At string.
templateId
The ID of the template used to display the output of the Http Proxy.
proxiedUrl
The URL to proxy.
useAmpersand
A conditional which is true if the Http Proxy has been set to join parameters in the URL.
timeout
The amount of time in seconds that WebGUI will wait for a connection before giving up on an external page.
removeStyle
A conditional that will be true if the Http Proxy was configured to remove the stylesheet from the proxied page and replace it with the stylesheet from your site.
cacheTimeout
The amount of time in seconds output from the Http Proxy will be cached.
filterHtml
The level of HTML filtering that has been set for proxied content.
followExternal
A conditional that is true if the Http Proxy is set up to allow it follow external links.
rewriteUrls
A conditional that is true if the Http Proxy is set up to rewrite external links.
followRedirect
A conditional that is true if the Http Proxy is set up to follow redirects.
searchFor
A search string that will define the starting point for displayed content.
stopAt
A search string that will define the stopping point for displayed content.
cookieJarStorageId
The ID of the storage object where cookies will be stored.
displayTitle
A conditional variable for whether or not the title should be displayed.
description
The description of this wobject.
styleTemplateId
The assetId of the template for displaying the Asset.
printableStyleTemplateId
The assetId of the template for displaying the Asset for printing.
assetId
The unique identifier for this Asset, in base64 encoding.
assetIdHex
The unique identifier for this Asset, in hexadecimal format.
title
The title of the Asset
menuTitle
The title of the Asset used in Navigations.
url
The Asset's URL.
isHidden
A boolean that will be true if this Asset is set not be displayed in Navigations.
newWindow
A boolean that will be true if this Asset is set open in a new browser window.
encryptPage
A boolean that will be true if this Asset is set to be served over SSL.
ownerUserId
The ID of the user who owns this Asset.
groupIdView
The ID of the group that is allowed to view this Asset.
groupIdEdit
The ID of the group that is allowed to edit this Asset.
synopsis
A short description of the contents of the Asset.
extraHeadTags
Extra tags that will be added to the header of the page containing the Asset. These will be included by default so you do not need to add them youself, unless you want them to be in there twice.
isPackage
A boolean that will be true if this Asset is set to be a Package.
isPrototype
A boolean that will be true if this Asset is set to be a prototype.
status
With respect to version control, the status of this Asset. Typically these are the English strings "approved", "pending", "committed".
assetSize
How big this asset is in bytes. The sum of all database fields and attachments.
keywords
This will be a string with the keywords for this asset. Individual keywords will be joined with spaces, unless the keyword contains spaces, in which case it will be quoted.
webgui.version
The version of WebGUI on your site.
webgui.status
The release status for this version of WebGUI (stable, beta, gamma, etc.)
session.user.username
The current user's username.
session.user.firstDayOfWeek
From the current user's profile, the day they selected to be the first day of the week.
session.config.extrasurl
From the WebGUI config, the URL for the extras directory.
session.var.adminOn
This variable will be true if the user is in Admin mode.
session.setting.companyName
From the WebGUI settings, the company name.
session.setting.anonymousRegistration
From the WebGUI settings, whether or not anonymous registration has been enabled.
session form variables
Session Form Variables
Any form variables will be available in the template with this syntax:
<tmpl_var session.form.variable>
If there is more than 1 value in a form variable, only the last will be returned.
session scratch variables
Session Scratch Variables
Any scratch variables will be available in the template with this syntax:
<tmpl_var session.scratch.variable>
controls
These are the icons and URLs that allow editing, cutting, copying, deleting and reordering the Asset.
 
 
Admin Console
Help: HTTP Proxy Template
*
Admin Console