How To Create A Template Project

Amanda Jennewein
Amanda Jennewein
  • Updated

Introduction

A best practice in administering Jama Connect is to create a Template Project that can be reused/duplicated as necessary.

Creating a Template Project has the following benefits:

Standardize methodology 

  • A Template Project is an excellent way to enforce standardization of the requirements management and testing ​processes using the same data templates and relationship rule configuration.
  • Each team may operate in their project in Jama, allowing flexibility and customization at the project level for things like a project tree structure, tags, release list, and workflows.

Increase speed for setting up new project teams.

  • Remove the need to recreate project configuration each time a new Jama project begins. This saves time and reduces redundant work.

Decrease context switching between projects.

  • Create a familiar way of working across Jama projects.
  • Teams do not need to learn new terminology or think about new configurations when switching between Jama projects.
  • The Template Project should feel familiar to teams involved in other Jama projects, leading to setup faster, training, and adoption.

Enable reuse across multiple projects.

  • Teams can use Jama's reuse and synchronization capabilities, allowing them to reuse assets and compare across projects for differences easily.
  • Leverage custom scripts (that perform functions outside of core Jama functionality) and custom exports across multiple projects. 

This article will provide a step-by-step guide to creating a Template Project. Individuals must have Org Admin rights to complete the steps outlined in this article. The steps covered will be.

  1. Determine the appropriate development methodology for your teams
  2. Tag existing Item Types that best fit your development methodology or create new item types
  3. Create a Relationship Rule to provide your team's development methodology
  4. Create the actual Template Project and associate it with the Relationship Rule
  5. Create the Project Explorer Tree (filing cabinet/organization of data) for the Template Project
  6. Create workflows, if needed. Remember the connection between workflows and picklists in Jama
  7. Duplicate the Template Project for actual Production Projects

How to Execute

Step 1: Determine your methodology 

The first step for all teams implementing Jama is thorough discovery. Whether organizations use classic Systems Engineering, Agile, Hybrid, or unique models, teams can configure Jama Connect to align with these methodologies. Your team's methodology directly informs how your template project will be configured. 

The shift into Jama will be a large part of the discovery process. 

Moving from a document-centric process to an item-based approach is critical to any successful implementation of Jama. Creating a Template Project as a by-product of this discovery process will save time in the future. Existing methods, systems, and methodologies can easily be copied and should seem more familiar to the execution teams.

Step 2: Determine your Item Types

Jama Connect is a database-driven, item-based platform. The shift from a document-based approach to an item-based approach is critical to the discovery process and, ultimately, the adoption of Jama Connect within an organization.

Your team's development methodology comes into play here. Classic Systems Engineering processes might use Item Types like System Requirement, High-Level Requirement, and Low-Level Requirement. Agile teams may use Strategic Themes, Software Requirements, Epics, and User Stories. Many teams employ a mix.

All of these items can be uniquely described with metadata. What is the item's status, and which team member is assigned to the test? These are fields in an Item Type. Your requirements can have custom fields based on their types.

