How to generate a Jazz Process Template

1.0 Select a Base Template

Only some key elements of a Jazz Process template, such as roles, work item templates, and work item types, can currently be defined using RMC. RMC cannot yet model work item states, work flows, permissions, and timelines. A base template must be used to to provide defaults for these elements that cannot currently be modeled so that the resulting process template is usable. The resulting process template can be further customized as needed using Jazz interfaces.

Use Jazz user interfaces to explore the existing process templates before doing customization in RMC.

---

2.0 Choose an RMC Perspective

For an RMC element to be added to a Jazz Process Template, you set it's "Jazz Enactment flag" to true. This can be done from either the Authoring perspective or the Team Process Perspective. Here is a comparison of these options:

1. Authoring perspective: This is the perspective used by a process engineer creating a process template as an asset to be reused by many different projects. If using this perspective, you need to be aware that the Jazz Enactment flag cannot be set via contribution. It is typically set on a base element. When you cannot or do not wish to modify the base element, then this flag can be on an extends-replaces element that changes just this one attribute.
   
   
2. Team Process perspective: This is the perspective used by a team customizing a process template just for that team. In this case, you edit elements and set the Jazz Enactment flag as needed. To learn how to edit elements in the Team Process perspective, refer to the topic Creating a Team Process. One limitation of this perspective is that you cannot set the flag on work breakdown structure elements (capability patterns and delivery processes). To modify those elements you must switch to the Authoring perspective.

2.1 Define a Jazz Role

1. Find the role that you want to include in the template
   
   
2. Edit the role in the RMC editor.
   
   
3. Set the Jazz enactment flag (in the General Information section below Brief Description).

When a Jazz Process Template is created from a configuration, and this role is included in the configuration, then this role is included in that template.

Note that RMC role elements have the“Jazz enactment” flag set by default. For all other element types, the default is “not set”.

---

3.0 Define a Jazz Work Item Template

(Available only in the Authoring perspective)

1. Find the Capability Pattern or Delivery process that contains the work breakdown structure elements that you wish to turn into a work item template.
   
   
2. Edit the element.
   
   
3. Click the Work Breakdown Structure tab.
   
   
4. Right click the breakdown element that you wish to make a Work Item template and click Show Properties View from the context menu.
   
   
5. Choose the Capability Pattern that you want to include in the template and open it in the library perspective.
   
   
6. Set the Jazz enactment flag (in the General Information section below the Variability and Base element selection).

Note that you can control whether or not the sub-elements in the breakdown structure are included in the template by setting the flags in the "Planned" column of the work breakdown structure editor.

When a Jazz Process Template is created from a configuration, and a WBS element with "Jazz enactment" is in the configuration, then a work item template corresponding to that element is included in the process template .

---

4.0 Define a Jazz Work Item Type

Note that Jazz Work Item Types can only be created from RMC types that have been configured for this purpose. You can define a new element type for this purpose. See topic Creating a User Defined Type. Alternatively, you can modify an existing type to configure it as a Jazz Work Item Type. See topic Modifying an Existing Type.

1. Find the element from which you want to create a Work Item Type.
   
   
2. Edit the element.
   
   
3. Set the Jazz enactment flag (in the General Information section below Brief Description).

When a Jazz Process Template is created from a configuration, and this element is included in the configuration, then a corresponding Work Item type is included in the process template.

---

5.0 Generate and deploy a Jazz Process Template

1. Publish the configuration or team process to be associated with your new Jazz Process Template, and deploy it to a web server.
   
   As an example:
   1. Publish the CLM for IT Agility@Scale configuration as a web application called "clm", resulting in a "clm.war" file
   2. Deploy to the Jazz server by copying "clm.war" to the <JazzInstallationDirectory>/server/tomcat/webapps/rmc directory.
      
      
