Changes made to method elements often affect more than one file. In multiuser environments it is important to understand which actions will affect multiple files and act accordingly. Refer to Multi-User Scenarios With ClearCase for more information.
It is recommended that all file updates to a library under version control be performed with the integrated version control support provided by EPF. This integration protects users from unexpected file conflicts when preforming actions that involve multiple files.
For example, if a local file is out of date relative to the server, EPF will detect this conflict and generate a warning. In this situation users should heed the warnings and update their library appropriately.
The safest way to ensure that files with cross-dependencies are kept in synch with one another is to update the entire library. Do not simply refresh the individual element that is out of synch.
The following table describes the impact of common actions on specific files managed by a version control system.
| Action | Impact | Comments |
|---|---|---|
| Create a new plug-in | A new directory is created and added to version control. A new plugin.xmi is created in the new plug-in directory and added to version control. library.xmi is changed. |
Need to place new directory and new plugin.xmi file under version control. Be sure to check in the new plugin.xmi BEFORE checking in library.xmi. |
| Delete a plug-in | The entire directory for the plug-in is deleted. library.xmi is changed. |
|
| Rename a plug-in | The name of the plug-in's directory is changed. library.xmi is changed |
Check-in these changes as close together as possible, checking in the directory name change first, followed by library.xmi. |
| Move a content element to another plug-in | File moves from one directory to another. plugin.xmi for both plug-ins changes. |
Check-in all changes as close together as possible, checking-in the plugin.xmi file last. |
| Create a new method content element (task, role, work product, guidance, custom categories, or standard category) | A new <method content>.xmi file is created and added to version control if one or more rich text fields of the element are populated. plugin.xmi is changed. |
Need to place the new file under version control BEFORE checking in plugin.xmi. Note: each <method content>.xmi is placed in a specific folder for each content type. For example, <method content>.xmi for roleis placed in \roles folder. |
| Change the name of a method content element (task, role, work product, guidance, custom category, or standard category). | The <method content>.xmi file name is changed. plugin.xmi is changed. |
"Name" is the Name: field for the element. Changing this field changes the file name of the element. Check in both changes as closely together as possible. |
| Delete a method content element (task, role, work product, guidance, custom categories, or standard category) | The <method content>.xmi file is deleted. plugin.xmi is changed. |
|
| Create a new process (capability pattern or delivery process) | plugin.xmi is modified. New directory and new model.xmi and content.xmi files are created for the new CP/DP and added to version control. |
plugin.xmi is updated to include a reference to the new capability pattern or delivery process. Be sure to place the new file(s) under version control BEFORE checking in plugin.xmi. Note: It is advisable to double-check that your new process has been selected in your configuration. If it is not, you will not see it in the Configuration View. |
| Delete a process (capability pattern or delivery process) | plugin.xmi is modified. The directory for the process and its contents are deleted. |
|
| Rename a process (CP or DP) | plugin.xmi is modified. The directory for the process is renamed. |
Check in these changes as close together as possible. |
| Create, rename, or delete content package or process package | plugin.xmi is modified. Note: Content and process packages do not result in new directories being created in the file structure. |
When you create a new package, you may want to select it in your configuration. This will cause \configurations\<configuration_name>.xmi to be modified. |
| Change the name of a process element (capability pattern (CP) or delivery process (DP)) | The directory name for your CP/DP is changed to match the new name. plugin.xmi is changed to reference the new directory name. |
|
| Change the Presentation Name of a method element or process | plugin.xmi is modified | |
| Refine the descriptive text for a method element (all fields except the name, presentation name, or brief description) | The <method content>.xmi file is updated | |
| Create a new custom category | plugin.xmi is modified. | |
| Update the brief description for a method content element (task, role, work product, guidance, custom categories, standard category, or process (CP or DP)) | plugin.xmi is modified. | |
| Assign a relationship to an element, such as adding guidance, tool mentors, input or output work product, responsible role, performing role, etc. | plugin.xmi is modified | |
| Categorize an element by assigning it to a domain, work product kind, role set, or discipline) | plugin.xmi is modified. | |
| Assigning variability to an element by making it a contributor, extension, or replacement for another element | plugin.xmi is modified. | |
| Assigning a shape or node icon | plugin.xmi is modified. | |
| Add or change descriptive text for a process (not the brief description) | content.xmi is modified. | |
| Update the brief description for an activity in a process (CP or DP) | model.xmi is modified. | |
| Modify or create a diagram for a process. | model.xmi is modified. | |
| Update the name or presentation name of an activity | model.xmi is modified. | |
| Set or update the entry or exit state of a work product | model.xmi is modified. | |
| Set or update activity relationships (predecessors, extend, copy) | model.xmi is modified. | |
| Create a configuration | new <configuration name>.xmi is created under \configurations folder. | Be sure to add \configurations\<configuration name>.xmi to source control. |
| Delete a configuration | <configuration name>.xmi is deleted. | Be sure to delete \configurations\ <configuration name>.xmi in your version control system. |
| Rename a configuration | <configuration name>.xmi is rename to the <new configuration name>.xmi. | |
| Modify a configuration | <configuration name>.xmi is modified | |
| Creating a first estimating model | models.xmi is created. metrics.xmi is created. |
Check-in these files after creating estimating model. It is best to create an estimating model when library is created. |
| Creating a new estimating model or new estimating factor | models.xmi is changed. | |
| Using the Estimation tab of any task method element. | taskestimates.xmi is created. | Check-in the taskestimates.xmi file. |
| Add or Change estimates associated with a task method element. | taskestimates.xmi is changed. | |
| Add or Change estimates associated with a process, activities or task descriptors. | <parent process guid>.xmi is changed. |