Home Features Product Options Evaluation Support About

FAQ
Forum
Support Tickets
Documentation
  Terminology
  Custom Views
  Configuration Guide
  Integration Guide

Custom View Data Model

Reference Objects

The following data objects are made available to one or more page of the Custom Views.

Reference Object Type Notes
$category category notes
$organisation organisation notes
$requestAttachment requestAttachment notes
$requestComment requestComment notes
$requestPriority requestPriority notes
$requestStatus requestStatus notes
$requestType requestType notes
$requestVote requestVote notes
$request request notes
$searchResult searchResult notes
$user user notes
$customField customField notes

Reference Object Properties

Category Usage Return Value
created $category.created java.util.Date
createdLong $category.createdLong text
description $category.description text
descriptionHTML $category.descriptionHTML text
fullPathHTML $category.fullPathHTML text
fullPathStr $category.fullPathStr text
id $category.id text
itemsCount $category.itemsCount text/number
name $category.name text
nameHTML $category.nameHTML text
parent $category.parent category
root $category.root true/false
timestampShort $category.timestampShort text
updated $category.updated java.util.Date
updatedLong $category.updatedLong text
updatedShort $category.updatedShort text
getLinkedPathHTML ( text ,  text ) $category.getLinkedPathHTML ( text ,  text ) text

Organisation Usage Return Value
address $organisation.address text
addressHTML $organisation.addressHTML text
categoriesLabel $organisation.categoriesLabel text
categoriesLabelHTML $organisation.categoriesLabelHTML text
categoryLabel $organisation.categoryLabel text
categoryLabelHTML $organisation.categoryLabelHTML text
customFieldTitles $organisation.customFieldTitles java.util.List
customFields $organisation.customFields java.util.List
email $organisation.email text
emailHTML $organisation.emailHTML text
homeURL $organisation.homeURL text
id $organisation.id text
name $organisation.name text
nameHTML $organisation.nameHTML text
phone $organisation.phone text
phoneHTML $organisation.phoneHTML text
requestLabel $organisation.requestLabel text
requestLabelHTML $organisation.requestLabelHTML text
requestPriorities $organisation.requestPriorities java.util.List
requestStatuses $organisation.requestStatuses java.util.List
requestTypes $organisation.requestTypes java.util.List
requestsLabel $organisation.requestsLabel text
requestsLabelHTML $organisation.requestsLabelHTML text
getCustomFieldbyTitle ( text ) $organisation.getCustomFieldbyTitle ( text ) customField

requestAttachment Usage Return Value
id $requestAttachment.id text
mimeType $requestAttachment.mimeType text
realName $requestAttachment.realName text
realNameHTML $requestAttachment.realNameHTML text
request $requestAttachment.request request
size $requestAttachment.size text/number

requestComment Usage Return Value
author $requestComment.author user
authorLoginAndOrgNameHTML $requestComment.authorLoginAndOrgNameHTML text
authorLoginHTML $requestComment.authorLoginHTML text
comment $requestComment.comment text
commentHTML $requestComment.commentHTML text
confidential $requestComment.confidential true/false
id $requestComment.id text
request $requestComment.request request
timestamp $requestComment.timestamp java.util.Date
timestampLong $requestComment.timestampLong text
timestampShort $requestComment.timestampShort text
getAuthorLoginAndOrgNameHTML ( text ) $requestComment.getAuthorLoginAndOrgNameHTML ( text ) text

requestPriority Usage Return Value
active $requestPriority.active true/false
colour $requestPriority.colour text
iconHTML $requestPriority.iconHTML text
id $requestPriority.id text
name $requestPriority.name text
nameAndIconHTML $requestPriority.nameAndIconHTML text
nameHTML $requestPriority.nameHTML text

requestStatus Usage Return Value
code $requestStatus.code text/number
colour $requestStatus.colour text
id $requestStatus.id text
name $requestStatus.name text
nameHTML $requestStatus.nameHTML text

requestType Usage Return Value
active $requestType.active true/false
colour $requestType.colour text
iconHTML $requestType.iconHTML text
id $requestType.id text
name $requestType.name text
nameAndIconHTML $requestType.nameAndIconHTML text
nameHTML $requestType.nameHTML text
shortName $requestType.shortName text
shortNameHTML $requestType.shortNameHTML text

requestVote Usage Return Value
author $requestVote.author user
authorLoginAndOrgNameHTML $requestVote.authorLoginAndOrgNameHTML text
authorLoginHTML $requestVote.authorLoginHTML text
comment $requestVote.comment text
commentHTML $requestVote.commentHTML text
id $requestVote.id text
priorityIconHTML $requestVote.priorityIconHTML text
priorityNameAndIconHTML $requestVote.priorityNameAndIconHTML text
priorityNameHTML $requestVote.priorityNameHTML text
request $requestVote.request request
timestamp $requestVote.timestamp java.util.Date
timestampLong $requestVote.timestampLong text
timestampShort $requestVote.timestampShort text
getAuthorLoginAndOrgNameHTML ( text ) $requestVote.getAuthorLoginAndOrgNameHTML ( text ) text

