WebGUI - Admin Console

For more help, visit the WebGUI Community Wiki.

extras

URL to the TimeTracking area in the extras directory, wobject/TimeTracking.

report.nextWeek.url

URL display information for the next week

report.lastWeek.url

URL display information for the previous week

time.report.header

Header for the time report displaying the ending date of the week.

time.report.totalHours.label

The phrase "Total Hours", internationalized.

time.report.date.label

The word "Date", internationalized.

time.report.project.label

The word "Project", internationalized.

time.report.task.label

The word "Task", internationalized.

time.report.hours.label

The word "Hours", internationalized.

time.report.comments.label

The word "Comments", internationalized.

time.add.row.label

The phrase "Add Row", internationalized.

time.save.label

The word "Save", internationalized.

time.report.complete.label

The phrase "Report Complete", internationalized.

report.isComplete

A boolean that is true if the form is complete.

time.totalHours

The total amount of hours taken by all tasks in this week by the current user.

time.entry.loop

A loop containing information and form elements for each task worked on during the week. If a task is marked as complete, then that row in the loop will contain read only status information for that task. Otherwise a form elements will be generated for the user to enter status information. Status information includes the project worked on, the task in the project that was worked on, on which days work was performed and the number of hours of work that were done.

row.id: A unique identifier for this row, row_rowNum
form.taskEntryId: Required form code containing the taskEntryId
form.project: If the report is marked complete, this variable will contain the name of the project. If the task is not complete, then this variable will contain form code for a select box for the user to pick a project name to enter status information for.
form.task: If the report is marked complete, this variable will contain the name of the task in the project. If the task is not complete, then this variable will contain form code for a select box for the user to pick a task name from the project.
form.date: If the report is marked complete, this variable will contain the project that status has been entered for. If the task is not complete, then this variable will contain form code for a select box for the user to pick which day of the week status informatio will be entered.
form.hours: If the report is marked complete, this variable will contain the number of hours worked on a task for a project on a day. If the task is not complete, then this variable will contain form code for a number field for the user to enter a floating point number for the number of hours worked.
form.comments: If the report is marked complete, this variable will contain comments from the user for work done for a task on a given day. If the task is not complete, then this variable will contain form code for a text field for the user to enter comments.
entry.hours: This is similar to form.hours, except that it always contains the number of hours entered by the user for work done on this task on a day. If no hours have been entered, it will be 0.

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.

userViewTemplateId

The template that will be used to display this asset to a general user.

managerViewTemplateId

The template that will be used to display this asset to a manager.

timeRowTemplateId

The ID of the template that makes 1 row in the time sheet.

groupToManage

The ID of the group that is able to view all time sheets and updated completed time records.

pmIntegration

A conditional indicating whether or not this Time Tracking Asset has been configured for integration with the Project Manager.