| <?xml version="1.0" encoding="UTF-8"?> |
| <org.eclipse.epf.uma:ContentDescription xmi:version="2.0" |
| xmlns:xmi="http://www.omg.org/XMI" xmlns:org.eclipse.epf.uma="http://www.eclipse.org/epf/uma/1.0.5/uma.ecore" |
| xmlns:epf="http://www.eclipse.org/epf" epf:version="1.5.0" xmlns:rmc="http://www.ibm.com/rmc" |
| rmc:version="7.5.0" xmi:id="-V60xni_uGxBI53smjBJx8Q" |
| name="umf_naming_conventions,_EU58MMVkEdysMqkA3CCYsg" guid="-V60xni_uGxBI53smjBJx8Q" |
| changeDate="2008-11-04T12:44:20.343-0800" version="7.2.0"> |
| <mainDescription><p>
 |
| The <a class="elementLink" href="./../../../core.mdev.common.extend_umf/guidances/concepts/umf_C03950A8.html"
 |
| guid="_nrrn4GqHEdun45RPFGeYnA">Unified Method Framework (UMF)</a>&nbsp;defines a naming convention for each library
 |
| element: <a class="elementLink"
 |
| href="./../../../core.default.uma_concept.base/guidances/termdefinitions/method_plugin_190B9F5E.html"
 |
| guid="_D4TLgMaGEduMlb2cQZNTYw">method plug-in</a>s, <a class="elementLink"
 |
| href="./../../../core.default.uma_concept.base/guidances/termdefinitions/method_configuration_C2B8FA8A.html"
 |
| guid="__V7pAMaEEduMlb2cQZNTYw">method configuration</a>s, plug-in projects, configuration projects and tag groups.
 |
| </p>
 |
| <p>
 |
| The UMF naming convention divides the element names into name parts, where each name part is separated by a dot
 |
| (‘.’).&nbsp;For example, the plug-in name "core.tech.com.base" has&nbsp;four name parts.
 |
| </p>
 |
| <p>
 |
| The benefits of UMF's naming convention is that it takes advantage of Method Composer support for a hierarchical
 |
| library view where a new level is introduced for each name part. The resulting hierarchy is defined to optimize
 |
| configuration of the method.&nbsp;The most important categorization for someone configuring the process is listed
 |
| first: the plug-in or configuration type.&nbsp; <a class="elementLinkWithUserText"
 |
| href="./../../../core.mdev.common.base/guidances/termdefinitions/licensing_level_746E1470.html"
 |
| guid="_47cn8PU3EdyNMvgj607huw">Licensing level</a> is applied as a suffix and no suffix means open source (in other
 |
| words, open source method elements do not have a licensing level suffix).
 |
| </p>
 |
| <h3>
 |
| UMF plug-in naming conventions
 |
| </h3>
 |
| <p>
 |
| UMF plug-in naming convention: &lt;<strong>plug-in
 |
| type</strong>&gt;.[&lt;<strong>context</strong>&gt;].&lt;<strong>descriptive name</strong>&gt;.&lt;<strong>plug-in
 |
| part</strong>&gt;[_&lt;<strong>part qualifier</strong>&gt;][-&lt;<strong>source/licensing level</strong>&gt;]
 |
| </p>
 |
| <p>
 |
| Where:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| <strong>Plug-in type</strong>:&nbsp; The following are the possible values for the plug-in type.&nbsp; For more
 |
| information on the plug-in types, see <a class="elementLinkWithType"
 |
| href="./../../../core.mdev.common.base/guidances/concepts/practice_lib_plugin_types_3EA8002F.html"
 |
| guid="__428YO6cEdygKbJMUVNEtg">Concept: Practice Library Plug-In Types</a>. 
 |
| <ul>
 |
| <li>
 |
| core = Core
 |
| </li>
 |
| <li>
 |
| practice = Practice
 |
| </li>
 |
| <li>
 |
| process = Process
 |
| </li>
 |
| <li>
 |
| publish = Publish
 |
| </li>
 |
| <li>
 |
| meth_mgmt = Method Management
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| </ul>
 |
| <blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
 |
| <br />
 |
| </blockquote>
 |
| <ul>
 |
| <li>
 |
