Configuration options
The of IttecoTracPlugin? is simple and you may actually fine-tune it in a variety of ways to suite your needs. Though it'll work out-of-the-box with pre-configured parameters, here is what you may re-configure for your project:
- Define how many levels of milestones hierarchy you want to name each level
- Define which ticket type(s) are responsible for the ScopeElement definition
- Define which ticket type(s) are to be excluded from the whiteboard
- Define the team
- Define the fields which are used for progress calculations in the Roadmap
- Define column statuses on the whiteboard
- Define which columns contain the accordion widgets on the whiteboard
- Define widgets coloring & widget types on the whiteboard
Define how many levels of milestones hierarchy you want to name each level
milestone_levels = Release,Sprint,Build
- It is possible to change names of the nodes in hierarchy of milestones. There is also the possibility to make as many or as few levels in the milestones as you need.
- Change option milestone_levels in section [itteco-roadmap-config] as you deem necessary. The milestones levels need to be given top down.
- The default configuration is Release, Sprint, Build, Release being the top level.
Define which ticket type(s) are responsible for the ScopeElement? definition
scope_element = story
- The ScopeElement? is the ticket type which is responsible for Scope Management. The common names include User Story, Requirement, Feature, Spec, etc. etc. It is used on the whiteboard to define the rows on Team Tasks or widgets in the product backlog view (Stories).
- The default configuration refers to ScopeElement? as to story.
- So, you may either just create the ticket type story in your Admin settings or rename our default configuration to whatever suites you
- It is possible to define a comma-separated list of ticket types as scope_element value.
- Change option scope_element in section [itteco-whiteboard-tickets-config] to rename our setting
Define which ticket type(s) are to be excluded from the whiteboard
excluded_element =
- The comma-separated list of ticket types that are to be excluded from the whiteboard.
By default this value is empty and all ticket types are rendered either as a scope element or a work element.
Define the team
team = andrew, pavel, ivan
- Trac does not have the user list or team members by default. This is because of the various authentication mechanisms available.
- To simplify the assignment of the tasks, we create the team in the section [itteco-whiteboard-config].
- These are the team members which will show up in the Control Panel of the Whiteboards (so that you can drag-n-drop tickets to create assignment or use the names to filter whiteboard per team member)
- By default, the team is empty.
Define the fields which are used for progress calculations in the Roadmap
[itteco-roadmap-config] calc_stats_on = business_value, complexity
- We have added the possibility into the Roadmap to calculate the progress bars not only upon the number of tickets as it is in the default installation, but also on any other numeric field of the tickets.
- For example, we have added the possibility to show progress based upon business_value and complexity. It might occur that when 50% of tickets is done, it brings you over 75% of estimated complexity, yet just under 25% of business value. This means you should have priotarized your work better.
- Beware that progress for hierarchial milestone is calculated on tickets that directly assigned to this milestone and on tickets that belong to all of its child milestones (cause physical meaning of the hierarchy is the timeline, thus inclusion of the tickets to child milestone automatically includes it into all parent milestones too)
- List of the properties that can be used for progress calculation is defined by option calc_stats_on in section [itteco-roadmap-config].
- By default, it is complexity and business_value
Define column statuses on the whiteboard
[itteco-whiteboard-groups] groups = new, assigned, accepted, closed group.accepted.action = accept group.accepted.source_status = new, reopened, assigned, accepted group.accepted.status = accepted group.assigned.action = reassign group.assigned.source_status = new, reopened, assigned, accepted group.assigned.status = assigned group.closed.accordion = true group.closed.action = resolve group.closed.source_status = new, reopened, assigned, accepted, closed group.closed.status = closed group.new.action = reopen group.new.source_status = new, reopened, closed group.new.status = new, reopened
The whiteboard is used to visualize and track progress. Tickets are group according their status.
All groups that are defined in section [itteco-whiteboard-groups]
Option groups defines list of the groups, and each group is represented as a separate column on whiteboard.
The configuration of the group is defined by options:
group.<group_name>.<sub-option> where <group_name> is one of the names defined in groups option, and sub-option is either action, or source_status, or status.
- The action defines action that is to be performed on tickets that are dropped into this group.
- source_status statuses of the tickets that can be dropped to the group
- status defines statuses of the tickets that are to be mapped to the group.
Define which columns contain the accordion widgets on the whiteboard
[itteco-whiteboard-groups] group.closed.accordion = true
- It may occur, that you want to have the accordion for the widgets in the specific group (like we have in Closed group by default, which is expected to get more tickets then other groups).
- In this case, don't hesitate to configure group.<group_name>.accordion = true option for your group.
Define widgets coloring & widget types on the whiteboard
[itteco-whiteboard-tickets-config] default_fields = owner, complexity user_story_ticket_type = story user_story_weight_field = business_value task_weight_field=complexity contingency.icon_text = C contingency.max_color = #C592F4 contingency.min_color = #F3E9fD bug.icon_text = B bug.icon_bg_color = #FF0000 spec.icon_text = SP story.fields = owner, complexity, business_value story.icon_text = S story.max_color = #FFF200 story.min_color = #FFFEE5 task.icon_text = T task.icon_bg_color=#7ACEEF task.max_color = #B0DC78 task.min_color = #EFF8E4 #sample of color pairs #f5f5f5,#cccccc #fff2dc,#ffbe4e #fffee5,#fff200 #eff8e4,#b0dc78 #e4f5fc,#7aceef #fbecf5,#ec9fcc #f3e9fd,#c592f4
Global Option
- default_fields defines the default list of fields to be rendered within ticket and shown on the widgets at the whiteboard
Weight Options
- scope_element_weight_field defines the field that is to be used for weight calculation of scope elements.
- work_element_weight_field defines the field that is to be used for weight calculation of none scope elements.
- Widgets are colored depending on their ticket type and weight (expected that more critical widgets are more eye-catching on the whiteboard)
- The ticket field can be defined as a weight field only if it's type is option. And all allowed values are numeric.
Ticket type specific Options
- For each ticket type you can define list of the fields to be rendered, and colorization options.
- The configuration for ticket type is defined by options:
<ticket_type>.<option> where <ticket_type> is name of the ticket type that is to be customized.
- Possible options:
- fields defined list of the fields that are to be rendered inside ticket widget. If this value is not defined than default_fields configuration option is used.
- icon_text defines the character that is to be displayed in icon of the widget
- icon_bg_color defines background color for the icon
- min_color and max_color define max and min background colors for the given ticket type. Actual background color would be calculated as linear function based on ticket weight field. The smaller is the value of ticket weight field the closer background color is to min color.
- You can choose from some good looking coloring options that we give in sample config file
Default Config File
[itteco-roadmap-config] calc_stats_on = business_value, complexity milestone_levels = Release,Sprint,Build [itteco-whiteboard-config] #team = andrew, pavel, ivan milestone_summary_fields = complexity, business_value [itteco-whiteboard-groups] groups = new, assigned, accepted, closed group.accepted.action = accept group.accepted.source_status = new, reopened, assigned, accepted group.accepted.status = accepted group.assigned.action = reassign group.assigned.source_status = new, reopened, assigned, accepted group.assigned.status = assigned group.closed.accordion = true group.closed.action = resolve group.closed.source_status = new, reopened, assigned, accepted, closed group.closed.status = closed group.new.action = reopen group.new.source_status = new, reopened, closed group.new.status = new, reopened [itteco-whiteboard-tickets-config] default_fields = owner, complexity scope_element = story scope_element_weight_field = business_value work_element_weight_field=complexity contingency.icon_text = C contingency.max_color = #C592F4 contingency.min_color = #F3E9fD bug.icon_text = B bug.icon_bg_color = #FF0000 spec.icon_text = SP story.fields = owner, complexity, business_value story.icon_text = S story.max_color = #FFF200 story.min_color = #FFFEE5 task.icon_text = T task.icon_bg_color=#7ACEEF task.max_color = #B0DC78 task.min_color = #EFF8E4 #sample of color pairs #f5f5f5,#cccccc #fff2dc,#ffbe4e #fffee5,#fff200 #eff8e4,#b0dc78 #e4f5fc,#7aceef #fbecf5,#ec9fcc #f3e9fd,#c592f4
