))TrackerHandler(( allows to create trackers and the related fields. This page describes the syntax and available options. To use trackers in profiles, ObjectReferences are required.
Complete Sample
Bug Tracker
preferences:
feature_trackers: y
objects:
-
type: tracker
ref: bug_tracker
data:
name: Bugs
description: Simple Bug Tracker
default_status: open
show: [status, creation_date, modification_date, list_modification_date ]
allow: [comments]
-
type: tracker_field
ref: bug_summary
data:
name: Summary
tracker: $bug_tracker
type: text_field
flags: [searchable, public, list, mandatory]
order: 1
-
type: tracker_field
ref: bug_priority
data:
name: Priority
tracker: $bug_tracker
type: numeric
flags: [searchable, public, list]
order: 2
-
type: tracker_field
ref: bug_description
data:
name: Description
tracker: $bug_tracker
type: text_area
flags: [public, mandatory]
order: 3
-
type: tracker_field
ref: bug_assignee
data:
name: Assigned to
tracker: $bug_tracker
type: user
flags: [searchable, public, list]
order: 4
Tracker Object
Field Name | Mandatory | Value
|
name | yes | Tracker name
|
description | | Full tracker description
|
list_default_status | | A single value or multiple values from (open,pending,closed)
|
email | | The email address to contact for any activity on the tracker
|
email_simplified | | Send the emails in a simplified format
|
default_status | | Status applied to new items from (open,pending,closed)
|
modification_status | | Status applied on item modification (open,pending,closed)
|
show | | List of display options to activate
|
| | status | Display the field status field
|
| | status_admin_only | Make the status field only visible to admins
|
| | creation_date | Display the creation date in the full view
|
| | list_creation_date | Display the creation date in the item list
|
| | modification_date | Display the last modification date in the full view
|
| | list_modification_date | Display the last modification date in the item list
|
allow | | List of permissions granted
|
| | creator_modification | Allow the creator to modify the item
|
| | creator_group_modification | Allow users in the same default group as the creator to edit the item
|
| | rating | Enable ratings on items
|
| | comments | Enable comments on items
|
| | attachments | Enable attachments on items
|
creation_date_format | | Format to display the creation date in
|
modification_date_format | | Format to display the last modification date in
|
sort_default_field | | The field to sort the tracker list with (creation,modification,item)
|
sort_default_order | | Sort order (asc,desc)
|
restrict_start | | Only allow items to be added from the provided date
|
restrict_end | | Only allow items to be added until the provided date
|
hide_list_empty_fields | | (y,n) |
Tracker Field Object
Field Name | Mandatory | Value
|
name | yes | The label of the field
|
tracker | yes | The ID of the tracker, usually a reference to a tracker object
|
description | | A full description of the field
|
type | | Tracker field type (list below)
|
options | no* | Option string, same as tracker field form. Not always needed.
|
order | | numeric field to indicate the display order of the tracker fields
|
visible | | Field accessibility (public,adminonly,admin_editable,creator_editable)
|
flags | | List of field options
|
| | list | Display field in item list
|
| | link | Link field to full item view
|
| | searchable | Allow to filter on field
|
| | public | Display field in trackerlist
|
| | mandatory | If field is required
|
| | multilingual | If field is multilingual |
Field types
These are the field names as recognized by TikiProfiles. For more information about the
options argument, see
Trackers Documentation.
- text_field
- text_area
- checkbox
- numeric
- dropdown
- dropdown_other
- radio
- user
- group
- ip_address
- country
- datetime
- calendar
- image
- action
- header
- static
- category
- item_link
- item_list
- item_list_dynamic
- email
- multimedia
- auto_increment
- user_subscription
- map
- system
- computed
- preference
- attachment