Managing JIRA Entities from within PPM
When a PPM request type is mapped with an entity type (such as task, story, and bug) and a JIRA project:
- Creating and moving a request of the request type to a certain workflow step in PPM would automatically create a mapped entity in the mapped project in JIRA.
- Changes in the request or the agile entity are synced between PPM and JIRA.
This allows users of both applications to participate in the processing of requests, defects, tasks, and so on.
This section details on how to manage a JIRA entity from within PPM.
What are Qualified Request Types?
If you want to manage a JIRA entity through managing a mapped PPM request in PPM, the PPM request should belong to a qualified request type.
For details, see What are Qualified Request Types?
Mapping PPM Request Types with JIRA Entity Types
When a PPM request type is mapped with a JIRA entity type, creating a request of the request type in PPM enables creating an entity of the entity type in JIRA. You can map the same PPM request type with different JIRA entity types that are managed in different JIRA projects.
To map a qualified PPM request type with a JIRA entity type:
- Add a JIRA instance. See Adding a JIRA Agile Instance.
In the Request Mapping tab of the instance, click the add icon next to Request Type Mapping.
Establish a mapping between a PPM request type and a JIRA entity type.
PPM Request Type Select a PPM request type to map. Agile Project Select a JIRA project where a mapped JIRA entity is to be created. Agile Entity Type
Select a JIRA entity type to map with the PPM request type.
For example, if you select Task, it means creating a PPM request of the request type would create a task in the JIRA project.
Whether the mapping is enabled or not.
You can only enable a request type mapping after you have set up field mappings for it.
- Click Save.
Add field mappings to enable the request type mapping.
How field mappings work
- When you create a request in PPM, the values in the request fields are auto-filled in the mapped JIRA entity fields.
When you update a field in the PPM request or JIRA entity, the field value is synced from PPM to JIRA, or from JIRA to PPM, or bi-directionally, depending on how sync direction is set for the field mapping.
How to add a field mapping
Click the add icon next to Field Mapping.
Add mappings between PPM request fields and JIRA entity fields.
For details of supported PPM-JIRA field type mappings, see Supported PPM-JIRA Field Type Mappings.
- Click Save.
- Repeat a through c to add other field mappings.
- Click in the Request Type Mapping line to enable the request type mapping.
(Optional) If you want to receive email notifications when the request type mapping error occurs or the mapping creates or updates agile entities in JIRA, set up email notifications for the request type mapping.
- Select the request type mapping, and click in the Request Type Mapping line.
- Specify when and how often email notifications are sent and sent to whom.
Email notifications provide the same information as event logs. See Viewing Event Logs.
Creating a JIRA Entity by Creating a PPM Request
- Make sure the JIRA entity type is mapped with a PPM request type, and the mapping is enabled.
- From the PPM menu, select Create > Request, and click the mapped PPM request type.
In the Create New <PPM_Request_Type> page, Agile Integration Info section, provide the following information.
Agile Instance Name Select the JIRA instance where the mapping is created. Agile Project Select the agile project where you want the JIRA entity to be created. Agile Entity Type Select the entity type that the JIRA entity belongs to. Sync Flag
- If yes, the PPM request would trigger creating a mapped agile entity in JIRA, and the value changes of mapped fields are synced between PPM and JIRA. See How Changes are Synced between PPM and JIRA.
If no, the PPM request does not trigger creating a mapped agile entity in JIRA.
If you change sync flag to no after the PPM request successfully creates a mapped agile entity in JIRA, the value changes of mapped fields are not synced between PPM and JIRA.
Agile Entity ID
Not editable when creating or update the request.
It shows link of the JIRA entity after the request is submitted and moved to a certain workflow step where the mapped agile entity is created in JIRA.
Do not edit these fields after creating the request, otherwise, the sync between the request and the agile entity may fail.
- Provide other request information.
Submit the request.
When the request moves to the workflow step where the special command
ksc_create_agile_requirement '[REQ.REQUEST_ID]'is added, an entity of the selected agile entity type is created in the selected agile project in JIRA. You can click the link in the Agile Entity ID field to open the entity in JIRA.
What if a field is required in JIRA but its mapped field in PPM request is not filled?
It might happen that a field is required when creating a JIRA entity but the field is not mapped to a PPM request field, or its mapped PPM field is not filled.
In this case, to avoid JIRA entity creation failure, PPM would give a default value to the required JIRA entity field when creating the entity.
When you create a request of a request type that is mapped with a JIRA entity type, and set the request field Sync Flag to Yes, the value changes that happen in mapped fields are synced between PPM and JIRA as follows:
- The value changes that happen in PPM request fields are immediately synced to the mapped fields in JIRA entity.
- The value changes that happen in JIRA request fields are synced to the mapped fields in PPM request the next time when the background service External Request Info Sync Service runs.
- The background service syncs the field value changes according to how the sync direction is set for each field mapping. See Sync Direction.
Event logs keep records of:
- Whether a PPM request or a JIRA entity was created, updated, or deleted.
- Date and time of the event.
- Whether an error occurs to an event.
- Other details.
To view event logs of a request type mapping,
- Select the request type mapping and click .
- You can search the log for all the events that are logged for that request type mapping or for only their error events, over the date range you specify.