Features

All TeamCompanion features documented with detailed description, images and videos.

Configuring TeamCompanion Options

The behavior of many TeamCompanion's features can additionally be customized using the Options dialog. To access it, on the TeamCompanion tab, in the General group, click on the Options button.
Next, the TeamCompanion Option dialog opens. It consists of multiple tabs for customizing various parts of the application.

Configuring TeamCompanion's options

Servers Options

The Servers tab on the TeamCompanion’s options dialog gives you an overview of all your connections to different Team Foundation Servers in one place and allows you to manage them in different ways. The tab shows a tree list of all active connections to Team Foundation Servers and their corresponding team projects.

Here you can add new connections to Team Foundation Servers or remove existing connections, as well as add and remove team projects.
Each of these actions is also available in different parts of the user interface while managing your connections to Team Foundation Servers and team projects.

Manage connections to Team Foundation Servers and team projects on the Servers Tab in TeamCompanion's Options
Manage connections to Team Foundation Servers in TeamCompanion's Options

In order to connect to a Team Foundation Server, click on the Connect… button. Next, the Connect to Team Foundation Server dialog opens. Further steps are described under Connecting to Team Foundation Server.

Manage connections to Team Projects in TeamCompanion's Options

In order to connect to a team project, in the tree list click on project collection that hosts the team project you want to add and click on the Add projects… button. Next, the Connect to Team Foundation Server dialog opens. Further steps are described under Connecting to a Team Project.

To remove a Team Foundation Server connection, click on it in the tree list and click on the Remove servers button. To remove a team project connection, click on it in the tree list and click on the Remove project button.

General Options

The General tab on the TeamCompanion’s options dialog contains a list of special settings that determine how TeamCompanion handles many special actions and features. Follow the instruction on the dialog to correctly set these options.

Manage general settings on the General Tab in TeamCompanion's Options

Work Item Preview Options

The Work Item Preview tab on the TeamCompanion’s options dialog allows you to define specific preferences about how your work items are previewed inside TeamCompanion. You can manage following settings:
- Remove empty fields from Work Item preview;
- Always display Read-Only (HTML) Work Item preview;
- Append Work Item history to the Work Item preview and define the Number of revisions to be displayed in the Work Item history.

Manage work item preview settings on the Work Item Preview Tab in TeamCompanion's Options

When TeamCompanion is online, work items are by default shown in the embedded work item form while you browse through a work item query result lists. If you want to display their HTML work item preview instead, check the option Always display Read-Only (HTML) Work Item preview.

Tipp: While working in offline mode, work items can be shown only in HTML preview.

Send Mail Options

The Send Mail tab on the TeamCompanion’s options dialog controls how you create emails form your work items. Here you define mappings between work item fields and email fields.

Manage mapping between work items and emails on the Send Mail Tab in TeamCompanion's Options
Custom template for new email subject using work item field values

The New e-mail subject field defines the template used for formatting the subject of new emails. To add one or more fields to this template, click the Add Field button and select the field to add. This field is treated as plain text. The template can contain other words and symbols as well.
Note: This setting is not used when sending a list of work items per mail.

Work item HTML preview used as email body

When the checkbox Use Work Item Html preview as Email body is checked, the email body contains the standard work item HTML preview. This is the default setting. In this case the checkbox Use HTML markup in body is disabled.

Custom template for new email body using work item field values

When the checkbox Use Work Item Html preview as Email body is unchecked, the email body is formatted according to the template defined in the New e-mail body. In this case, the template can contain special placeholders used to insert work item field values (for example {System.Title}), which are expanded in the mail body. To add one or more fields, click the Add Field button and select the fields from the list.

Custom template for new email body using work item field values formatted as plain text

The formatting of the email body in this case depends on the checkbox Use HTML markup in body.
If this checkbox is unchecked, no additional HTML markup can be used in the template. The email body will be encoded as plain text. Line breaks will be used as entered in the New e-mail body field.

Custom template for new email body using work item field values with rich HTML markup format

If the checkbox Use HTML markup in body is checked, you can use standard HTML markup to add rich formatting to the template. This requires adding markup for line breaks as a minimum (if you do not use any markup at all, the text will be plain and with no line breaks). Already by using some basic HTML markup, like text formatting, paragraphs or tables, you can achieve well formatted emails. The email body will be encoded as HTML.

The HTMl code used for this formatting is:

