Help: In/Out Board, Template
For more help, visit the WebGUI Community Wiki.
The following variables are made available from In/Out Board:
- canViewReport
- A boolean indicating whether or not the viewReportURL variable will be set.
- viewReportURL
- URL that links to the view report page.
- viewReportLabel
- Internationalized title for the URL to view reports.
- selectDelegatesURL
- URL that links to a form where users can select other users (delegates) who can alter their status.
- selectDelegatesLabel
- Internationalized title for the URL to select delegates.
- displayForm
- A boolean indicating whether or not the form variable will be set.
- form
- A variable that contains the HTML for displaying the In/Out Entry Form to update status for the current user or another user.
- rows_loop
- A loop containing the rows of data for the In/Out Board
- deptHasChanged
- A boolean value indicating whether or not this row of data is for a department that is different than the previous rows
- department
- A variable that returns the user's department. If no department has been assigned to this user, an internationalized label for "No Department" will be used.
- username
- A variable that returns the user's name. If the first and last name fields are defined in the user profile, that is what is returned. Otherwise, the user's WebGUI username is returned. i.e., "John Doe" vs "Jdoe"
- status
- A variable that returns the user's status. The status of a user is defined by the Status List in the Wobject Properties. If no status is set for the current user 'Never Checked In' is returned.
- dateStamp
- A variable that returns the date the status of the user was last updated.
- message
- A variable that returns what the user entered in the "What's going on?" field when updating their status.
- paginateBar
- A variable that returns the HTML necessary to create a Traditional Pagination Bar. i.e., >> First, 1, 2, Last <<
- statusList
- A string with all of the possible board statuses separated by newlines.
- reportViewerGroup
- The ID of the group that is allowed to view reports.
- inOutGroup
- Who can log in/out?
- inOutTemplateId
- The ID of the template that is used to display the main screen of the In/Out Board.
- reportTemplateId
- The ID of the template that is used to display In/Out Board reports.
- paginateAfter
- The number of rows should be displayed per page in the main In/Out Board.
- 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
