| Prerequisite | Version |
|---|---|
| Team Foundation Server | Microsoft Visual Studio 2005 Team Foundation Server |
| Visual Studio | Visual Studio 2005 |
1. Add-in installation
The installer is provided as an msi file and has no installation options.The AddIn file is deployed to the C:\Documents and Settings\All Users\Application Data\Microsoft\MSEnvShared\AddIns
2. Setting up the environment for developers
This step requires you to have a DB Professional project (i.e. a .dbproj file) in place. For developers you need to create a "mirror" of this project that they will be able to open and work with.2.1 Create a "mirror" of the DB Professional project file*
The structure of the .csproj and .dbproj files are the same. You will be able to view, check-out and check-in files by simply opening the renamed .dbproj file.This step is required to be executed once for all of the developers. Once the "mirror" project is available, it is shared via source control.
2.1.1 Copy and paste the .dbproj file, rename with the same name as the DB Professional project, and change the extension to be .csproj.
2.1.2 Copy the DB Professional .targets file.
Typically this file is located in the folder: C:\Program Files\MSBuild\Microsoft\VisualStudio\v8.0\TeamDataAlternatively, if your DBA uses VS2008 it would be located at C:\Program Files\MSBuild\Microsoft\VisualStudio\v9.0\TeamData
Strictly speaking this file is not required. It is the most straighforward option to copy it, but for the future releases this step may be omitted.
2.1.3 Add the .dbproj to this .csproj project
Open the freshly created .csproj file and add the .dbproj file to it.2.1.4 Set editor and solution/projects to synchronize
Open the add-in properties window via Tools\Options and navigate to the DBProBridge nodeYou will need to set up absolute and full paths here, so disregard the multiple dots in the paths in the image above. .
| Setting | Description |
|---|---|
| Editor | The editor used when you invoke the DBProBridge command after right clicking the sql file. Sql work bench editor from the Sql 2005 client tools is set by default |
| Editor Arguments | Arguments passed the the editor tool. FilePath is the only dynamic parameter that can be currently passed |
| ProjectToSync | That is the project to synchronize after changes have been made to the project to watch. Each developer works on the .csproj, but synchronizes their changes to the .dbproj file |
| ProjectToWatch | That is the project which changes should be written to in order to synchronize. For the developer, that is .csproj |
| SolutionToWatch | The DBPro Bridge add-in will be only active if the opened solution matches the one set here. This is to avoid uncessary tasks for projects that do not require the DBPro Bridge add-in functionality |
All of the settings above are mandatory for setting the DBPro Bridge add-in to work correctly.
This is the only step executed for each developer. If you want to re-use the same settings for multiple developers you can copy settings from the path:
"C:\Documents and Settings\User\Local Settings\Application Data\DBProBridge\DBProBridgeOptions.xml" to the corresponding path for each developer.
3. Setting up the environment for the DBA
Setting the DBA environment is similar to step 2 above except for the properties to set up in the properties window, and adding .csproj file to the .dbproj.ProjectToSync for DBA is a .csproj,
ProjectToWatch is a .dbproj.
For solution to watch it should be the current DB solution.
Note that for developers you will need to create a different solution pointing into the .csproj file.
TODO: Add some screenshots from the DBA project.
4. Working with the Add-in
4.1 To edit the file via the setup editor:
The command checks out the file automatically and opens it in the configured editor
4.2 To create a new file.
There are no sql file templates right now in the project, so the best way to add a new file is to copy it from the existing one.Adding a new file checks out a project, which means it will need to be synchronized with the DBA mirror (or vice versa).
There is a limitation now that during the check-in of your changes when project needs to be synchronized (it means the project has been checked out due to the deleting the files or adding new files) you need to check it in by right clicking on the project node directly (not through the pending checkin window, not by clicking on the solution). This limitation is going to removed in the future releases.
Upon the check-in, the mirror project file is checked-out and synchronized with the file that is being checked-in. Subsequently the mirror file is checked in.
The usual scenario applies - the more frequently you synchronize, the less merge conflicts you will have.