Word Excel add in Dev Environment Setup - quality-manager/onboarding GitHub Wiki

Development Environment Setup

Visual Studio Variants

Current development environment is using different version of Visual Studio as described below

  • Microsoft Visual Studio 2005 : Development for Office v32-bit support
  • Microsoft Visual Studio 2010 : Development for Office v64-bit support
  • Microsoft Visual Studio 2010 : Unit test run
  • Microsoft Visual Studio 2012 : Development for Office v32/64-bit support support with .Net 45 support

License and Installation

  • Ensure you are having administrative permission on your development machine; this is required for registering add-in during development test.
  • Obtain MSDN and MS Office license.
  • Install Microsoft Visual Studio 2005 Professional Edition with service pack 1 (or latest available)
  • Install Microsoft Visual Studio 2010 Professional Edition and Microsoft Office Developer Tools for Visual Studio 2010
  • Install Microsoft Visual Studio 2010 Professional Edition with Update 4 (or latest available), Microsoft Office Developer Tools for Visual Studio 2012, Windows Installer XML Toolset version 3.10.3.3007 and .Net framework 4.5 or latest.
  • Install MS Office 32-bit and 64-bit variant on your development machine.

Configuration management

  • You can install RTC plug-in for Microsoft Visual Studio or copy source code to separate folder as your working copy.
  • Visual studio generates many intermediate user specific files which should not be checked-in to the repository.
  • Having separate working folder allows you to isolate unwanted file by using source code comparison tool (Beyond Compare).

Source code

  • Entire source code can be categorized into three components, Excel Add-in code, Word Add-in code and common class library.
  • Mso2Rqm_Common : This project is a collection of commonly used classes for parsing the configuration file, REST connector for RQM and RM, authentication implementation, artifact creation factories, common UI and other common utility classes.
  • RQMExcelImporter : This project contains implementation specific to Excel Add-in.
  • RQMExcelImporterSetup : This project contains installer for Excel Add-in.
  • RQMWordImporter : This project contains implementation specific to Word Add-in.
  • RQMWordImporterSetup : This project contains installer for Excel Add-in.
  • When project name is decorated with x64, it is implementation related to 64-bit support

Add-in installation and debug

Microsoft Visual Studio 2005

  • Open Word-Excel Migration Client\com.ibm.rational.mso2rqm\mso2rqm.sln.
  • Switch solution configuration to debug.
  • Delete 'Mso2Rqm_Common.dll' and 'RQMExcelImporter.dll' from tree view of RQMExcelImporterSetup project and RQMWordImporterSetup project (it points to the release version of these assemblies).
  • Build Solution (F7). (All 5 project will build without any error)
  • Open RQMExcelImporter properties window and switch to debug tab. click on Start external program and specify 32-bit instance of MS Excel (i.e C:\Program Files (x86)\Microsoft Office\Office12\EXCEL.EXE), this path varies based on the version of MS Office installed on your machine.
  • Click on 'Start Debugging' (F5), it will launch Excel with Add-in enabled in menu item.
  • Open RQMWordImporter properties window and switch to debug tab. click on Start external program and specify 32-bit instance of MS Word (i.e C:\Program Files (x86)\Microsoft Office\Office12\WINWORD.EXE), this path varies based on the version of MS Office installed on your machine.
  • Click on 'Start Debugging' (F5), it will launch Word with Add-in enabled in menu item.

Personal build

  • After every check-in you need to ensure your personal build is GREEN before sending for the review.
  • On Eclipse IDE, go to Build view, click on Configure button to add build definition related to WordExcel add-in. These definitions are 'TMWE Mainline Stable', 'TMWEx64 Mainline Stable', 'TMWENet45 Mainline Stable'.

Updating Wiki