Microsoft Visual SourceSafe Integration Overview

The Microsoft Visual SourceSafe add-in provides the most frequently used SourceSafe commands on the Tools menu. With those commands you are able to, for example:

•	Control the model as a whole in Visual SourceSafe

•	Check out and check in the model, get the latest version, or start the SourceSafe Explorer

The SourceSafe commands apply to the current default database. The integration requires that you have Microsoft Visual SourceSafe installed, and that you have a user account and basic knowledge of the Microsoft Visual SourceSafe product.

Before you can start using the integration you have to install and set up the Microsoft Visual SourceSafe environment.

Note: You do not need to have Microsoft Visual SourceSafe running to use the commands on the SourceSafe submenu. Visual Modeler starts the application when needed.


Frequently Asked Questions - SourceSafe Integration

Nothing happens when I execute the SourceSafe commands on the Tools menu. What is wrong?

For Visual Modeler to be able to access Microsoft Visual SourceSafe, your installation of Microsoft Visual SourceSafe has to contain the SourceSafe Integration component. Make sure that this component is installed by running the Microsoft Visual SourceSafe setup program. Click Add/Remove and select the Enable SourceSafe Integration option on the Maintenance Mode page. (Note that this option was not selected if your installation was done via the "Server" alternative.)

How do I version control a model?

Visual Modeler includes an integration with Microsoft Visual SourceSafe, by providing the most frequently used SourceSafe commands on the Tools menu in Visual Modeler. Thus, you are able version control a model by using the usual Check In and Check Out commands.

More information is found in the Microsoft Visual SourceSafe Integration book online.


Installing Visual SourceSafe
Installing Microsoft Visual SourceSafe

To be able to use the Microsoft Visual SourceSafe integration, you must have Microsoft Visual SourceSafe installed. Also, you must have a user account and basic knowledge of the Visual SourceSafe product.

1.	Before installing Visual Modeler, install the Microsoft Visual SourceSafe Client on your computer.

2.	Start Microsoft Visual SourceSafe. Choose Options from the Tools menu and select the Command Line Options tab. Select the Assume Project Based on Working Directory option.

3.	Install Visual Modeler.

The Microsoft Visual SourceSafe integration uses the current user name to identify the SourceSafe user. Before you can use the SourceSafe integration, the system administrator has to enter you as a user.

Note: You do not need to have Microsoft Visual SourceSafe running to use the commands on the SourceSafe submenu. Visual Modeler starts the application when needed.


Controlling a Model in Visual SourceSafe
Controlling a Model in Microsoft Visual SourceSafe

The SourceSafe integration makes it possible to control model files (.mdl) in Microsoft Visual SourceSafe. Note that the SourceSafe commands apply to the current default database.

To control the current open model:

1.	Click SourceSafe on the Tools menu, and select Add To Source Control.

2.	Make sure that the model file is selected.

3.	If an appropriate SourceSafe project already exists, enter the path to the project in the Source Safe Project box (or click Browse to search for it).

If you need to create a new project, click Browse and then click New…. Enter the name of the new project in the first field. By default the same name is suggested as the name of the corresponding working directory. Click OK to accept the default name, or enter another working directory name in the second field. Click OK in the Find SourceSafe Project dialog box.

4.	Select Keep Checked Out if you want the model file to be checked out after it has been added to the SourceSafe project.

5.	Optionally, write a comment in the Comment field. Visual Modeler inserts the contents of the field as a description of the controlled unit in Microsoft Visual SourceSafe.

6.	Click OK to add the model to the project.

Note: The added controlled unit is treated as a binary file by Microsoft Visual SourceSafe.


Removing a Controlled Model from SourceSafe Control

To remove the current model from SourceSafe control:

1.	Click SourceSafe on the Tools menu, and select Remove From Source Control.

2.	Make sure that the model file is selected in the displayed dialog box.

3.	Click OK.


Clearing SourceSafe Information from a Model

If, for example, the SourceSafe project where the model belongs is no longer available, the SourceSafe information stored in the model may have to be cleared.

To clear the SourceSafe information in the model:

1.	Click SourceSafe on the Tools menu, and select Clear SourceSafe Information.

2.	Make sure that the model file is selected.

3.	Click OK.


Checking Out
Checking Out a Model

To check out the current model from Microsoft Visual SourceSafe:

1.	Click SourceSafe on the Tools menu, and select Check Out.

2.	Make sure that the model file is selected.

3.	Click OK. Microsoft Visual SourceSafe checks out the file and Visual Modeler makes it editable.

If you checked out the model by mistake, you can use the Undo Check Out command on the SourceSafe menu to revert to the latest checked-in version.


Checking In
Checking In a Model

To check in the current model into Microsoft Visual SourceSafe:

1.	Click SourceSafe on the Tools menu, and select Check In.

2.	Make sure that the model file is selected.

3.	Click OK. Microsoft Visual SourceSafe checks in the model and Visual Modeler makes it read only.


Getting the Latest Version
Getting the Latest Version of a Model

To only get, but not check out, the latest version of the current model from Microsoft Visual SourceSafe:

1.	Click SourceSafe on the Tools menu, and select Get Latest.

