Editing TeamPulse Project Settings

The TeamPulse project settings are used to defined the rules, statuses and allowed transitions for stories, bugs, issues, risks and tasks.  In case the logged in user has the "EditProjectSettings" permission these settings can be modified from the Project Settings page.

 

  1. In TeamPulse, while in a project, from the ribbon, go to Application Button > Project Settings or use Settings > View Settings ribbon option.
    Project settings menu buttonenlarge screenshot
  2. On the Project Settings page, click the "Edit Advanced Settings" link.
    Project settings advanced linkenlarge screenshot
  3. Use the textbox containing XML to modify the project settings.
  4. When finished, click the Save button to save your settings to the database.
    • If there are any validation errors, they will be displayed to the right of the textbox.
    Project settings advanced screenenlarge screenshot

 

 

Adding new states

One of the most common reasons to edit the project settings is to add a new state to the workflow of a work item type.  For a detailed walkthrough on how to accomplish this task, please see the section entitled: How To: Add Custom States.

 

Project Settings Elements

The following section describes each element of the project settings XML in detail.

 

 
All element names, attribute names, and values are case-sensitive.  If your project is syncing with a TFS project then please pay particular attention to the case of the status names as they must match exactly with the states defined in TFS.

 

StoryBoardStatusList

  • This element contains a list of all the statuses to include in the story board.
  • Any story, bug, issue, or risk that matches one of these statuses (and any other selected filter) will be displayed in the story board.
  • The order the statuses are entered also defines the order of the columns/swim lanes.
  • The only valid child elements are <BoardStatus> elements.
  • To enable work-in-progress limits, on the StoryBoardStatusList element, set EnableLimits=”true” and then set the Min, Max, or both on one or more of the BoardStatus elements.
  • Work-in-progress limits can also be set using the Configure Board dialog from the Story Board screen.
  • For more information, see the section entitled: Story Board.

 

TaskBoardStatusList

  • This element contains a list of all the statuses to include in the task board.
  • Only tasks that match one of these statuses (and any other selected filter) will be displayed in the task board.
  • The order the statuses are entered also defines the order of the columns/swim lanes.
  • The only valid child elements are <BoardStatus> elements.
  • To enable work-in-progress limits, on the TaskBoardStatusList element, set EnableLimits=”true” and then set the Min, Max, or both on one or more of the BoardStatus elements.
  • Work-in-progress limits can also be set using the Configure Board dialog from the Task Board screen.
  • For more information, see the section entitled: Task Board.

 

SynchronizationSettings

  • This element is only used to set the AutoSyncNewEntities attribute to true or false.  This attribute controls the default value of the Sync with TFS checkbox.
  • For more information, see the section entitled: Choosing What to Synchronize.

 

Tracking

  • This element defines some settings used in xView and the dashboard.
  • Instead of editing these values directly in the XML, it is recommended to use the xView Settings page for your project.
  • For more information, see the section entitled: xView Settings.

 

EntityDefinitions

  • This element contains the definitions for all the entities in TeamPulse which includes Story, Task, Bug, Issue, Risk, and Feedback.
  • The only valid child element of EntityDefinitions is <EntityDefinition>.
  • You should not add any new EntityDefinition elements.
  • You should not remove any of the existing EntityDefinition elements.

 

EntityDefinition

  • This element defines a variety of settings for a TeamPulse entity type which includes the workflow, rules, and UI settings.
  • Workflow
    • Statuses
      • This element contains a list of all the possible statuses an entity can have.
      • Status names are case-sensitive and must not have any leading or trailing spaces.
      • The only valid child elements of the Statuses element are <string> elements.
    • Transitions
      • This element is used to define the statuses an entity can be moved to given its current status.
      • The only valid child elements of the Transitions element are <Transition> elements.
      • Each Transition element must contain a From attribute and a To attribute and the values must be one of the statuses from the Statuses list.
      • There must be exactly one Transition element whose “From” attribute is empty as this defines the initial status of the entity.
    • Status groups
      • As part of the workflow element there are a number of status groups.  These groups are used in a number of places such as My Perspective, ReportingFiltering, etc..
      • UnexecutedStatuses - Comma separated list of statuses that are considered to mean that work on an item has not yet started.
      • InProgressStatuses - Comma separated list of statuses that are considered to mean that work on an item has started but is not yet completed.
      • DoneStatuses - Comma separated list of statuses that are considered to mean that work on an item has been completed.
      • ExcludedStatuses - Comma separated list of statuses that are considered to mean that an item should be ignored because it is no longer in scope or will otherwise never be worked on.
  • Rules
    • Rules can be used to change the behavior of an entity including default values, list of values, and validation.  They are described in more detail in the Rules section below.
  • FieldColorMappings
    • Field color mappings are used in a number of places in the UI to highlight certain values.
    • These mappings are most often used with fields that also use an allowed values list such as the severity field on bugs.
    • Use the FieldName attribute to specify the field to apply the color mapping to.
    • Use a <ValueToColorMapping> element with Color and Value attributes to choose a color for a specific value.
    • Colors should be specfied using a six digit hexadecimal code preceded by the # sign (i.e. #FF9900).
  • SeverityValueToPrioritizationPrefixMappings
    • These mappings are used to calculate the default sequence number that will be set when marking a bug as triaged or marking an issue or risk as assessed.
    • If the list of allowed values for the severity field for bugs, issues, or risks is changed, these mappings will also need to be changed.
    • The lower the prefix, the higher (more important) the default sequence number will be.

 

