Recently we released WordToTFS 5.1. This update is a mix of features and bugfixes. This post gives a brief description of the changes.
Work Item Links – Support for HTML Fields
Whenever a user wants to show links between Work Items in Word, she can define an appropriate links section in the WordToTFS template as already described in section Defining link mappings (p.33) in the WordToTFS User Guide. However, this worked well only with fields (see LinkFormat in the following screenshot of a sample configuration) of simple data types (string, number).
Now the user can also reference HTML-fields in that links section. Since this can only be a preview of the linked work item, WordToTFS removes any HTML based formatting and also embedded images to improve readability in the links area.
Test Specification / Test Result Reports
The list of test plans in Test Spec and Test Result Reports is now ordered by name, which makes the list much more usable.
Furthermore the Test Spec by Query now supports usage of Shared Steps work item types.
The WorkItemViewerLink element of the Test Spec and Test Result Reports configuration now supports formatting of links. Therefore the new Format attribute has been introduced at the WorkItemViewerLink tag in the WordToTFS configuration as shown in the following sample configuration.
This enables the user to specify formatting with the WorkItemViewerLink similar to the Link-tags described at the beginning of this post.
We now support multiple naming of test suites within test plans. Since the name of a test suite does not need to be unique in the scope of a test plan, specifying the test suite to be reported is not sufficient. In addition to specifying the name of a test suite, the “path” can be used as well. Test suites can now be selected via a path to identify a certain test suite. This is done in the format “TestPlan1RootSuite/SubSuite1/SubSub2” (see also section Identify test suite selection by tree path on page 43 in the WordToTFS User Guide).
Console Extension
Auto update for WordToTFS templates is now also being used by Console Extension. As soon as there is a new version of the used WordToTFS template at the specified template location, WordToTFS refreshes the local template cache even when called via command line interface.
WordToTFS Templates
The default WordToTFS templates got a face lift to achieve a modern layout. Furthmore the default work item type colors of Epic, Feaure, Product Backlog Item and Bug work item types are now used in Word as well. This makes it easier getting an overview of a specification at a glance.
Bugfixes
Beyond the new features there are a log of bugfixes within that release:
- Fixed bug that shrinks images when getting and publishing work items.
- Fixed bug that throws a COMException when the addon activated and started from command line in some cases.
- Fixed bug that the command line uses the wrong server connection on loading of an existing document.
- Fixed bug that the command line ignores the specified dotx-template.
- Fixed bug with formatting lines in description field. Depending on the formatting of the content an exception was thrown on publish.
- Fixed bug with reading the latest test results. In some cases when several test runs started parallel and ended in another order than they have been started, WordToTFS interpreted another test result as “latest” than MTM does.
- Fixed bug that throws an OutOfRangeException when getting work items.
- Fixed bug in Test Result Report that created an exception while reading Shared Steps results of automated tests.
- Fixed bug that Test Reports raised FileNotFound Exception when template location contains subdirectories.
- Fixed minor error descriptions.
- Fixed minor bugs in documentation.
Install the Update
It’s worth to mention that we terminated development on WordToTFS 4.*. We highly recommend users that have still installed WordToTFS 4.* to uninstall that version and download version 5.1 from https://aitgmbh.de/wordtotfs. Users having WordToTFS 5.0 already installed, can either wait a few days for the auto-update mechanism or enforce the update mechanism manually by using the update button in the WordToTFS ribbon (see the next screenshot).
We’re proud to improve the tool continuously, which would be impossible without the support and valuable feedback of our customers. Thanks for that!
Zunächst mal: Große Klasse – vielen Dank für das Tool.
Leider mag es mir auch nach dem Update auf 5.1 nicht gelingen, mehr als 2 Level in Word zum importieren (also keine Requirements unter den Features, obwohl GetDirectLinksOnly=”false” gesetzt ist). Das gilt sowohl für Word 2010 als auch 2016. Verwendet wird TFS 2015 (Update 2) und CMMI.
Mach ich was Grundlegendes falsch?
Hallo Olli,
zunächst mal DANKE fürs Feedback.
Könntest du uns bitte die genauen Repro-Steps liefern? Insbesondere ist für uns wichtig zu wissen, wie du den Import durchführst, z.B. ob und wenn ja welche Work Item Query du verwendest. Im Falle einer Query wäre es noch hilfreich, einen Screenshot oder einen Excel-Export der Query-Ergebnisse zu sehen.
Welches WordToTFS Template kommt dabei zum Einsatz? Eines der mitgelieferten oder ein eigens angepasstes.
Desweiteren möchte ich dich bitten, auch dein erwartetes Ergebnis kurz zu beschreiben, also wie sollte sich WordToTFS nach den gegebenen Repro Steps aus deiner Sicht verhalten.
Beste Grüße
Thomas
Hallo Thomas,
vielen Dank für Dein Feedback!
Gerne schicke ich Details – da hier aber in den Screenshots einige Produktivdaten zu sehen wären, sende ich Dir gleich eine entsprechende Mail. Hoffe, das ist ok?
Beste Grüße
Olli
Hallo Olli,
schön, dass wir dir in der E-Mail-Diskussion helfen konnten.
Hier nochmal die Zusammenfassung öffentlich.
Ihr setzt einen deutschen TFS ein. Dabei heißt der Work Item Type “Requirement” entsprechend “Anforderung”.
Im WordToTFS-Template (w2t-Datei) muss das Mapping entsprechend geändert werden. Wenn das Mapping auf einen Work Item Typen nicht vorhanden ist, dann werden die gefundenen Work Items auch nicht in Word angezeigt – auch nicht rechts in der Get Work Items Pane. Das “fehlende” Mapping auf den Work Item Typen “Anforderung” hat sorgt also dafür, dass die Work Items dieses Typen nicht nach Word übernommen werden.
Nach Anpassung des Mappings in der w2t-Datei läuft es einwandfrei.
Zur Anpassung des Templates siehe auch in der WordToTFS-Dokumentation (http://wordtotfs.aitag.com/2015/Download/AIT%20WordToTFS%20User%20Guide.pdf) auf Seite 28 im Kapitel “Creating a new work item mapping”.
Gruß
Thomas
Hallo Thomas,
auch an dieser Stelle nochmals ganz herzlichen Dank für Deine Hilfestellung!
Jetzt kann ich mit WordToTFS das tun, was ich vorhatte …
Grüße
Olli
Hallo
Bin gerade ein wenig mit dem WordToTFS V5.1 Plug-in beschäftigt. Grundsätzlich, Hut ab, ist nun das 3. Plug-In das ich durchprobiere und das einzige das wirklich funktioniert!
Was ich nicht hinbekomme ist folgendes:
Template: CMMI(2015).w2t
1. Ich importiere aus TFS 2015 nach Word ein Feature (Titel “Test 123”) mit 5 Child-Requirements
-> Klappt, alle 5 vorhanden
2. Ich gehe an den Schluss des Dokumentes (Ctrl + End)
3. Ich füge ein neues Requirement in Word über den RibbonButton “New Work Item” ein
4. Fülle alles aus
5. Ich klicke auf den Button “Publish selected”
6. Das Requirement wurde nach TFS übertragen
-> Das Feature hat weiterhin noch 5 Requirements
-> Das übertragene Requirement ist im Backlog ohne Parent
-> Es wurde nicht an das Feature “Test 123” als Child angehängt
Wie kann man das in den w2t Dateien beschreiben? Das MSFForCMMIHierarchyExample(2013).w2t gibt irgendwie auch keinen Aufschluss darüber.
Für eine kleine Hilfestellung wäre ich dankbar.
Mit freundlichen Grüssen
Hallo L,
danke für die Blumen :).
Wenn ich das richtig verstehe, möchtest du, dass eine Parent-Child-Beziehung aufgrund der Position des Work Items im Dokument automatisch entsteht. Dies ist bislang so nicht vorgesehen. Wenn man, wie in deinem Falle, eine Menge an Work Items per Work Item Query in das Word-Dokument exportiert, dann kann man ja nicht automatisch ein weiteres Work Item als Child-Element eines vorangegangenen Work Items interpretieren.
Um kurzfristig dein Ziel zu erreichen, schlage ich folgendes vor. In der Word-Vorlage des Requirements könntest du eine neue Zelle einfügen, in der manuell in Word die Parent-ID eingetragen wird. Im w2t-File muss dann noch bei der Definition des Requirements das Feld entsprechend mit einem Link verknüpft werden. Dazu gibt die Dokumentation ab Seite 33 im Kapitel “Defining link mappings” mehr Aufschluss.
Im Ergebnis würde sich in deiner Ablaufbeschreibung zwischen Schritt 4 und 5 folgendes abspielen: “Trage die ID des Features, welches das Parent Work Item werden soll, in die entsprechende Zelle des soeben ausgefüllten Requirements ein.”
Alternativ können wir auch über die Implementierung der gewünschten automatischen Erkennung sprechen. Dies muss aber dann sehr gut konfigurierbar sein, um es generisch einsetzbar zu halten. Falls diesbezüglich Interesse besteht, können wir gerne einen (Telefon-)termin vereinbaren.
Wenn du Hilfe bei der Konfiguration benötigst, bitte ebenfalls bei uns melden.
Ansonsten würde mich noch interessieren, für welche Szenarien ihr WordToTFS einsetzt.
Ich hoffe, ich konnte helfen.
Beste Grüße
Thomas
Hallo Thomas
Die Sache mit dem Link-Mapping und dem Parent hat einwandfrei geklappt. War aus der Doku auf Anhieb nicht ganz so schlau geworden, da es ja mehrere Mapping-Möglichkeiten gibt (Auflistung, Felder, etc.). Jedoch mit Deinem Hinweis hat’s geklappt.
Vielen Dank! Das genügt auch schon mal vorerst.
Wegen dem Szenario: Wir möchten TFS für das Requirements-Management verwenden. Grundsätzlich möchten wir so arbeiten, dass jeweils ein Feature erstellt wird, dass dann n Requierements beinhaltet. Das Feature ist dann jeweils das Objekt, dass “gepflegt” wird. Inhouse von einem Teilprojekt-Leiter und Extern ebenfalls von Projektleitern.
Es gibt zwei Anwendungsszenarien:
1. Intern: Da sich bekanntlich Menschen mit neuen Technologien manchmal schwertun, möchten wir die Möglichkeit geben, strukturierte Anforderungen auch über Word bei den Application-Owner einzureichen. In einem ersten Schritt würde ein grobes Konstrukt aus Anforderungen und Feature (Überschriften) im TFS erfasst werden und die Inhalte sollen dann im Word ergänzt werden. Danach das Word in das TFS übertragen. Hier kann es sein, dass während dem spezifizieren natürlich noch weitere Anforderungen dazu kommen. Deshalb die Anfrage, wie man WorkItems mit übergeordneten WIT’s verknüpfen kann.
2. Extern: Nachdem alles spezifiziert wurde, müssen die Anforderungen an unseren externen Dienstleister weitergereicht werden. Da diese eigene Systeme einsetzen, kann es sein, dass nicht alle in unserem TFS “weiter arbeiten”. Dazu möchten wir alle Anforderungen innerhalb einer Iteration exportieren und pro Feature (da beim Dienstleister dazu wiederum ein Teil-Projektleiter verantwortlich ist), mit allen dazugehörigen Requirements, ein Word-Dokument erstellen und versenden.
Euer Plug-In gibt genau diese Möglichkeiten.
Gruss
Hallo L,
das freut uns zu hören.
Viel Erfolg noch weiterhin beim Einsatz von WordToTFS!
Beste Grüße
Thomas