2. Open the Team Process perspective.
   
   
3. Select the Method Configuration (and Team if applicable).
   
   
4. Click the Create and Deploy Jazz Process Template icon on the RMC tool bar.
   
   
5. In the "context root" field, enter the URL for the published configuration.
   
   In the example described previously, a relative URL of "/clm" can be used, since the website is hosted by the Jazz server. If you had published the process to a different webserver, such as http://www.myorganization.com/clm/index.htm then the context root would be http://www.myorganization.com/my_process
   
   
6. Click Next.
   
   
7. Select a Base Template
   
   This is the template to which your "Jazz Enactment" flagged elements will be added. You should not mark as "Jazz Enactment" any elements which are already in the base template.
   
   Note: The available list of base templates is predefined, however, it can be changed. See section 6.0 for more details.
   
   
8. Under "Add Initial Iterations" choose one of the following:
   • for Agile Development - this adds a timeline with Sprints
   • for Iterative Development - this adds a timeline with iterations
   • for Custom Development - this adds a backlog only
   • None - no timeline is added
     
     Note: These available options are predefined, however, they can be changed. See section 6.0 for more details.
     
     
9. Check the "Review Jazz enactment element" box if you want to modify the Jazz process template elements to be created. Do not check this box if you want to simply generate the elements as specified by the "Jazz enactment" flag settings in the configuration. Then click Next.
   
   
10. If Review Jazz enactment element" was selected, then:
    1. Add or remove Jazz roles. Click Next
    2. Add or remove Jazz Work Item Types. Click Next.
    3. Add or remove Jazz Work Item Templates.
       Choose from amongst the following generate settings:
       1. Create Jazz Work Items from planned tasks only from the WBS: this option allows you to fine tune which WBS activities and tasks are available as tasks in the work item template. If checked, only those WBS elements marked as “planned” are available. If not checked, all the elements in the WBS selection are available as tasks in the work item template.
       2. Add type prefix to Jazz work item summary: if checked, this option adds the type of the element (i.e. Activity or Task) as prefix to the work item summary text.
       3. Create Jazz work items for phases and iterations from the WBS: if checked, this option creates a task work item for each phase and iteration node (in addition to activity and task nodes) from the WBS. If not checked, only activities and tasks from the WBS selection become work items.
       4. List the task's steps in the description of the work item: if checked, this option adds the steps text to the work item description field. If not checked, only the brief description of the task is added to the work item.
          
          Note: if you have set the “Jazz enactment” flag in the library perspective for an element, this element will appear in the right hand side selection list to start with.
          
          
11. Click Next
    
    
12. Log in to a Jazz repository
    
    See http://pic.dhe.ibm.com/infocenter/clmhelp/v4r0/topic/com.ibm.team.scm.doc/topics/t_scm_shell_connect_repo_proj.html for guidance on connecting to a Jazz repository. Note that you may need administrator privileges to make changes to process templates.
    
    
13. Choose to update or create a new process template
    
    To create a new process template, select the target repository connection node. Give the process template a name, identifier and optional summary.
    
    To update one of the existing process templates in your Jazz Team Server, select the process template to be updated.
    
    
14. Click Finish to generate and deploy the Jazz Process Template.

---

6.0 Customizing available base templates and initial iterations

You can replace the set of base templates used by RMC by placing a new set of base templates in your library.

6.1 Get a starting set of base templates

A starting set of base templates is available for download from http://public.dhe.ibm.com/software/rationalsdp/v7/rmc/752/technotes/jazz_templates_40.zip

After downloading the zip file, extract it to a folder of your preference. A folder named “jazz_integration” is created.

Copy that jazz_integration folder into your RMC library.
· If you are using a single location library, paste it into the configurations folder.
· If you are using a workspace based library, paste it into any configuration project folder.

6.2 Remove a process template

To remove a process template from the list:

1. Expand the jazz_integration folder.
   
   
2. Find and open the configuration_templates.xml file. (In the RMC Navigator view, you can right click the file and select Open With > Text Editor)
   
   
3. Delete the line of the process you want to remove from the list
   
   For example:
   <configuration-template id="xyz.process.ibm.com" name="XYZ"/>
   
   
