WebGUI - Admin Console

For more help, visit the WebGUI Community Wiki.

back.url

A url that will take you back to the default page in the form.

back.label

The default label for the back.url variable.

deleteAllEntries.url

A URL to allow the user to delete all entries in the DataForm.

deleteAllEntries.label

The default label for the deleteAllEntries.url variable

javascript.confirmation.deleteAll

Javascript for an internationalized confirmation popup for deleting all entries.

canEdit

Code to enable tabs to work correctly.

canViewEntries

This template variable is true when the current user is allowed to view the list of submitted DataForm entries.

hasEntries

The number of entries in this DataForm.

export.tab.url

Following this URL will export the data stored to this data form as a tab delimited file.

export.tab.label

The default label for the export.tab.url variable.

addField.url

The URL that content managers will visit to add a new field to the form.

addField.label

The default label for the addField.url variable.

addTab.url

The URL that content managers will visit to add a new tab to the form.

addTab.label

The default label for the addTab.url variable.

field_loop

A loop containing all of the field information. From outside the field_loop it's also possible to access all form fields directly. To accomplish this you should use these variables. Call them with field.noloop.fieldName.property, where fieldName is the name of the field (not the label) and property is any one of the properties supplied by the field_loop. If you want the form tag of field 'name' you should use field.noloop.name.form anywhere in your template. If you want to know if the field is required use field.noloop.name.isRequired.

field.name: The name of this field.
field.label: The text label for this field.
field.id: A unique identifier representing this field in the database.
field.isMailField: A conditional indicating whether this field is present only to facilitate sending an email.
field.type: The data type associated with this field.

record_loop

A loop containing the record entries of this data form.

record.entryId

A unique identifier for this record entry.

record.ipAddress

The IP Address of the user that submitted this record entry.

record.edit.url

The URL to edit this record.

record.edit.icon

An icon and associated URL for editing this record.

record.delete.url

The URL to delete this record.

record.delete.icon

An icon and associated URL for deleting this record.

record.username

The username of the person that submitted this record entry.

record.userId

The user id of the person that submitted this record entry.

record.submissionDate.epoch

The epoch date stamp for this record entry.

record.submissionDate.human

A human readable date stamp, based upon the user's preferences, for this record entry.

record.noloop.

You can get any field's value in this record by name, ex: record.noloop.subject

record.data_loop

A loop containing the data submitted by the user for each field in this data form.

record.data.name: The web safe name of this field.
record.data.label: The human readable label for this field.
record.data.value: The value submitted by the user for this field in this record entry.
record.data.isMailField: A conditional indicating whether this field exists for the mail subsystem of the data form.
record_data_type: The data type associated with this field.

templateId

The ID of the template for displaying the form view of the DataForm.

acknowledgement

The acknowledgement to display to the user after they have submitted data.

emailTemplateId

The ID of the template for sending emails of user submitted data from the DataForm.

acknowlegementTemplateId

The ID of the template for displaying the acknowledgement to the user after they have submitted data to the DataForm.

listTemplateId

The ID of the template for displaying the list view of the DataForm.

mailData

mailData will be true if the DataForm was configured to send emails.

mailAttachments

mailAttachments will be true if the DataForm was configured to email files submitted to the DataForm.

defaultView

This will be true if the DataForm was configured to display the List view by default, instead of the Form.

groupToViewEntries

The Group ID of the group set to view the list of all data submitted to the DataForm when it is in Form mode.

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>

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.