Configure the Import Relationships Plugin

  Administration > Organization administration > Relationships >

Configure the Import Relationships Plugin

Previous pageNext page Print this topic! Mail us feedback on this topic!

Configuring the plugin

The plugin must be configured by a Jama organization administrator before use.

 

To configure the plugin, navigate to Admin > Plugins and select Add entry.

 

Complete the Add plugin entry fields.

 

add_plugin_entry

 

Name: This will be the display name to all users.

 

Enabled: When checked, the plugin will be available to users.

 

Class: The name of the object defined in Jama's source code. For this plugin, you can specify if this is for creating relationships within a single project, or cross-project:

 

Single project: com.jamasoftware.contour.plugin.jama.ImportRelationships
Cross-project: com.jamasoftware.contour.plugin.jama.ImportRelationshipsCrossProject

 

Type: Select Import.

 

Parameters: Configures what items you want to update with the relationship plugin. See Setting Parameters for more information.

 

Plugin Notes: This field is not required and will not be visible to end users.

 

Your completed plugin configuration will look similar to the following:

 

import_plugin

 

Once everything is correct, save the plugin.

 

Setting Parameters

 

Depending on if you want to import relationships in a single project or multiple projects, there will be four or six parameters to complete.

parentType: Defines which item Type to use for the parent (upstream) relationship.
childType: Defines which item Type to use for the child (downstream) relationship.
parentField: Defines which field to use to find the the parent (upstream) item.
childField: Defines which field to use to find the child (downstream) item.
parentProjectID: Defines the project that contains the parent (upstream) item. Only for the cross project plugin.
childProjectID: Defines the project that contains the child (downstream) item. Only for the cross project plugin.

 

Parameters can be written in any order, as long as they follow correct formatting. Each parameter is case sensitive and requires a semicolon at the end.

 

Gathering parentType and childType values

To specify the item Types, you will need the API IDs of the item Types to be related. You can find the API ID under Admin > Item Types.

 

item_id

 

For example, if you wanted to create relationships for upstream Requirements to downstream Use Cases, you would join the item Type with the corresponding API-ID:

parentType=24;

childType=25;

 

Gathering parentField and childField values

The CSV file used for import needs to contain an identifying field for each item, such as the Name or Global ID. To specify which field in the parent and child item will be used for this identification, use the system Field value. You can see which fields are available to use under Admin > Item Types > [Highlight the Item Type to be used] > Config.

 

field_name

 

For example, if you wanted to use the ID (also known as the Unique ID) for your parentField and childField, your parameters need to join the field type with the field value:

parentField=documentKey;

childField=documentKey;

 

Gathering parentProjectId and childProjectId values

To specify which projects the parent and child items are associated with, you will need the API-IDs of both projects. You can get the project API-ID under Admin > Manage all project > [select the project to be used] > API-ID.

 

project_id

 

For example, if you wanted to import relationships between a parent project with API-ID 20258 and a child project with API-ID 31548, your parameters need to join the item with the corresponding project API-ID:

parentProjectId=20258;

childProjectId=31548;