2.	Make sure that the model file is selected.

3.	Click OK.


SourceSafe Submenu

Use the commands on this submenu to:

•	Get Latest, which means to get a copy of the latest checked-in version of controlled units

•	Check Out controlled units

•	Check In controlled units

•	Undo Check Out and revert to the latest checked-in version of controlled units

•	Add To Source Control, which means to add controlled units to a Visual SourceSafe project

•	Remove From Source Control, which means to remove controlled units from SourceSafe control.

•	Start Explorer, which means to start the Microsoft Visual SourceSafe program

•	Clear SourceSafe Information, which means to remove SourceSafe information about a controlled unit from the model

Note that all SourceSafe commands apply to the current default database.


Get Latest (SourceSafe Submenu)

Use this command to copy the latest checked-in version of the model to your development environment.

The Accept Changes command is the same as the Visual SourceSafe Get command. For a detailed description of the Get command, please refer to your Microsoft Visual SourceSafe product manuals.


Check Out (SourceSafe Submenu)

Use this command to check out the current model file.

For a detailed description of the Visual SourceSafe Check Out command, please refer to your Microsoft Visual SourceSafe product manuals.


Check In (SourceSafe Submenu)

Use this command to check in the current model file.

For a detailed description of the Visual SourceSafe Check In command, please refer to your Microsoft Visual SourceSafe product manuals.


Undo Check Out (SourceSafe Submenu)

Use this command to undo the previous check-out of the model and go back to the latest checked in versions.

The Undo Check Out command is the same as the Visual SourceSafe Undo Check Out command. For a detailed description of the command, please refer to your Microsoft Visual SourceSafe product manuals.


Add To Source Control (SourceSafe Submenu)

Use this command to add the current open model (.mdl file) as a controlled unit in a Visual SourceSafe project.

The Add To Source Control command is the same as the Visual SourceSafe Add command. For a detailed description of the Add command, please refer to your Microsoft Visual SourceSafe product manuals.


Remove From Source Control (SourceSafe Submenu)

Use this command to remove the model file from SourceSafe control.

The Remove From Source Control command is the same as the Visual SourceSafe Delete command. For a detailed description of the Remove command, please refer to your Microsoft Visual SourceSafe product manuals.


Start Explorer (SourceSafe Submenu)

Use this command to start the Microsoft Visual SourceSafe program from Visual Modeler.

Note that you do not need to have SourceSafe running to be able to use the commands on the SourceSafe submenu in Visual Modeler. The Start Explorer command is only provided only for your convenience, in case you need to use SourceSafe commands other than those provided on the SourceSafe submenu.


Clear SourceSafe Information (SourceSafe Submenu)

Use this command to delete SourceSafe information from the model for selected controlled units. The command is useful, for example, if the model is being used on a computer where Microsoft Visual SourceSafe is not installed or if the SourceSafe project where a controlled unit belongs is no longer available. In those cases, the SourceSafe information stored in the model may have to be deleted.


Check-in to SourceSafe Dialog Box

In this dialog box, you select the model file that you want to check in.

Optionally, in the Comment field, you can write an explanation of the reason for the checkin. The text you enter will be stored in the SourceSafe project as history for the current checkin.

Click OK, to check in the selected model file.

For a detailed description of the Visual SourceSafe Check In command, please refer to your Microsoft Visual SourceSafe product manuals.


Add To or Associate with SourceSafe Dialog Box

In this dialog box, you can add the current open model (.mdl file) as a controlled unit in a Visual SourceSafe project.

1.	Select the model file.

2.	If an appropriate SourceSafe project already exists, enter the path to the project in the Source Safe Project box (or click Browse to search for it). If you need to create a new project, click Browse and then click New….

3.	Select Keep Checked Out if you want the model file to be checked out after it has been added to the SourceSafe project.

4.	Optionally, write a comment in the Comment field. Visual Modeler inserts the contents of the field as a description of the controlled unit in Microsoft Visual SourceSafe.

5.	Click OK to add the model to the project.

Note: The added controlled unit is treated as a binary file by Microsoft Visual SourceSafe.

The Add To Source Control command on the SourceSafe menu is the same as the Visual SourceSafe Add command. For a detailed description of the Add command, please refer to your Microsoft Visual SourceSafe product manuals.


Find SourceSafe Project Dialog Box

In this dialog box, you select the Visual SourceSafe project where you want to add the model file. If you need to create a new project, click New…. Otherwise, select the appropriate project and click OK.


New Subproject Dialog Box

In this dialog box, you can create a new project in Microsoft Visual SourceSafe.

1.	Enter the name of the new project in the first field. By default, the same name is suggested as the name of the corresponding working directory.

2.	Click OK to accept the default name, or enter another working directory name in the second field.


Check-out from SourceSafe Dialog Box

In this dialog box, you select the model file that you want to check out.

Optionally, in the Comment field, you can write an explanation of the reason for the checkout. The text you enter will be stored in the SourceSafe project as history for the current checkout.

Click OK, to check out the selected model file.

For a detailed description of the Visual SourceSafe Check Out command, please refer to your Microsoft Visual SourceSafe product manuals.