In this video demo, Philip Newman and Christopher Brotsos from the InfoPath program management team show how you can use Team Foundation Server (TFS) to manage source control for your InfoPath forms with code.
Team Foundation Server (TFS) is an effective repository and source control program for your InfoPath solutions. Teams add InfoPath forms and their related Visual Studio Tools for Applications (VSTA) projects to TFS, and then proceed to collaborate on the overall solution. Form designers focus on adding controls, rules, and layouts to their local copy of a form while developers add C# or Visual Basic .NET code to their local copy of a form code project. Then, by using the TFS visual tooling environment, designers and developers can easily merge their changes together into a complete InfoPath solution.
There are, however, some best-practices that you should, and in some cases must, implement in order to be successful.
Setting up your environment
Configure a portable local workspace
If your team plans to collaborate on an InfoPath solution, ensure all contributors work within a directory that everybody in the team can access via the same path. For example, use a common mapped drive, a UNC path, or as in the video, a local path that can be the same for all users of the project. In the video, we specifically used:
- %Root Directory% – C:InfoPath Projects
- %Project Directory% – %Root Directory%<ProjectName>
- %XSN Components Directory% – %Project Directory%XSN Files
- %VSTA Project Directory% – %Project Directory%XSN Sources
InfoPath’s default root directories, for XSNs and VSTA projects, fall under %USERPROFILE%. Because the %USERPROFILE% directory has a different name for each user, it will not be accessible through a common path for all those contributing to the project.
Work with the form template component files and not the XSN
When you collaborate on an InfoPath solution, you should work with the XSN component files themselves, and not the XSN. When you add a control, rule, or new attribute to a form it is common for more than one component file in the XSN to be updated. If you work with the XSN, and not the component files, the template will be treated as a binary object. Most source control programs do not let you diff and merge changes to binary objects, and without this granular view/control of the XSN, you will not be able to successfully collaborate with your teammates.
To work with the XSN component files, setup the local workspace and save/export the files as follows:
Starting a new project
- After selecting the template from the New tab in the Backstage, immediately export the XSN component files
- Choose Export Source Files from the Publish tab in the Backstage.
- Specify the %XSN Components Directory% as previously described and export.
- Set the VSTA project path
- Choose Form Options from the Info tab in the Backstage.
- Select the Programming category from the Form Options dialog, and set the %VSTA Project Directory%, as previously described, in the Project location text box.
- From now on, work with the component files instead of the XSN. To do this, open the XSF in the InfoPath Designer instead of the XSN.
Committing an existing project
It’s likely that your existing project is not already configured according to the requirements. So, make a backup of said project(s), and then change the configuration to support a shared design environment.
- Move the copy of the XSN to %Project Directory%.
- Move the copy of the VSTA project files to %VSTA Project Directory%. Note: do not copy over the current VSTA project root folder.
- Open the XSN in design mode.
- Export the XSN component files
- Choose Export Source Files from the Publish tab in the Backstage
- Specify the %XSN Components Directory% and export.
- Change the VSTA project path
- Choose Form Options from the Info tab in the Backstage.
- Select the Programming category from the Form Options dialog, and set the %VSTA Project Directory% in the Project location text box.
- Save your changes and from now on, work with the component files instead of the XSN. To do this, open the XSF in the InfoPath Designer instead of the XSN.
Read-only file properties, TFS, and InfoPath
Before Philip and I opened the XSF in design mode, you saw us remove the read-only property from the %Project Directory% instead of executing a check-out in TFS to remove the TFS file lock. Executing a check-out in TFS is not best-practice when working with an InfoPath project because InfoPath 2010 needs access to all of the component files during design mode. Likewise, you also saw Philip execute an atomic check-out/check-in before he updated the repository with the date field and validation rule he added. TFS won’t let you check-in until you check-out, so the two commands should be executed in sequence in order to successfully check-in updated files. (Note: I didn’t check my code into TFS in the video, but if I had, I would also have executed a check-out followed immediately by a check-in).
Configure TFS to check-in your DLLs and PDBs. In a standard Visual Studio project, this isn’t necessary because DLLs and PDBs can be built dynamically at build-time. InfoPath also generates DLLs and PDBs dynamically, but it also lists said files in the template manifest. As such, if the DLLs and PDBs aren’t in the %XSN Components Directory% then the Designer will fail to open with a schema validation error.
Multiple developers and designers working on a form
Avoiding conflicts with the schema, control properties, and the layout of a form can be managed by maintaining the following best practices in your team:
- Do not have more than one designer adding controls or modifying the layout of the form simultaneously.
- Do not have more than one designer adding rules to the form simultaneously.
- All controls and fields added to a form should be given a unique name.
Apache SVN works equally as well for collaborating on InfoPath form templates and their related VSTA projects. If the guidelines in this post are followed, your team can use SVN as a repository and source control management solution in the same way as Visual Studio Team Foundation Server. Each version control solution has its own benefits and caveats though, and you should evaluate each to determine which solution works best for your team. As an example: SVN doesn’t apply file locks to local copies of projects; its check-in/check-out paradigm differs from TFS. So, your team may find the file management aspects of SVN more intuitive and efficient. On the other hand, you will likely conclude that the CLI is the best choice for managing your project with SVN, and as such, you will lose the graphical/auto merge feature. Again, experiment, evaluate, and choose the solution which works best for your team.
InfoPath makes designing forms easy, and it provides you with a managed object model and access to the .NET Framework. This programmability support is available so that you can extend your forms into a variety of scenarios on the client and SharePoint. As your projects grow in size and complexity, you will find that using a managed repository is a quick and effective way for sharing solution amongst multiple developers and designers.