This article explains how to set up the integration between your OnePlan group/environment and Jira. There are two different available integrations between OnePlan and Jira. The use case for this article is the integration for OnePlan Plans mapped to Jira Epics.
OnePlan Setup
In order to do the OnePlan setup, you need to be an admin, meaning you are a user with Owner permissions in OnePlan.
- Log in to your OnePlan group with your Office365 account.
- Open the Admin pages by clicking on the Settings gear.
- Select Integration in the admin navigation.
- Click the + (plus) icon in the Authentication Keys section.
- Save the key name & generated key somewhere (such as in a notepad doc), as once you navigate away, the key cannot be seen. To be used at a later step in the OneConnect configuration.
Jira Setup
- Navigate to the Jira site URL to be connected (i.e. https://instance.atlassian.net/).
- Follow the instructions to ‘Create an API token’ from this Jira document: https://confluence.atlassian.com/cloud/api-tokens-938839638.html
- Save the API token that is generated. To be used at a later step in the OneConnect configuration.
OneConnect Setup
- Navigate to https://my.oneconnect.ai.
- Click Add Integration.
- Select the OnePlan & Jira connector.
There are two available integrations between OnePlan and Jira. Be sure to click the Configure button for Jira Epics and OnePlan Plans.
ONEPLAN
- Authentication Key: Enter/paste the OnePlan Key that you saved from the earlier OnePlan Setup steps.
- Click the Next button.
INTEGRATOR
- Click the Next button.
JIRA
Input the Jira authentication information and configure the settings as required.
- Jira URL
- Username
- Password: API Token (Saved from earlier step above)
- Issue Types. Specify the issue types to synchronize back into OnePlan as backlog items. Task, Bug, Story, etc.
- Epic Type. Specify the type of issue at Epic level. Plan from OnePlan will be created as the specified type in Jira.
- Check this option to bring all issues regardless if they are in sprint or not. By default, will only bring issues that are in sprint.
- Check this option to roll up sub-tasks’ resources to the parent tasks.
- Click Next when ready. Wait for the integration to finish the installation process and it will direct you to your integration.
Integration Information
Functionality
This integration has these main use cases for functionality.
- Create/Update Epic level item type in Jira
- On creation, user will be required to specify the Project where the epic will belong in Jira
- Create/Update plan in OnePlan
- Create/Update backlog in OnePlan from Jira issue types associated with the connected project
- Issue types synchronized are based on the ones specified in OneConnect
Scheduled Jobs
The following scheduled jobs are installed by default.
-
SynchLookups
- Used to synchronize “Project Names” and “Jira Issue Priority” as choice values in OnePlan
-
OnePlanUpdate
- Create/Update plan in OnePlan
- Create/Update backlog in OnePlan
-
OnePlanPublish
- Create/Update Epic level item type in Jira
Default Fields Created
In OnePlan:
- Jira Project Names
- Created on the Plan level field and is used for specifying which Project the plan will belong in Jira (Epic Level)
- Type: Choice field
- SynchLookup will be the job that runs the synchronization to fill out the project types
Default Field Mappings
Plans (OnePlan) <--> Epics (Jira)
OnePlan Fields |
Direction | Jira Fields |
|---|---|---|
Name |
<--> | Summary |
| Owner | <--> |
Assignee |
Jira Project Names |
<--> |
Project Name (Epic) |
Backlog (OnePlan) <--> Issues (Jira)
OnePlan Fields |
Direction | Jira Fields |
|---|---|---|
Name |
<--> |
Summary |
Parent ID (Structure) |
<--> |
Parent Issues ID |
| Item Type | <-- |
Issue Type |
| Assigned To | <-- |
Assignee |
| Points | <-- |
Story Points |
| Iteration (OnePlan System) | <-- |
Sprint Name (With Board) |
| Start | <-- |
Start Date (Sprint) |
| Due | <-- |
End Date (Sprint) |
| Status | <-- |
Status |
| Effort | <-- |
Original Estimate |
LookupTables (OnePlan) <--> LookupEpics (Jira)
OnePlan Fields |
Direction | Jira Fields |
|---|---|---|
Jira Project Names (Plan) |
<--> |
Project Names |