| <strong>Context</strong>: Not required (some plug-ins are "context-free" meaning that they are not specific to any
 |
| <a class="elementLink" href="./../../../core.mdev.common.base/guidances/termdefinitions/context_AF8B381C.html"
 |
| guid="_Kemu0PHZEdyO9sYxKNWf8A">context</a>).&nbsp;&nbsp;The following are some examples of contexts:&nbsp; 
 |
| <ul>
 |
| <li>
 |
| gen = general purpose (<em>general purpose</em> means applies across multiple contexts.&nbsp; This is NOT
 |
| the same as context-free)
 |
| </li>
 |
| <li>
 |
| tech = technology
 |
| </li>
 |
| <li>
 |
| bus = business
 |
| </li>
 |
| <li>
 |
| mgmt = management
 |
| </li>
 |
| <li>
 |
| legacy = legacy
 |
| </li>
 |
| <li>
 |
| mdev&nbsp;= method development&nbsp;
 |
| </li>
 |
| <li>
 |
| sdpl = solution deployment
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| </ul>
 |
| <blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
 |
| <p>
 |
| Note: If you would like to implement "nested" contexts, you can break the context name into multiple "parts", where
 |
| each of those parts are separated by a dot (period) so that Method Composer creates a hierarchical view of the
 |
| related plug-ins. For example: You could define an authoring&nbsp;(auth)&nbsp;context that is a sub-context of
 |
| method development (mdev).&nbsp;In such a case,&nbsp;the name of the context would be
 |
| "mdev.auth".&nbsp;&nbsp;&nbsp;
 |
| </p>
 |
| </blockquote>
 |
| <ul>
 |
| <li>
 |
| <strong>Descriptive name</strong>: The following conventions apply to the Descriptive name part of of a plug-in
 |
| name:
 |
| </li>
 |
| <li style="LIST-STYLE-TYPE: none">
 |
| <ul>
 |
| <li>
 |
| Actual names will vary, but the name should be descriptive of what the plug-in contains, should be pretty
 |
| close to the presentation name for the plug-in, using <a class="elementLink"
 |
| href="./../../../core.mdev.common.extend_umf/guidances/guidelines/umf_approved_acronyms_A0328F22.html"
 |
| guid="_EQiuAPTiEdysQswc_A-Z6g">UMF Approved Acronyms</a>.&nbsp;&nbsp;
 |
| </li>
 |
| <li>
 |
| For example:&nbsp;Descriptive name:&nbsp;pracitice_auth;&nbsp;Presentation name: Practice Authoring.<br />
 |
| &nbsp;&nbsp;&nbsp;&nbsp;
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| <li>
 |
| <strong>Plug-in part</strong>: The following are the possible values for the plug-in part.&nbsp; For more
 |
| information on the plug-in parts, see <a class="elementLinkWithType"
 |
| href="./../../../core.mdev.common.base/guidances/concepts/practice_lib_plugin_types_3EA8002F.html"
 |
| guid="__428YO6cEdygKbJMUVNEtg">Concept: Practice Library Plug-In Types</a>. 
 |
| <ul>
 |
| <li>
 |
| base = base plug-in
 |
| </li>
 |
| <li>
 |
| assign = assign plug-in
 |
| </li>
 |
| <li>
 |
| extend = extend plug-in<br />
 |
| &nbsp;&nbsp;&nbsp;
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| <li>
 |
| <strong>Part qualifier</strong>: Not required. This can be used to provide some additional information about the
 |
| plug-in part.&nbsp; This is most applicable for Extend plug-ins, where the part qualifier can be used to indicate
 |
| the reason for the extension.&nbsp; For example, UMF-specific extensions to an existing plug-in may be indicated
 |
| with a "_umf" part qualifier (e.g., "&lt;some plug-in&gt;.extend_umf").&nbsp;&nbsp; Another exmple of a qualifier
 |
| is "gbl" for globalization".<br />
 |
| </li>
 |
| <li>
 |
| <strong>Source/licensing level suffix</strong>.&nbsp; Can be used to indicate the company that the plug-in applies
 |
| to and/or the licensing level of the plug-in. Open source plug-ins do not include a licensing level in their
 |
| names.<br />
 |
| Note: The use of a hyphen (-) rather than a dot or perioed (.) is intentional because the
 |