Rules

This section describes the rules available to entities in TeamPulse.

 

Required Rule

  • A field can be marked as required to ensure that it always has a value.
  • Use the FieldName attribute to specify which field to apply this rule to.
  • Example:
    <Rule xsi:type="RequiredRule" IsActive="true" IsValidationRule="true" FieldName="Name" />

 

Default Value Rule

  • A field can be given a default value using a default value rule.
  • Use the FieldName attribute to specify which field to apply the default value to.
  • Use the DefaultValue attribute to specify the default value.
  • Example:
       
    <Rule xsi:type="DefaultValueRule" IsActive="true" IsValidationRule="false" FieldName="Type" DefaultValue="Feedback" />

 

Allowed Values Rule

  • A field can be restricted to a specific list of values by using an allowed values rule.
  • Use the FieldName attribute to specify which field the list of values is for.
  • Use the AllowNull attribute to specify whether or not the field can be empty.
  • Use a child element named <AllowedValues> to specify the actual list of values.
  • Example:
    <Rule xsi:type="AllowedValuesRule" IsActive="true" IsValidationRule="true" FieldName="Type" AllowNull="false">
      <AllowedValues>
        <string>Idea</string>
        <string>Feedback</string>
        <string>Feature Request</string>
      </AllowedValues>
    </Rule>

 

Match Rule

  • A field can be validated against a regular expression by using a match rule.
  • Use the FieldName attribute to specify which field to validate using this rule.
  • Use the Pattern attribute to specify the regular expression to use.
  • Use the Description attribute to provide some text for the validation message in the event the data entered by the user does not match the pattern.
  • Example:
    <Rule xsi:type="MatchRule" IsActive="true" Pattern="^\d*$" Description="an integer value representing the percentage estimated likelihood that the risk will occur." FieldName="Probability" />

     

The following table presents a list of which rules are supported by each field in each TeamPulse entity.

Story

Field Name Display Name

Required
Rule

Default
Value Rule

Allowed
Values Rule
Match
Rule
Name Name X X    
Description Description X X    
AssignedTo Assigned To X      
Points Estimate X X X X
Complexity Complexity X X X X
Maturity Maturity X X X X
Certainty Certainty X X X X
PriorityID Priority X X X X
PriorityClassification Priority Class. X X X X
ValueClassification Value Class. X X X

X

 

 

Task

Field Name Display Name

Required
Rule

Default
Value Rule

Allowed
Values Rule
Match
Rule
Name Name X X    
Description Description X X    
AssignedTo Assigned To X      
WorkRemaining Work Remaining X X X X
WorkCompleted Work Completed X X X X
EstimateOptimistic Optimistic Estimate X X
EstimateProbable Probable Estimate X X
EstimatePessimistic Pessimistic Estimate X X    

 

 

Bug

Field Name Display Name

Required
Rule

Default
Value Rule

Allowed
Values Rule
Match
Rule
Name Name X X    
DescriptionPlainText Description X X    
AssignedTo Assigned To X      
Severity Severity X X X X
Estimate Estimate X X X X
Priority Priority X X X X
IsTriaged Triaged X X
IsBlocking Blocking X X    
StepsToReproducePlainText Steps to Reproduce X X    
ResolutionPlainText Resolution X X    

 

 

Risk

Field Name Display Name

Required
Rule

Default
Value Rule

Allowed
Values Rule
Match
Rule
Name Name X X    
DescriptionPlainText Description X X    
AssignedTo Assigned To X      
Severity Severity X X X X
Estimate Estimate X X X X
Priority Priority X X X X
IsTriaged Triaged X X
IsBlocking Blocking X X    
ResolutionPlainText Resolution X X    

 

 

Issue

Field Name Display Name

Required
Rule

Default
Value Rule

Allowed
Values Rule
Match
Rule
Name Name X X    
DescriptionPlainText Description X X    
AssignedTo Assigned To X      
Severity Severity X X X X
Estimate Estimate X X X X
Priority Priority X X X X
IsTriaged Triaged X X
IsBlocking Blocking X X    
ResolutionPlainText Resolution X X    
BenefitPlainText Benefit X X    

 

 

Feedback

Field Name Display Name

Required
Rule

Default
Value Rule

Allowed
Values Rule
Match
Rule
Name Name X X    
Type Type X X X X
Description Description X X    
AssignedTo Assigned To X      
Source Source X X X X
Size Size X X X X