Here are some best practices to remember when creating new Item Types.

  1. Go to Admin > Item Types and determine which out-of-the-box items your organization will utilize. Leverage the description field (click "Edit" and add your organization's name to the Item Type description). This helps provide context and another level of categorization for the item type.
    Screen_Shot_2020-05-04_at_7_30_09_AM.png
  • Deleting unused items is recommended to declutter the Item Types view and improve navigation. 

    CONFIGURE PROJECT ITEM TYPES

    Leverage recommended 'Widgets' per item type. Widgets are assigned when creating new Item Types or editing existing Item Types. Widgets add additional functionality to Items. It is recommended to make the following widgets available: Activities, Relationships, Versions, and Synchronized Item Widgets—product User Guide

    Step 3: Create your Relationship Rule

    Relationships in Jama are established between discrete items (e.g., Stakeholder Requirement A to System Requirement X). An essential step in creating a project template is determining what relationships are permitted based on your methodology. For example, an organization may have a process that dictates a stakeholder requirement that can relate to a system requirement but should not relate directly to a subsystem requirement. Relationship Rules established by the Jama Administrator are applied to projects to drive conformity to the desired decomposition model.

  •  
  • Setting up the relationship rule for your item types is critical because it enforces the methodology your organization wants to use in Jama. Applying the relationship rule to the Template Project ensures it is also used for any projects generated from the template.

     Here is a link to the Jama help section on the Relationship Rule Diagram 

     

  • Step 4: Create the Template Project

    It's time to create the Template Project.

    Could you give the Template Project a Project Key and Name? The Template Project can also be placed in its own Project folder for another layer of organization. You can easily apply appropriate permissions to template projects to limit read/write access. 

    Once the new project has been saved, visit the Admin page and Project tab. Select your Project Template and go to the Item Types tab. Configure the visible item types at the project level and remove any unwanted or unused Item Types from the Template Project.

Here is an article on Item Configuration at the Project level. 

After applying these changes, go back to Admin > Relationships and click to add the new Template Project with the Relationship Rule created in Step 3.

Screen_Shot_2020-05-04_at_7_34_43_AM.png

You can find more information on Project configuration.

Step 5: Create a template project structure

The Project Explorer Tree structure must be created after the backend structure for the Template Project is finished.

Establishing the Project Explorer Tree structure within the Template Project is crucial. This structure will be replicated from the template project into new projects, thus acting as the foundation for any new ventures. This advantage of using templates reduces the time and effort required for new projects.

Think of this as a "filing cabinet" for the project, where all underlying Items will live in containers. This structure allows teams to stay organized. Containers can group items by functional areas.

New items can be added to each section in the Tree or imported via MS Word or MS Excel to create new items of a specific type and level.

Screen_Shot_2020-05-04_at_7_35_36_AM.png

 

Here is what a complete Project Tree might look like...

Screen_Shot_2020-05-04_at_7_36_24_AM.png  

Components, Sets, and Folders in Jama Connect®

Step 6: Determine the Status Workflow for Item Type(s)

Note: This step is optional and based on your team's needs. 

Jama's Workflow capability allows Admins to constrain and direct item status values for alignment with a state-transitioning model typical of requirements—the Workflow constrains the "next available" state based on an item's current state. For example, a requirement in Draft may transition to Review, while an item in Review may transition to Accepted or Rejected. Workflows are defined per Item Type by the Jama Admin. Item Types included in a project template will automatically apply the Workflow if configured by the Admin. 

Screen_Shot_2020-05-04_at_7_37_53_AM.png

 

Before configuring Workflow for a specific Item Type, you must create a Picklist and attach a new field to the relevant Item Type linked with this Picklist.

Refer to the help guide on how to create and edit Picklists. 

Step 7: Create your Production Project!

At this point, the Template Project is ready to be used. In Admin > Projects, select the Template Project. Under Actions, determine 'Duplicate Project.'Below are the available configuration options, each explained:Screen_Shot_2020-05-04_at_7_39_54_AM.png

  1. New Project Name - provide a name for the project that is easily identifiable for the teams using Jama.
  2. Project Key - Set an alphanumeric project key. This key is unique and will show up on all items as part of the individual item ID generated by Jama. 
  3. Check items to include in copy - Select all settings to copy over. This way, additional configurations will be copied over to the new project.
  4. Do Not Check "Synchronize". Synchronization may be valuable for another use case (e.g., creating a variant from an existing product), but this should not be used when creating a new Project from the Template. For more information on Synchronization functionality within Jama, see the help guide - https://help.jamasoftware.com/ah/en/manage-content/reuse-and-synchronization/synchronization.html.
  5. Do Not Check "Create Relationships." This function is more relevant if duplicating a production project with content where you want a relationship to the source.
  6. Click "Duplicate Project". The new project is created in Jama and uses all the various item types, relationship rule configurations, and project structures you've set up in the Template.

Related to

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.