| source/licensing&nbsp;level&nbsp;is not intended to be another hierarchical level.&nbsp; Do no use a hyphen in any
 |
| other place in the name&nbsp;except to separate the actual plug-in name from the suffix.
 |
| </li>
 |
| </ul>
 |
| <p>
 |
| Figure 1 provides examples of UMF plug-in names that use these conventions:
 |
| </p>
 |
| <p>
 |
| Figure 1: Example: Method authoring practice naming conventions
 |
| </p>
 |
| <p>
 |
| <img style="WIDTH: 685px; HEIGHT: 514px" height="514" alt="umf_plugin_name_examples"
 |
| src="./resources/umf_plugin_name_examples.jpg" width="600" />
 |
| </p>
 |
| <p>
 |
| Notice the following points shown in Figure 1:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| All practices are grouped together because the first part of their names is “practice”
 |
| </li>
 |
| <li>
 |
| All the practices that support a specific context are grouped under the content name (“mdev” in this example)
 |
| </li>
 |
| <li>
 |
| All plug-ins that support method authoring are grouped together because a new name level was introduced in the
 |
| descriptive name (“auth” in this example)
 |
| </li>
 |
| <li>
 |
| All plug-in “parts” for a practice are grouped together because the practice descriptive name is the same
 |
| </li>
 |
| <li>
 |
| The reason for the extension is included as part of the Extend plug-in name, separated from the word "extend" with
 |
| an underscore and not a&nbsp;hyphen. For example: practice.mdev.auth.practice_auth.extend_umf and
 |
| practice.mdev.auth.practice_auth.extend_umf-ibm
 |
| </li>
 |
| <li>
 |
| The licensing level is separated from the rest of the plug-in name with a hypen.&nbsp; For example:
 |
| practice.mdev.auth.practice_auth.extend_umf-ibm and practice.mdev.auth.practice_auth.extend_umf-ibm_int.
 |
| </li>
 |
| </ul><br />
 |
| <h3>
 |
| UMF plug-in project naming conventions
 |
| </h3>
 |
| <p>
 |
| Plug-in projects should be named exactly the same as the plug-ins they contain. See the earlier section on plug-in
 |
| naming conventions for more information.
 |
| </p><br />
 |
| <h3>
 |
| UMF configuration naming conventions<br />
 |
| </h3>
 |
| <p>
 |
| UMF configuration naming convention: &lt;<strong>configuration
 |
| type</strong>&gt;[.<strong>context</strong>].&lt;<strong>descriptive name&gt;[-&lt;source/licensing level&gt;]</strong>
 |
| </p>
 |
| <p>
 |
| Where:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| <strong>Configuration type</strong>: The following are the possible values for the&nbsp;configuration
 |
| type.&nbsp;For more information on UMF configuration types, see <a class="elementLinkWithType"
 |
| href="./../../../core.mdev.common.base/guidances/concepts/practice_lib_config_types_B96A959A.html"
 |
| guid="_1gchoO6dEdygKbJMUVNEtg">Concept: Practice Library Configuration Types</a>. 
 |
| <ul>
 |
| <li>
 |
| publish = Publish Configuration
 |
| </li>
 |
| <li>
 |
| zconstruct = Process Construction Configuration<br />
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| <li>
 |
| <strong>Context</strong>: Same as for plug-ins.<br />
 |
| </li>
 |
| <li>
 |
| <strong>Descriptive name</strong>: The following conventions apply to the Descriptive name part of of a
 |
| configuration name:&nbsp;&nbsp; 
 |
| <ul>
 |
| <li>
 |
| For Publish configurations, the <a class="elementLink"
 |
| href="./../../../core.mdev.common.base/guidances/concepts/practice_config_CC7754F2.html"
 |
| guid="_0H9aAO7EEdy9EOwDlaw7Kw">Practice Configuration</a>&nbsp;name being published&nbsp;makes a&nbsp;good
 |
| descriptive name
 |
| </li>
 |
| <li>
 |
| For Process Construction configurations, the name of the plug-in that contains the process makes a good
 |
| descriptive name<br />
 |
| </li>
 |
| </ul>
 |
| </li>
 |
| <li>
 |
