This article explains the Jira Epics to OnePlan Plans default field mappings for your integration.
After the integration is installed, it is best practice to check the default field mappings for errors or missing mappings.
After reviewing the field mappings, continue on to Jira Integration - Custom Types Settings.
OnePlan Changes
Once the integration is complete, three things will occur in the OnePlan integration page:
- An integration line item is made.
- An integration event is created.
- An integration is established, signifying the successfully setup and activation of the synchronization process between OnePlan and Jira.
- Jira is now available in the Connected Systems icon.
- After completion, Jira becomes accessible within the Connected Systems icon, indicating its successful integration with OnePlan.
Integration Line Item Details
Each entry in the Integration section provides an overview of OneConnect Integrations associated with the OnePlan Work Plan, offering a comprehensive list of connected systems.
Integration Events and Data Synchronization
Integration events facilitate automated responses, allowing data transfer from OnePlan to Jira. When triggered, the OnePlanPublish strategy is activated for any item linked to Jira. This process ensures that mapped values from OnePlan are updated within Jira.
Triggers for Event Activation
- At the plan details page in OnePlan: This occurs after modification and automatic saving of an item.
- At the backlog section in OnePlan: This action is initiated after editing a field and clicking Save.
Identify Connected Systems
Any item connected to Jira will display the Jira icon on both the My Portfolio page and the Work Plan Backlog page, indicating the association between plans/tasks and Jira.
Connected Items
To link an item from OnePlan to Jira:
- Navigate to the Work Plan – Backlog page.
- Click on the plug icon (Connected Systems Icon).
- Select the option to connect to an existing item in Jira or create a new item.
- Once connected, the Connected Systems window allows for Import, Export, or Opening of the Jira plan-level item.
OnePlan Fields |
Jira Fields |
Direction |
Notes |
Name | Summary | Both | Required |
Portfolio Plan Type | Issue Type | Both | Recommended |
Owner |
Assignee |
Both |
Recommended |
OnePlan Fields |
Jira Fields |
Direction |
Notes |
Assigned To |
Assignee |
Both |
Recommended |
Effort |
Original Estimate |
JIRA to OP |
|
Due |
End Date (Sprint) |
JIRA to OP |
|
Item Type |
Issue Type |
Both |
Required |
Name |
Summary |
Both |
Required |
Iteration (OnePlan System) |
Sprint Name (With Board) |
Both |
|
Parent Id (Structure) |
Parent Issues ID |
Both |
Recommended |
Points |
Story Points |
JIRA to OP |
|
Start |
Start Date (Sprint) |
JIRA to OP |
|
Status |
Status |
JIRA to OP |
Value Mapping Recommended |
The following scheduled strategies are installed by default:
SynchLookup
The SynchLookup strategy is designed to update the Jira Project Names choice field in OnePlan. It works by retrieving the list of Jira projects available within the Jira environment by populating them as options in the choice field. This Strategy:
- Only updates the list of available options in the choice field.
- Does not assign values to the choice field for individual plans.
Jira Project Names is not a field created automatically by the integration. The field will have to be created by a OnePlan Administrator at the Plan level to be mapped.
SynchLookup Field Mapping Requirements
For the SynchLookup strategy to function correctly, a field mapping must be created in the Lookup Tables – Lookup Tables section. This mapping should be configured as follows:
- Mapping direction: OnePlan <- Jira
- Field Mapping: Jira Project Names (Plan) <- Project Names
OnePlanUpdate
Publish data from Jira to OnePlan.
This strategy has a filter within the Jira - OnePlan > Epics - Plans section. This filter will only bring Epics from Jira over into OnePlan only if the item is already connected. If this filter is removed (and not replaced with an alternative filter), all Epics (and the associated Issue Types listed) within the Jira Organization will be brought over into OnePlan.
This strategy will bring in all Jira Epics (or equivalent issue type) and their associated issues into OnePlan. It is recommended that a filter be put in place to limit what issue types are desired to be brought over. To facilitate large-scale data manipulation, this strategy now efficiently processes multiple records simultaneously. Additionally, for consistency and accuracy alignment between Jira and OnePlan, the strategy will automatically remove tasks from OnePlan if they are deleted in Jira. This deletion specifically applies to backlog items and does not affect plans within OnePlan.
OnePlanPublish
Publish data from OnePlan to Jira.
This strategy has a filter within the OnePlan – Jira > Plans – Epics section. This filter will only bring plans from OnePlan over to Jira if the Jira Project Names field has a value selected. If this filter is removed (and not replaced with an alternative filter), the strategy will fail for each plan that does not have this field filled in within OnePlan.
This strategy will bring in all OnePlan Plans and their associated backlogs into Jira. It is recommended that a filter be put in place to only bring in Plans that have a Jira Project Name filled in be brought over to Jira for the strategy to not fail.
If you want to publish data from OnePlan to Jira, please make sure that you have a mapping for the "Jira Project Names" OnePlan field and corresponding lookup table. (see below the mapping details)
If you don't have a field called "Jira Project Names" in OnePlan, then create a plan level Choice field and name it exactly "Jira Project Names".
Example:
Once you have the plan level field in OnePlan, map it in OneConnect on the plan level in your Jira integration.
OnePlan Field |
Jira |
Direction |
---|---|---|
Jira Project Names |
Project Name (Epic) |
Both |
Example:
Setup the corresponding lookup table mapping, by mapping the "Jira Project Names" lookup table on the OnePlan side to the "Project Names" lookup on the Jira side.
OnePlan Lookup Table |
Jira Lookup Table |
Direction |
---|---|---|
Jira Project Names (Plan) |
Project Names |
Both |
Example:
OnePlanPalnItemsCleanUp (Obsolete)
This strategy previously deleted OnePlan task/backlog items that had been deleted from Jira. Notably, this strategy did not delete plans from OnePlan.
Current Status:
This functionality has been fully incorporated into the OnePlanUpdate strategy, rendering this standalone strategy obsolete.