4. Notice in the jazz_integration/templates folder that each process template has two associated xml files: one with the string “project-configuration” and the other with “team-configuration” string in the name. Delete the two corresponding xml files of the template you want to remove from the list
   
   For example:
   
   xyz.process.ibm.com_project-configuration.xml
   
   xyz.process.ibm.com_team-configuration.xml
   
   
5. Reopen the library so these changes can take effect.

6.3 Add a process template

To add your own process template to the list:

1. Expand the jazz_integration/templates folder.
   
   
2. Find and open the configuration_templates.xml file. (In the RMC Navigator view, you can right click the file and select Open With > Text Editor)
   
   
3. Add a line for the process you want to add to the list
   
   For example:
   <configuration-template id="my_template.process.ibm.com" name="My Template"/>
   
   
4. Back to the jazz_integration/templates folder, add two associated xml files for the new template you want to add. You can use a text editor or xml editor to create the files. For now, create empty files, and name them like the following:
   
   my_template.process.ibm.com_project-configuration.xml
   my_template.process.ibm.com_team-configuration.xml
   
   
5. Populate each xml file with process template information. The easiest way to do this is to have your process template created in RTC in the way you like it, then copy and paste portions of the underlying RTC template xml file into these two newly created xml files.
   
   1. In the RTC client, go to Work Items perspective and open the Process Templates tab. Double click to open your desired “My Template”.
      
      
   2. In the process template editor, go to the Process Configuration Source tab.
      
      
   3. Find the <role_definitions> section in the xml code. Copy the text, including <role_definitions> and </role_definitions> tags. Paste the text into your “project-configuration” xml file.
      
      
   4. Do the same for the <project_configuration> section of the xml.
      
      
   5. Find the <team-configuration> section in the xml code. Copy it, and this time, paste the text into your “team-configuration” xml file.
      
      
   6. If your process templates has work item templates, you need to add the work item templates xml files to the folder structure.
      
      1. With your process template open in RTC, open the Links tab.
      2. In the Process Attachments section, scroll down to find entries starting with “/workitemtemplates/”.
      3. Select one line at the time and click Save As... button
      4. Save the file under jazz_integration/templates/attachments/workitemtemplates folder in your RMC library.
         
         
   7. Make sure you have all the images you need for enumerations, work flows, and work item types. If needed add image files to the respective folders under jazz_integration/templates/attachments folder.
      
      
   8. As a final step, you need to add placeholders into the base process template. These placeholders indicate to RMC where additional elements are to be inserted.
      
      The placeholders are:
      
      ${role-definitions} : indicates where roles are inserted. The placeholder must be placed in the <role_definitions> tag, as follows:
      
      <role-definitions>
      ...
      ${role-definitions}
      ...
      </role-definitions>
      
      ${workitem-types} : indicates where work item types are inserted. The placeholder must be placed with other work item type definitions, as follows:
      
      <configuration-data xmlns="http://com.ibm.team.workitem/workitemTypes" id="com.ibm.team.workitem.configuration.workItemTypes">
      ...
      ${workitem-types}
      ...
      </configuration-data>
      
      ${template-definitions} : indicates where work item templates are inserted. The placeholder must be placed with other template definitions as follows:
      
      <configuration-data id="com.ibm.team.workitem.configuration.templates" xmlns="http://com.ibm.team.workitem/templates">
      ...
      ${template-definitions}
      ...
      </configuration-data>
      
      
   9. Reopen the library so these changes can take effect.

6.4 Modify iteration types

To remove, modify, or add new iteration types:

1. Expand the jazz_integration/templates/iterations folder. You find the default iteration types that RMC presents for selection when Creating a Jazz Process Template (i.e. agile, iterative, custom, or none).
   
   
2. Delete the corresponding xml file of the iteration type you do not want to see listed.
   
   
3. Or open any of the provided xml files in a text or xml editor to edit the content. You can change iteration attributes such as: identifiers, names, start and end dates, and dependencies. Set them to your preference.
   
   
4. Or copy an existing xml file and paste it into the same folder with a different name and change the iteration attributes to your preference.
   
   
5. Reopen the library so these changes can take effect.