| <strong>Source/licensing level</strong>: Same as for plug-ins.
 |
| </li>
 |
| </ul>
 |
| <p>
 |
| The following are some examples of UMF&nbsp;configuration names that use these conventions:
 |
| </p>
 |
| <p>
 |
| Figure&nbsp;2 provides an&nbsp;example of UMF onfiguration names that use these conventions.
 |
| </p>
 |
| <p>
 |
| Figure 2: Example: UMF configuration naming conventions
 |
| </p>
 |
| <p>
 |
| <img height="465" alt="umf_config_name_examples" src="./resources/umf_config_name_examples.jpg" width="600" />
 |
| </p>
 |
| <p>
 |
| Notice the following points shown in Figure 2:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| All configurations of the same type are grouped together because the first part of the configuration name is the
 |
| configuration type
 |
| </li>
 |
| <li>
 |
| All configurations that support a specific context are grouped under the content name (“mdev” in this example)
 |
| </li>
 |
| <li>
 |
| The publish configurations for a specific configurations are easy to spot because the configuration name is in the
 |
| descriptive name
 |
| </li>
 |
| <li>
 |
| The configuration to be used as the default configuration when constructing a process in a plug-in is easy to spot
 |
| because the owning plug-in name is in the descriptive name
 |
| </li>
 |
| <li>
 |
| The unique identifier suffix is used to indicate the licensing level of the configurations (e.g., -ibm for
 |
| commercial content and -ibm_int for internal IBM content)<br />
 |
| </li>
 |
| </ul>
 |
| <h3>
 |
| UMF configuration project naming conventions
 |
| </h3>
 |
| <p>
 |
| UMF configuration project naming convention: <strong>configs[-</strong>&lt;<strong>descriptive
 |
| name&gt;][-&lt;source/licensing level&gt;]</strong>
 |
| </p>
 |
| <p>
 |
| Where:
 |
| </p>
 |
| <p>
 |
| Descriptive name: This is optional (i.e., you may only have one tag group per licensing level).&nbsp; If you use one,
 |
| the descriptive name should be a name that represents a specific set or category of configurations.&nbsp; For example:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| mdev: Method Development
 |
| </li>
 |
| <li>
 |
| mdev.auth: Method Aurhoring (s sub set of method development)
 |
| </li>
 |
| <li>
 |
| mdev.meth_mgmt: Method Development Method Management
 |
| </li>
 |
| </ul>
 |
| <p>
 |
| Source/licensing level: Same as for plug-ins.
 |
| </p>
 |
| <p>
 |
| Figure&nbsp;3 provides some examples of UMF&nbsp;configuration project names that use these conventions.
 |
| </p>
 |
| <p>
 |
| Figure 3: Example: UMF configuration project naming conventions
 |
| </p>
 |
| <p>
 |
| <img style="WIDTH: 682px; HEIGHT: 537px" height="537" alt="umf_config_proj_name_examples"
 |
| src="./resources/umf_config_proj_name_examples.jpg" width="600" />
 |
| </p><br />
 |
| <h3>
 |
| UMF tag group naming conventions
 |
| </h3>
 |
| <p>
 |
| UMF tag group naming convention: <strong>tags-</strong>&lt;<strong>descriptive name&gt;[-&lt;source/licensing
 |
| level&gt;]</strong>
 |
| </p>
 |
| <p>
 |
| Where:
 |
| </p>
 |
| <ul>
 |
| <li>
 |
| Descriptive name: A name that represents a specific set or category of tags.&nbsp; For example: mdev: Method
 |
| Development
 |
| </li>
 |
| <li>
 |
| Source/licensing level: Same as for plug-ins.
 |
| </li>
 |
| </ul>
 |
| <p>
 |
| Figure&nbsp;4 provides some examples of UMF&nbsp;tag group names that use these conventions.
 |
| </p>
 |
| <p>
 |
| Figure 4: Example: UMF tag group naming conventions
 |
| </p>
 |
| <p>
 |
| <img height="39" alt="umf_tag_group_name_examples" src="./resources/umf_tag_group_name_examples.jpg"
 |
| width="124" /><br />
 |
| &nbsp;
 |
| </p></mainDescription> |
| </org.eclipse.epf.uma:ContentDescription> |
