Source Control Menu Options in Magic xpi (Magic xpi 4.5)

Before you check your project into a Source Control tool, the following options are available from the Source Control menu (accessed from the File menu):

Note:

To work with the Team Foundation Server, you need to install the Team Foundation Server MSSCCI Provider 32-bit plug-in for Visual Studio. Some of the Source Control options that you see are created by the Source Control vendor or by Visual Studio and they are not supported by Magic xpi (for example, a dialog box to support merge operations).

• Exclude from Source Control: This option is only relevant when you want to add the project to the Source Control tool without the selected item.

• Add Solution to Source Control

• Add Selected Projects to Source Control

• Open from Source Control: When using the TFS source control it is recommended not to use this option, since there is a known issue with this option. Instead, get the entire project using TFS's Source Control Explorer.

• Add Project from Source Control: If you did not select the Add to Source Control check box in the New Project dialog box when you created your project, you can enable Source Control at a later date by selecting Add to Source Control.

• Change Source Control

• Launch [Source Control provider]

After you check your project in, the following options are available form the Source Control menu:

• Get Latest Version: This option is used to retrieve the most recent version of the object from the Source Control server. When you use this option, Magic xpi replaces the object’s file on your local computer with the most recently checked-in version of the object’s source file. When there is a change to the project tree you need to get the entire project using the Source Control provider's Explorer.

• Get Latest Version (Recursive): This option retrieves the most recent version of the object including its subdirectories.

• Get

Note:

When using TFS as a source control provider, you cannot use the Get and Get Latest Version options to undo changes that you made. TFS remembers which version was last downloaded from the server and does not try to retake the version. Instead, use the Undo Checkout option or take another version of the file from the history.

• Check Out for Edit: See the Checking Items Out/In section below.

• Check In: See the Checking Items Out/In section below.

• Undo Checkout: This option is used for releasing a checked out object, and returning to the most recent version of the object. You can only use this operation when the object is in Checked Out status. If you made changes to the object while it was checked out, you will lose all the changes made to the object while it was checked out.

Note:

To undo the check out of a business project after adding flows to the business process, you need to use the Undo Checkout option on the entire project.

• View History: You will only be able to view the History screen if it is supported by your Source Control product.

• Exclude selection from Source Control

• Refresh Status

• Share

• Compare

• Properties

• Change Source Control: Clicking the Disconnect button in the Change Source Control dialog box does not actually remove the project from your Source Control product. It only allows Visual Studio to work in offline mode. To work without Source Control, you need to unbind the project from Source Control.

• Launch [Source Control provider]

Note:

The following Magic xpi files are not handled by Source Control: ifs.ini, Resources.xml and Services.xml. You should always ensure that you always configure your Source Control product to work in exclusive mode because Magic xpi files cannot be merged. In addition, you should also make sure that your Source Control is always configured to check out the latest version of a file.

Checking Items Out/In

In the Magic xpi Studio’s Solution Explorer, you can check out any item by right-clicking on it and selecting Check Out For Edit from the context menu. A red check mark will appear in the Solution Explorer next to the checked out item. Once you have finished editing an item, you can check it back in again by right-clicking on it and selecting Check In from the context menu. A lock icon will appear in the Solution Explorer next to the checked in item.

If the item that you select for check out is part of a hierarchy, the Check Out For Edit dialog box will open. Here, you can select specific additional items to check out or to leave checked in.

You can also check out flows by opening the flow in the main pane. Then, from the File menu, select Source Control, followed by Check Out For Edit. Checking in flows is done through the same menu.

If you attempt to edit or save an item that is checked in to the Source Control, the behavior that you defined in the Source Control area’s Environment settings section, in the Options dialog box, is implemented.

If you are using specific variables in any part of your project, you should be aware that another user could make changes to those variables in one of the variable repositories. If this happens, these changes will affect your project. To prevent this, you should always make sure that you configure your Source Control product’s settings to exclusive check out mode.

Setting the flow to be suspended using the context menu does not automatically check out the flow.

Pending Checkins

The Pending Checkins window shows all items that are currently checked out in a particular solution or project. You access the Pending Checkins window from the View menu. This window lets you check in all of the listed items in one go, or you can choose specific items to check in by selecting and clearing the relevant check boxes. You can also add comments if required.

In the window, you have various toolbar options as well as context menu options including Compare Versions, Open with Editor, Undo Checkout, Columns, and Sort.

Note: The Open with Editor context menu option is not supported for mapper files.