Issue tracking is one of the most obvious uses of trackers in Tiki. Issue tracking systems based on Tiki trackers take many steps to configure. This profile will enable the tracker feature and create a basic issue tracker to which you will be able to add additional fields.
Bug trackers are typically accessible to the whole community. We want people to check if an issue has already been logged before adding a new one. This is different than an
help desk.
These pages will be created:
This profile can be extended to use the custom search plugin using the
Bug_Tracker_Search profile.
YAML
Copy to clipboard
preferences:
feature_trackers: y
feature_user_watches: y
ajax_inline_edit: y
feature_jquery_tablesorter: y
feature_wiki_argvariable: y
tracker_show_comments_below: y
trackerfield_dropdownother: y
trackerfield_groupselector: y
instructions: Bug Tracker Instructions
objects:
-
type: tracker
ref: bug_tracker
data:
name: Bugs
description: Standard bug tracker
sort_default_order: desc
hide_list_empty_fields: y
restrict_end: 0
restrict_start: 0
allow:
- comments
- user_see_own
- creator_modification
show:
- creation_date
- list_modification_date
- modification_date
- status
-
type: tracker_field
ref: bug_tracker_bug_status
data:
name: Bug status
permname: bug_tracker_bug_status
tracker: $profileobject:bug_tracker$
options:
options:
- new
- new
- feedback
- acknowledged
- confirmed
- resolved
- wontfix
- worksforme
- other
type: dropdown_other
order: 10
visible: creator_editable
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_severity
data:
name: Severity
permname: bug_tracker_severity
tracker: $profileobject:bug_tracker$
options:
options:
- 5=fatal
- 4= major
- 3=normal
- 3=normal
- 2=minor
- 1=text
- other=Other
type: dropdown_other
order: 20
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_priority
data:
name: Priority
permname: bug_tracker_priority
tracker: $profileobject:bug_tracker$
options:
options:
- 5=5 (high)
- 4=4
- 3=3
- 3=3
- 2=2
- 1=1 (low)
type: dropdown
order: 30
visible: immutable
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_summary
data:
name: Summary
permname: bug_tracker_summary
tracker: $profileobject:bug_tracker$
options:
samerow: 1
type: text_field
order: 40
flags:
- link
- list
- searchable
- public
- mandatory
-
type: tracker_field
ref: bug_tracker_version
data:
name: Version
permname: bug_tracker_version
tracker: $profileobject:bug_tracker$
options:
options:
- 1.x
- 2.x
- 3.x
- 4.x
- 5.x
- trunk
type: multiselect
order: 50
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_description
data:
name: Description
permname: bug_tracker_description
tracker: $profileobject:bug_tracker$
options:
toolbars: 1
distinct: n
wysiwyg: n
samerow: 1
type: text_area
order: 60
flags:
- searchable
- public
- mandatory
-
type: tracker_field
ref: bug_tracker_expected_behaviour
data:
name: Expected behaviour
permname: bug_tracker_expected_behaviour
tracker: $profileobject:bug_tracker$
options:
toolbars: 1
width: 80
height: 5
max: 10000
listmax: 200
distinct: n
wysiwyg: y
samerow: 1
type: text_area
order: 70
flags:
- searchable
- public
-
type: tracker_field
ref: bug_tracker_submitted_by
data:
name: Submitted by
permname: bug_tracker_submitted_by
tracker: $profileobject:bug_tracker$
options:
autoassign: 1
notify: 0
groupIds:
- 0
canChangeGroupIds:
- 0
type: user
order: 80
visible: immutable
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_assignee
data:
name: Assigned to
permname: bug_tracker_assignee
tracker: $profileobject:bug_tracker$
options:
notify: 0
groupIds:
- 0
canChangeGroupIds:
- 0
type: user
order: 90
visible: creator_editable
flags:
- list
- searchable
- public
-
type: tracker_field
ref: bug_tracker_alert_to
data:
name: Alert to
permname: bug_tracker_alert_to
tracker: $profileobject:bug_tracker$
options:
notify: 0
groupIds:
- 0
canChangeGroupIds:
- 0
type: user
order: 100
flags:
- list
- public
-
type: tracker_option
ref: bugs_sort_default_field
data:
tracker: $profileobject:bug_tracker$
name: sort_default_field
value: modification
-
type: tracker_option
ref: bugs_popup_fields
data:
tracker: $profileobject:bug_tracker$
name: popup_fields
value: >
$profileobject:bug_tracker_assignee$,$profileobject:bug_tracker_description$,$profileobject:bug_tracker_expected_behaviour$,$profileobject:bug_tracker_submitted_by$,$profileobject:bug_tracker_alert_to$
Groups
Create a group "Submitters" which has permission to insert items in the Bug Tracker. The other group "Reviewers" will have extra permission to change some fields on the items in a later stage, that "Submitters" will not be able to.
YAML
Copy to clipboard
permissions:
Submitters:
home: $profileobject:bug_tracker$
description: Members of the organization allowed to add bug reports and modify them
allow:
include: [ Registered ]
objects:
-
type: tracker
id: $profileobject:bug_tracker$
allow:
- create_tracker_items
- list_trackers
- view_trackers
- view_trackers_pending
- view_trackers_closed
Reviewers:
description: Members of the organization that are not allowed to modify the bug reports
allow:
include: [ Registered ]
objects:
-
type: tracker
id: $profileobject:bug_tracker$
allow:
- create_tracker_items
- list_trackers
- view_trackers
- modify_tracker_items
- modify_tracker_items_pending
- modify_tracker_items_closed
Users
Add a user to the group Members
YAML
Copy to clipboard
objects:
-
type: user
data:
name: submitter1
pass: submitter1
email: submitter1@example.com
change: n
groups: [ Submitters ]
-
type: user
data:
name: submitter2
pass: submitter2
email: submitter2@example.com
change: n
groups: [ Submitters ]
-
type: user
data:
name: reviewer1
pass: reviewer1
email: reviewer1@example.com
change: n
groups: [ Reviewers ]
Sample data
YAML
Copy to clipboard
objects:
-
type: tracker_item
ref: bug_001
data:
tracker: $Bug_Tracker_16:bug_tracker
status: open
values:
- [ $Bug_Tracker_16:bug_tracker_summary, The application crashed ]
- [ $Bug_Tracker_16:bug_tracker_severity, 5 ]
- [ $Bug_Tracker_16:bug_tracker_priority, 3 ]
- [ $Bug_Tracker_16:bug_tracker_bug_status, new ]
- [ $Bug_Tracker_16:bug_tracker_version, trunk ]
- [ $Bug_Tracker_16:bug_tracker_description, "This bug was created as part of the sample data for Bug_Tracker_16, and it refers to a critical bug that prevent the application from running at all. However, since it only affects the trunk (development) version, it doesn't have the maximum priority to be debugged." ]
- [ $Bug_Tracker_16:bug_tracker_expected_behaviour, "Keep the ~~red,lightyellow:application~~ running __without crashing__" ]
- [ $Bug_Tracker_16:bug_tracker_submitted_by, submitter1 ]
- [ $Bug_Tracker_16:bug_tracker_assignee, admin ]
- [ $Bug_Tracker_16:bug_tracker_alert_to, reviewer1 ]
-
type: tracker_item
ref: bug_002
data:
tracker: $Bug_Tracker_16:bug_tracker
status: pending
values:
- [ $Bug_Tracker_16:bug_tracker_summary, One menu option does nothing ]
- [ $Bug_Tracker_16:bug_tracker_severity, 4 ]
- [ $Bug_Tracker_16:bug_tracker_priority, 4 ]
- [ $Bug_Tracker_16:bug_tracker_bug_status, new ]
- [ $Bug_Tracker_16:bug_tracker_version, 5.x ]
- [ $Bug_Tracker_16:bug_tracker_description, "Going to Tools > Help does nothing and no contextual help is shown." ]
- [ $Bug_Tracker_16:bug_tracker_expected_behaviour, "Get the ~~blue,lightgrey:contextual help~~ to __show up__ as usual" ]
- [ $Bug_Tracker_16:bug_tracker_submitted_by, submitter1 ]
- [ $Bug_Tracker_16:bug_tracker_assignee, admin ]
- [ $Bug_Tracker_16:bug_tracker_alert_to, reviewer1 ]
-
type: tracker_item
ref: bug_003
data:
tracker: $Bug_Tracker_16:bug_tracker
status: open
values:
- [ $Bug_Tracker_16:bug_tracker_summary, Some strings are shown in italics by mistake ]
- [ $Bug_Tracker_16:bug_tracker_severity, 1 ]
- [ $Bug_Tracker_16:bug_tracker_priority, 2 ]
- [ $Bug_Tracker_16:bug_tracker_bug_status, acknowledged ]
- [ $Bug_Tracker_16:bug_tracker_version, 5.x ]
- [ $Bug_Tracker_16:bug_tracker_description, "Only aesthetics changed, all features work as expected" ]
- [ $Bug_Tracker_16:bug_tracker_expected_behaviour, "Keep the same -+non-italics+- font" ]
- [ $Bug_Tracker_16:bug_tracker_submitted_by, submitter1 ]
- [ $Bug_Tracker_16:bug_tracker_assignee, admin ]
- [ $Bug_Tracker_16:bug_tracker_alert_to, reviewer1 ]
-
type: tracker_item
ref: bug_004
data:
tracker: $Bug_Tracker_16:bug_tracker
status: closed
values:
- [ $Bug_Tracker_16:bug_tracker_summary, The application did not start at all ]
- [ $Bug_Tracker_16:bug_tracker_severity, 5 ]
- [ $Bug_Tracker_16:bug_tracker_priority, 5 ]
- [ $Bug_Tracker_16:bug_tracker_bug_status, resolved ]
- [ $Bug_Tracker_16:bug_tracker_version, 5.x ]
- [ $Bug_Tracker_16:bug_tracker_description, "Critical issue that prevented the from running at all in usual desktops" ]
- [ $Bug_Tracker_16:bug_tracker_expected_behaviour, "Allow the app to __run as usual__" ]
- [ $Bug_Tracker_16:bug_tracker_submitted_by, submitter2 ]
- [ $Bug_Tracker_16:bug_tracker_assignee, admin ]
- [ $Bug_Tracker_16:bug_tracker_alert_to, reviewer1 ]
-
type: tracker_item
ref: bug_005
data:
tracker: $Bug_Tracker_16:bug_tracker
status: open
values:
- [ $Bug_Tracker_16:bug_tracker_summary, Not localized/translated to my mother tonge ]
- [ $Bug_Tracker_16:bug_tracker_severity, 3 ]
- [ $Bug_Tracker_16:bug_tracker_priority, 3 ]
- [ $Bug_Tracker_16:bug_tracker_bug_status, new ]
- [ $Bug_Tracker_16:bug_tracker_version, 5.x ]
- [ $Bug_Tracker_16:bug_tracker_description, "Critical issue that prevented the from running at all in usual desktops" ]
- [ $Bug_Tracker_16:bug_tracker_expected_behaviour, "Get it in my local language also when I select it (or through ~~red:the language~~ in ''my OS'')" ]
- [ $Bug_Tracker_16:bug_tracker_submitted_by, submitter2 ]
- [ $Bug_Tracker_16:bug_tracker_alert_to, reviewer1 ]
Modules
YAML
Copy to clipboard
objects:
-
type: module
ref: module_last_modif_tracker_items
data:
name: last_modif_tracker_items
groups: [ Anonymous, Registered ]
position: left
order: 5
params:
trackerId: $Bug_Tracker_16:bug_tracker
name: Summary
-
type: module
ref: module_menupage_bug_tracker
data:
name: menupage
params:
pagemenu: $bug_tracker_menupage_include
groups:
- Anonymous
- Registered
order: 2
position: left
Wiki pages
Add a form to add bug report and a report of open bugs:
Profile_Bug_Tracker_bug_page
And a menu:
Profile_Bug_Tracker_16_menupage_include
And the Instruction page:
Profile_Bug_Tracker_16_instructions_page
YAML
Copy to clipboard
preferences:
enable: [ feature_wiki ]
objects:
-
type: wiki_page
ref: bug_tracker_ui_page
data:
name: Bug Tracker
description: What needs to be done
lang: en
content: wikicontent:Profile_Bug_Tracker_16_bug_page
-
type: wiki_page
ref: bug_tracker_instructions_page
data:
name: Bug Tracker Instructions
description: Instructions on how to use this profile
lang: en
mode: create_or_update
content: wikicontent:Profile_Bug_Tracker_16_instructions_page
-
type: wiki_page
ref: bug_tracker_menupage_include
data:
name: Menu from BT16
description: Custom Wiki Menu for the Bug Tracker 16 Profile
lang: en
mode: create_or_update
content: wikicontent:Profile_Bug_Tracker_16_menupage_include
Plugin to embed bug information in pages
YAML
Copy to clipboard
objects:
-
type: plugin_alias
data:
name: bug
implementation: trackerlist
description:
name: Bug Embed
description: Displays a bug's information inside a wiki page
prefs: [ feature_trackers ]
params:
id:
name: ID
description: Bug ID matching the tracker item ID
required: true
filter: digits
body:
input: ignore
params:
trackerId: $bug_tracker
fields: $profileobject:bug_tracker_summary$:$profileobject:bug_tracker_severity$:$profileobject:bug_tracker_priority$:$profileobject:bug_tracker_bug_status$:$profileobject:bug_tracker_version$:$profileobject:bug_tracker_description$:$profileobject:bug_tracker_expected_behaviour$:$profileobject:bug_tracker_submitted_by$:$profileobject:bug_tracker_assignee$
showlinks: "y"
showstatus: "y"
status: opc
max: 1
showlastmodif: "n"
showfieldname: "n"
itemId:
pattern: "%id%"
params:
id:
default: 0
YAML
Copy to clipboard
preferences:
feature_wiki_comments: y
feature_inline_comments: y
comments_field_email: y
comments_field_website: y
wikiplugin_comment: y
YAML
Copy to clipboard
permissions:
Anonymous:
allow:
- read_comments
- tracker_view_comments
Registered:
allow:
- comment
- post_comments
- comment_tracker_items
Submitters:
allow:
- comment
- post_comments
Reviewers:
description: Can approve & delete
allow:
- edit_comments
- remove_comments
Admins:
allow:
- admin_comments
Alias names for this page:
Bug_Tracker_15