request Usage Return Value
author $request.author user
authorLoginAndOrgNameHTML $request.authorLoginAndOrgNameHTML text
authorLoginHTML $request.authorLoginHTML text
category $request.category category
closedDate $request.closedDate java.util.Date
closedDateLong $request.closedDateLong text
closedDateShort $request.closedDateShort text
commentCount $request.commentCount text/number
description $request.description text
descriptionHTML $request.descriptionHTML text
discussion $request.discussion true/false
enteredBy $request.enteredBy user
enteredByLoginAndOrgNameHTML $request.enteredByLoginAndOrgNameHTML text
enteredByLoginHTML $request.enteredByLoginHTML text
estimateCost $request.estimateCost text
faq $request.faq true/false
id $request.id text
internalSupRefId $request.internalSupRefId text
internalSupRefIdHTML $request.internalSupRefIdHTML text
no $request.no text/number
notifyDeadlineDate $request.notifyDeadlineDate java.util.Date
notifyDeadlineOffset $request.notifyDeadlineOffset text
perceivedValue $request.perceivedValue text
postedOnbehalf $request.postedOnbehalf true/false
priority $request.priority requestPriority
priorityIconHTML $request.priorityIconHTML text
priorityNameAndIconHTML $request.priorityNameAndIconHTML text
priorityNameHTML $request.priorityNameHTML text
priv $request.priv true/false
requiredByDate $request.requiredByDate java.util.Date
resolution $request.resolution text
resolutionDate $request.resolutionDate java.util.Date
resolutionDateLong $request.resolutionDateLong text
resolutionDateShort $request.resolutionDateShort text
resolutionHTML $request.resolutionHTML text
resolutionUser $request.resolutionUser user
resolutionUserHTML $request.resolutionUserHTML text
resolutionUserLoginAndOrgNameHTML $request.resolutionUserLoginAndOrgNameHTML text
responsibleUser $request.responsibleUser user
responsibleUserLoginAndOrgNameHTML $request.responsibleUserLoginAndOrgNameHTML text
responsibleUserLoginHTML $request.responsibleUserLoginHTML text
status $request.status requestStatus
statusNameHTML $request.statusNameHTML text
supplier $request.supplier organisation
supplierReviewDate $request.supplierReviewDate java.util.Date
supplierReviewDateLong $request.supplierReviewDateLong text
supplierReviewDateShort $request.supplierReviewDateShort text
supportAllowed $request.supportAllowed true/false
timestamp $request.timestamp java.util.Date
timestampLong $request.timestampLong text
timestampShort $request.timestampShort text
title $request.title text
titleHTML $request.titleHTML text
type $request.type requestType
typeIconHTML $request.typeIconHTML text
typeNameAndIconHTML $request.typeNameAndIconHTML text
typeNameHTML $request.typeNameHTML text
typeShortNameHTML $request.typeShortNameHTML text
updateTimestamp $request.updateTimestamp java.util.Date
updateTimestampLong $request.updateTimestampLong text
updateTimestampShort $request.updateTimestampShort text
votesCount $request.votesCount text/number
getAuthorLoginAndOrgNameHTML ( text ) $request.getAuthorLoginAndOrgNameHTML ( text ) text
getCustomFieldValue ( text ) $request.getCustomFieldValue ( text ) text
getEnteredByLoginAndOrgNameHTML ( text ) $request.getEnteredByLoginAndOrgNameHTML ( text ) text
getResolutionUserLoginAndOrgNameHTML ( text ) $request.getResolutionUserLoginAndOrgNameHTML ( text ) text
getResponsibleUserLoginAndOrgNameHTML ( text ) $request.getResponsibleUserLoginAndOrgNameHTML ( text ) text
isFromOrg ( organisation ) $request.isFromOrg ( organisation ) true/false
isSupportedBy ( user ) $request.isSupportedBy ( user ) true/false

searchResult Usage Return Value
date $searchResult.date java.util.Date
dateLong $searchResult.dateLong text
dateShort $searchResult.dateShort text
id $searchResult.id text
no $searchResult.no text
score $searchResult.score text/number
title $searchResult.title text
titleHTML $searchResult.titleHTML text

user Usage Return Value
email $user.email text
emailHTML $user.emailHTML text
fullName $user.fullName text
fullNameHTML $user.fullNameHTML text
id $user.id text
lastLogin $user.lastLogin java.util.Date
lastLoginLong $user.lastLoginLong text
lastLoginShort $user.lastLoginShort text
login $user.login text
loginAndOrgNameHTML $user.loginAndOrgNameHTML text
loginHTML $user.loginHTML text
org $user.org organisation
phone $user.phone text
phoneHTML $user.phoneHTML text
suppierUser $user.suppierUser true/false
getLoginAndOrgNameHTML ( text ) $user.getLoginAndOrgNameHTML ( text ) text

customField Usage Return Value
active $customField.active true/false
boolean $customField.boolean true/false
choice $customField.choice true/false
choices $customField.choices java.util.List
defaultValue $customField.defaultValue text
defaultValueHTML $customField.defaultValueHTML text
formParamName $customField.formParamName text
hiddenFromClient $customField.hiddenFromClient true/false
id $customField.id text
inputHeight $customField.inputHeight text/number
inputWidth $customField.inputWidth text/number
mandatory $customField.mandatory true/false
noLabel $customField.noLabel text
noLabelHTML $customField.noLabelHTML text
number $customField.number text/number
subtype $customField.subtype text/number
text $customField.text true/false
title $customField.title text
titleHTML $customField.titleHTML text
type $customField.type text
yesLabel $customField.yesLabel text
yesLabelHTML $customField.yesLabelHTML text