<table border="0" cellpadding="2" cellspacing="5" style="font-family: Calibri">
  <tr>
    <td><b>Title:</b></td>
    <td>{System.Title}</td>
  </tr>
  <tr>
    <td><b>Assigned To:</b></td>
    <td>{System.AssignedTo}</td>
  </tr>

  <tr>
    <td><b>Created By: </b></td>
    <td>{System.CreatedBy}</td>
  </tr>
  <tr>
    <td><b>Description:</b></td>
    <td>{System.Description}</td>
  </tr>
  <tr>
    <td><b>Web Access:</b></td>
    <td>{TeamCompanion.WorkItemUrl}</td>
  </tr>
</table>

Tipp: In this case the special work item mapping field {TeamCompanion.WorkItemUrl} (available in the list of fields) can be used and it will expand to the corresponding work item preview hyperlink in Web Access.

Default template for sending multiple work items per mail

The checkbox Generate Work Item table for multiple Work Items, checked by default, is used when sending multiple work items per email. When this checkbox is checked and multiple work items are selected (at least two), only one email will be created with a table containing work item information listed in columns.
Tipp: The generated email always uses the predefined subject Multiple Work items.

Custom template for sending multiple work items per mail – one email sent per work item

When the checkbox Generate Work Item table for multiple Work Items is unchecked and multiple work items are selected, one email will be created for each selected work item.

Default setting while sending multiple work items per mail formats work item IDs as Web Access links

The checkbox Make the Work Item's Id field a link to Work Item's preview web page, checked also by default, is active when multiple work items are sent as a table. It defines whether work item IDs in the email body are formatted as links to their Web Access work item previews or not.

Create Work Item from Mail Options

The Create WI from Mail tab on the TeamCompanion’s options dialog controls how you create new work items from emails. Here you define mappings between email and work item fields.

To define the default work item type offered on the dialog while creating a new work item from an email, select the desired type from the Default Work Item type drop down menu.

The table contains the list of mappings between email fields and work item fields.

Manage mappings between email and work item fields on the Create WI from Mail Tab in TeamCompanion's Options
Define new mapping between email and work item fields used while creating work items from emails

Each mapping is defined using the Field Name and Field Value edit boxes in the Mappings group at the bottom of this tab. First click on the button right to the Field Name edit box and choose a work item field from the drop down menu. Then click on the button right to the Field Value edit box and choose an email field from the drop down menu. Both edit boxes are editable, meaning that you can type in field names as well.

To add this mapping to the table, click on the + button. To edit an existing mapping, first click on it in the table, and then edit it in the Mappings group. To remove a mapping, click on it in the table and then click on the x button under the table.

Example of a commonly used mapping between email and work item fields

This example shows the most common usage of mappings between email and work item fields. Subject is copied to Title, body to Description and the recipient name is used for the Assigned To field.

The checkbox Add note in description informing about the attachments controls whether an additional note is added at the top of the work item Description field in case you choose to attach the original email or its attachments to the work item.

Create Outlook Task Options

The Create Task tab on the TeamCompanion’s options dialog controls how you create Outlook tasks form your work items. Here you define mappings between work item fields and task fields.

Manage mapping between work items and Outlook tasks on the Create Task Tab in TeamCompanion's Options
Custom template for new task subject and body using work item field values

The New task subject field defines the template used for formatting the subject of new tasks. To add one or more fields to this template, click the Add Field button and select the field to add. This field is treated as plain text. The template can contain other words and symbols as well.

The task body is formatted according to the template defined in the New task body. The template can contain special placeholders used to insert work item field values (for example {System.Title}), which are expanded in the task body. To add one or more fields, click the Add Field button and select the fields from the list. Line breaks will be used as entered in the template. No additional HTML markup can be used.

Define mappings for new task start and end dates

The edit boxes Start date and End date define the work item fields used for the task start and end dates respectively. Click on the button right of these fields to choose a work item field from the drop down menu. Only fields of type Date are available in the list.

Create Work Item from Task Options

The Create WI from Task tab on the TeamCompanion’s options dialog controls how you create new work items from Outlook tasks. Here you define mappings between task and work item fields.

To define the default work item type offered on the dialog while creating a new work item from an Outlook task, select the desired type from the Default Work Item type drop down menu.

The table contains the list of mappings between task fields and work item fields.

Manage mappings between Outlook task and work item fields on the Create WI from Task Tab in TeamCompanion's Options
Define new mapping between Outlook task and work item fields used while creating work items from tasks

Each mapping is defined using the Field Name and Field Value edit boxes in the Mappings group at the bottom of this tab. First click on the button right to the Field Name edit box and choose a work item field from the drop down menu. Then click on the button right to the Field Value edit box and choose an email field from the drop down menu. Both edit boxes are editable, meaning that you can type in field names as well.

To add this mapping to the table, click on the + button. To edit an existing mapping, first click on it in the table, and then edit it in the Mappings group. To remove a mapping, click on it in the table and then click on the x button under the table.

