Tool Mentor: Which Actions Cause Files Change in EPF Composer |
This tool mentor describes actions that can be take in the EPF Composer and the files that are affected by those actions.
Main Description
The following table shows examples of actions that may result in more than one file being updated or that could result in a change that requires special attention in your version control system, such as A filename change A filed moved from one directory to another A file deleted A file created Note: This table shows common actions, it may not cover every action that needs special attention.
Action | What Changed | Comments
--- | --- | ---
Change the name of a method content element (task, role, work product, guidance, custom category, or standard category) Note: This includes contributing, extending, or replacing content elements. | The `<method content>.xmi` file name is changed `plugin.xmi` is changed | Name refers to the name field for the element in the EPF Composer editor. Be sure to rename the file in your version control system.
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. | In your version control system, be sure to rename the directory before you check-in the updated `plugin.xmi`.
Change the Presentation Name of a method element or process | `plugin.xmi` is modified |
Move a content element to another plug-in | File moves from one directory to another `plugin.xmi` for both plug-ins changes | In your version control system, be sure to move the file before you check-in the updated `plugin.xmi` files.
Create a new method content element (task, role, work product, guidance, custom categories, or standard category) | A new `<method content>.xmi` file is created `plugin.xmi` is changed | Need to place the new file under source code control. Be sure to place the new file under source code control BEFORE checking in `plugin.xmi`.
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 | Be sure to delete the file in your version control system.
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 plug-in | New directory is created New `plugin.xmi` is created in the new plug-in directory `library.xmi` is changed | Need to place new directory and new `plugin.xmi` file under source code control. Be sure to check in the new `plugin.xmi` BEFORE checking in `library.xmi`. Note: You might want to develop your content in many separate plug-ins, to minimize the number of persons working on each plug-in.
Delete a plug-in | The entire directory for the plug-in is deleted `library.xmi` is changed | Be sure to perform the corresponding deletes in your version control system.
Rename a plug-in | The name of the plug-in's directory is changed `library.xmi` is changed | Be sure to rename the directory in your version control system.
Create a new capability pattern (CP) or delivery process (DP) | `library.xmi` is modified `plugin.xmi` is modified New directory and new `model.xmi` and `content.xmi` files are created for the new CP/DP | `library.xmi` is modified to update the configuration to include the new CP or DP. `Plugin.xmi` is updated to include a reference to the new CP or DP. Be sure to place the new file(s) under source code control BEFORE checking in `library.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 (CP or DP) | `library.xmi` is modified `plugin.xmi` is modified The directory for the process and its contents are deleted | Be sure to delete the directory and its contents in your version control system.
Rename a process (CP or DP) | `library.xmi` is modified `plugin.xmi` is modified The directory for the process is renamed | Be sure to rename the directory in your version control system.
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 `library.xmi` to be modified.
Create a new custom category | `plugin.xmi` is modified | You may notice a `\customcategories` directory in some of the plug-ins shipped with EPF Composer. Early versions of EPF Composer created a directory for each custom category.
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 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 |
Update the attributes for a process activity (ongoing, repeatable, etc) | `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, delete, or modify a configuration | `library.xmi` is modified |
This program and the accompanying materials are made available under the Eclipse Public License v1.0 which accompanies this distribution. View copyright information here: OpenUP Copyright