Managing Teamwork Files

When modeling, there may be external resources you want to attach to a model which help describe it in detail or include data that cannot be modeled within the tool, like a text document. For example, you may want to attach a scanned image of a transaction receipt to a diagram that describes the transaction process so that the analyst can design the new system based on the image. Or maybe an image file showing the user's expectation of the user interface.

The reference function enables you to add file references to model elements and diagrams. You, as a user who work in a team-based environment with Teamwork Server do not need to copy any referenced files for other team members to open. Instead, you could commit your model along with the referenced files to the server by referencing a teamwork file. Teammates can then get the referenced files from server and open them in their environment.

In VP, there is a folder under the workspace for storing files that are readily be committed to Teamwork Server for versioning. Those files are called teamwork files. The file revision will follow the model, i.e. whenever you open a particular revision of work from server, the file of that revision will be obtained and thus there is always a consistency between the file and the design.

The Teamwork Files pane

Teamwork Files pane is a user interface component where you can manage and see the teamwork files. If you are running in the default perspective, the Teamwork Files pane is placed within the pane group at bottom left of the user interface. You may show it by selecting View > Panes > Teamwork Files from the main menu, or press Ctrl-Shift-F.

The Teamwork Files pane

Adding teamwork files/folder

Adding a teamwork file/folder will copy that file/folder to under the workspace folder. Once added, the teamwork file/folder can be versioned by Teamwork Server. To add a teamwork file:

1. Select the node in Teamwork Files pane for creating file/folder. You may select the project root node or a folder node.
2. Click on the plus button in Teamwork Files pane and select Add Files/Folder... from the popup menu.
   

   Add file/folder

3. In the Add window, select the file or folder to add and click Open.
4. You are prompted to confirm copying the file or folder to workspace. Click OK.
   

   Teamwork file added

Opening the containing folder of file

You can open the containing folder of a teamwork file/folder so that you can access it with file explorer provided by the operating system. Right click on the file/folder and select Show in Folder from the popup menu.

Organizing teamwork files with folder

You may organize the added physical files/folder by adding folders. Note that when you create a folder, a physical folder will be created in your workspace folder. To add folder:

1. Select the node in Teamwork Files pane for creating folder. You may select the project root node or a folder node.
2. Click on the plus button in Teamwork Files pane and select New Folder... from the popup menu.

   Create a folder

3. Enter the name of folder in the popup dialog box. Click OK. Once a folder is created, you may add files/folder in it, or drag existing teamwork files/folders into it.
   

   Folder added

Committing teamwork files

You may make use of the commit function to commit teamwork files to Teamwork Server. When you perform a commit globally (i.e. commit the whole project), teamwork files will get committed. If you want to perform commit on specific teamwork file/folder, right click on it and select Commit... from the popup menu.

Commit teamwork files to server

Removing teamwork files

To remove a teamwork file from Teamwork Files pane, select the file/folder to remove and press Delete. Alternatively, right click on the file/folder and select Delete from the popup menu.

Revert changes

Revert is the process of discarding non-committed modifications. To revert a file/folder, right click on the file/folder and select Revert from the popup menu. In the Revert window, select the files to revert.

Revert changes of teamwork files

Referencing a teamwork file

When you try to add a file reference to a teamwork file, you may manually navigate through the folders to locate the teamwork file to add. Or to speed things up, VP-UML lets you create a shortcut that brings you to the folder where the teamwork files are stored. In order to have such shortcut, you need to define a user path of project files to create a corresponding shortcut in file chooser. After that, you may add the reference easily.

1. Select Tools > Options... from the main menu to open the Options window.
2. In the Options window, select User Path on the left hand side.
3. On the right hand side, click Add... and select Project Files Path from the popup menu.
4. Click OK at the bottom of the Options window to close it.
5. From now on, when you try to add file reference to model elements, you can select the shortcut Project Files Folder in file chooser to jump to the folder where the teamwork files are listed.
   

   Project files folder