Example of a commonly used mappings between Outlook task and work item fields

This example shows the most common usage of mappings between Outlook task and work item fields. Subject is copied to Title and body to Description.

Create Meeting Request Options

The Create Meeting Request tab on the TeamCompanion’s options dialog controls how you create Outlook meeting requests form your work items. Here you define mappings between work item fields and meeting request fields.

Manage mapping between work items and Outlook meeting requests on the Create Meeting Request Tab in TeamCompanion's Options
Custom template for new meeting request subject and body using work item field values

The New meeting request subject field defines the template used for formatting the subject of new meeting requests. To add one or more fields to this template, click the Add Field button and select the field to add. This field is treated as plain text. The template can contain other words and symbols as well.

The meeting request body is formatted according to the template defined in the New meeting request body. The template can contain special placeholders used to insert work item field values (for example {System.Title}), which are expanded in the meeting request body. To add one or more fields, click the Add Field button and select the fields from the list. Line breaks will be used as entered in the template. No additional HTML markup can be used.

Define mappings for Meeting request start and end dates

The edit boxes Meeting request start date and Meeting request end date define the work item fields used for the meeting request start and end dates respectively. Click on the button right of these fields to choose a work item field from the drop down menu. Only fields of type Date are available in the list.

Synchronization modes between meeting requests created from work items and originating work items

The Default synchronization mode drop down defines how a work item is updated with changes made to the meeting request created originally from it. The available options are:


- None - No mapping is used;
- Subject, start date and end date, Body, start date and end date, Start and end date only - Chosen fields are updated;
- All fields mapped to single work item fields - When meeting request fields are mapped to more WI fields, those fields are not updated.

Create Work Item from RSS Options

The Create WI from RSS tab on the TeamCompanion’s options dialog controls how you create new work items from RSS feed posts. Here you define mappings between post and work item fields.

To define the default work item type offered on the dialog while creating a new work item from post, select the desired type from the Default Work Item type drop down menu.

The table contains the list of mappings between post fields and work item fields.

Manage mappings between RSS post and work item fields on the Create WI from RSS Tab in TeamCompanion's Options
Define new mapping between RSS post and work item fields used while creating work items from posts

Each mapping is defined using the Field Name and Field Value edit boxes in the Mappings group at the bottom of this tab. First click on the button right to the Field Name edit box and choose a work item field from the drop down menu. Then click on the button right to the Field Value edit box and choose an post field from the drop down menu. Both edit boxes are editable, meaning that you can type in field names as well.

To add this mapping to the table, click on the + button. To edit an existing mapping, first click on it in the table, and then edit it in the Mappings group. To remove a mapping, click on it in the table and then click on the x button under the table.

Example of a commonly used mapping between post and work item fields

This example shows the most common usage of mappings between post and work item fields. Subject is copied to Title and body to Description.

Reports Options

The Reports tab on the TeamCompanion’s options dialog allows you to define the default action when sending TFS reports per email and creating related Outlook meeting requests or tasks from TFS reports.

Manage default actions when creating mails or Outlook meeting requests/tasks from TFS reports on the Reports Tab in TeamCompanion's Options
Available actions for creating mails or Outlook meeting requests/tasks from TFS reports

The Default create mail action drop down offers you to either embed the report in the email message body as HTML or image or attach the report in various formats (MHT, PNG, JPG, TIFF, PDF, etc.).
The Default create meeting request action and Default create task action drop downs offer you to attach the report in various formats.

Search Related Mails Options

The Search related Mails tab on the TeamCompanion’s options dialog allows you to set up additional target search mail folders that will be used while searching mails related to work items either by work item ID or by title.

By default, all mail folders are searched for mails containing the selected search criteria. Other custom target folders can be added to the list by clicking on the Add folder button and choosing from the tree list of available Outlook folders.

Manage target search folders while searching mails either by work item ID or by title on the Search related Mails Tab in TeamCompanion's Options
Target folders available in drop downs of search mails related actions on the embedded work item form

Target folders from the list will be available in the drop down of corresponding actions Search Mails by ID and Search Mails by Title on the embedded work item form.

License Info

The License Info tab on the TeamCompanion’s options dialog allows you to manage your TeamCompanion license.

Manage the TeamCompanion license on the License Info Tab in TeamCompanion's Options
Activate TeamCompanion

To activate TeamCompanion, click the Activate TeamCompanion button. For further information about the activation process and licensing see under Trial Period and Licencing.
You can deactivate an activated TeamCompanion copy by clicking on the Deactivate current License button.
The full license agreement is available by clicking on the License Agreement button.

A click on the Ordering Info button will take you to the corresponding page on the TeamCompanion web site.