WebGUI - Admin Console

For more help, visit the WebGUI Community Wiki.

searchFormHeader

The header tag for the search form.

searchFormSubmit

The submit form element for the search form

searchFormFooter

The footer tag for the search form

searchFormTypeOr

A hidden form element to set the search type to 'or'.

searchFormTypeAnd

A hidden form element to set the search type to 'and'.

searchFormTypeSelect

A select box to let the user select the search type.

searchFormQuery_form

A text input for the search query.

search_PROFILEFIELDNAME_text

A text input to do a normal search in profile field PROFILEFIELDNAME. Example: <tmpl_var search_lastName_text>.

search_PROFILEFIELDNAME_form

The form element tied to this field to do a normal search in profile field PROFILEFIELDNAME. Example: <tmpl_var search_timeZone_form> will be a select box.

searchExact_PROFILEFIELDNAME_text

A text input to do an exact search in profile field PROFILEFIELDNAME. Example: <tmpl_var searchExact_email_text>.

searchExact_PROFILEFIELDNAME_form

The form element tied to this field to do an exact search in profile field PROFILEFIELDNAME. Example: <tmpl_var searchExact_email_form>.

limitSearch

A hidden form element to indicate that the search is limited to certain profile fields. Use includeInSearch_PROFILEFIELDNAME_hidden or includeInSearch_PROFILEFIELDNAME_checkBox tmpl_vars to select which fields the search is limited to.

includeInSearch_PROFILEFIELDNAME_hidden

A hidden form element to indicate that profile field PROFILEFIELDNAME will be searched. This will only have an effect if the limitSearch tmpl_var is part of the search form.

includeInSearch_PROFILEFIELDNAME_checkBox

A checkBox that the user can use to choose whether profile field PROFILEFIELDNAME will be searched or not. This will only have an effect if the limitSearch tmpl_var is part of the search form.

numberOfProfileFields

The number of profile fields.

profileField_PROFILEFIELDNAME_label

The label for the profile field with fieldName PROFILEFIELDNAME. Example <tmpl_var profileField_lastName_label>. This tmpl_var exists outside of the profileField_loop.

profileField_PROFILEFIELDNAME_sortByURL

The URL to sort the UserList by PROFILEFIELDNAME. Example <tmpl_var profileField_lastName_sortByURL>. This tmpl_var exists outside of the profileField_loop. The default sort order is ascending. After clicking the sort by link for a profile field the sort order will be reversed.

profileField_loop

A loop containing profile fields

profileField_label: The label for this profile field
profileField_sortByURL: The URL to sort the UserList by this profile field. The default sort order is ascending. After clicking the sort by link for a profile field the sort order will be reversed.

alphabetSearch_loop

A loop that contains elements to create an alphabetical search.

alphabetSearch_loop_label: The label for this alphabet search query. Usually one letter of the alphabet.
alphabetSearch_loop_hasResults: A conditional that is true if there are any results for this alphabet query.
alphabetSearch_loop_searchURL: The url to do an alphabet search on this query.

user_loop

A loop containing the users that are listed by the UserList.

user_name

The username of the user.

user_id

The userId of the user

user_profile_PROFILEFIELDNAME_value

The value of the profile field with the name PROFILEFIELDNAME in the users user profile. Example <tmpl_var user_profile_firstName_value>

user_profile_PROFILEFIELDNAME_notPublic

A conditional which is true if the profile field with the name PROFILEFIELDNAME is not public, example <tmpl_var user_profile_firstName_notPublic>

user_profile_PROFILEFIELDNAME_file

The file for the profile field with the name PROFILEFIELDNAME in the users user profile. Example <tmpl_var user_profile_firstName_file>. This is available if the profile field is a file or an image.

user_profile_loop

A loop containing the users profile fields.

profile_notPublic: A conditional that is true for each field that is not public.
profile_value: The value of the profile field for this user.
profile_file: The file for this profile field, available if the profile field is an image or file.

alphabet

The alphabet that is used for the alphabet search. This is a string of comma seperated values.

showGroupId

Only users that are in this group will be shown.

hideGroupId

Users in this group will be hidden.

usersPerPage

The number of users per page

templateId

The ID of the template used to display the UserList Asset.

showOnlyVisibleAsNamed

Boolean. If true then only fields that are set to 'visible' in the user profile settings will be available as named tmpl_vars

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.

pagination.firstPage

A link to the first page in the paginator.

pagination.firstPageUrl

The url component of pagination.firstPage broken out.

pagination.firstPageText

The text component of pagination.firstPage broken out.

pagination.isFirstPage

A boolean indicating whether the current page is the first page.

pagination.lastPage

A link to the last page in the paginator.

pagination.lastPageUrl

The url component of pagination.lastPage broken out.

pagination.lastPageText

The text component of pagination.lastPage broken out.

pagination.isLastPage

A boolean indicating whether the current page is the last page.

pagination.nextPage

A link to the next page in the paginator relative to the current page.

pagination.nextPageUrl

The url component of pagination.nextPage broken out.

pagination.nextPageText

The text component of pagination.nextPage broken out.

pagination.previousPage

A link to the previous page in the paginator relative to the current page.

pagination.previousPageUrl

The url component of pagination.previousPage broken out.

pagination.previousPageText

The text component of pagination.previousPage broken out.

pagination.pageNumber

The current page number.

pagination.pageCount

The total number of pages.

pagination.pageCount.isMultiple

A boolean indicating whether there is more than one page.

pagination.pageList

A list of links to every page in the paginator.

pagination.pageLoop

Same as pagination.pageList except broken into individual elements.

pagination.url: The URL of a page in the page loop.
pagination.text: The number of a page in the page loop.
pagination.range: Displays the range of available pages, in a start - end format.
pagination.activePage: A boolean which will be true if the this page in the pageLoop is the currently viewed page.

pagination.pageList.upTo20

A list of links to the 20 nearest in the paginator relative to the current page. So if you're on page 60, you'll see links for 50-70.

pagination.pageLoop.upTo20

Same as pagination.pageList.upTo20 except broken into individual elements.

pagination.url: The URL of a page in the page loop.
pagination.text: The number of a page in the page loop.
pagination.range: Displays the range of available pages, in a start - end format.
pagination.activePage: A boolean which will be true if the this page in the pageLoop is the currently viewed page.

pagination.pageList.upTo10

A list of links to the 10 nearest in the paginator relative to the current page. So if you're on page 20, you'll see links for 15-25.

pagination.pageLoop.upTo10

Same as pagination.pageList.upTo10 except broken into individual elements.

pagination.url: The URL of a page in the page loop.
pagination.text: The number of a page in the page loop.
pagination.range: Displays the range of available pages, in a start - end format.
pagination.activePage: A boolean which will be true if the this page in the pageLoop is the currently viewed page.