Skip to main content

Jira Epics Integration - Integration Setup

© 2024 OnePlan Solutions. All Rights Reserved.
Download Article

Jira Epics Integration - Integration Setup

  • Updated

This integration is designed to synchronize data between OnePlan and Jira. In Jira, each Epic or its equivalent will be mirrored in OnePlan as a plan-level item. Additionally, within the Jira Connector, any specified Jira issue types in the Jira Issues to OnePlan Backlog field will be imported into OnePlan's Work Plan - Backlog section.

OnePlan

For the integration configuration, you will need to collect the following information from OnePlan:

  • the group name

  • an authentication key

  • the authentication key name

To complete the OnePlan setup, you need to be an admin (user with Owner permissions) in OnePlan.

  1. Log into your OnePlan group using your OnePlan login credentials.
  2. Access the Admin pages by clicking on the settings (gear) icon at the top right of the browser.  
  3. Navigate to the Integration section in the left-hand navigation panel.
  4. Next to the Authentication Keys section click the + Add Key button.
  5. Provide a descriptive name or title for the Authentication Key to denote its purpose, then click ADD. 
  6. Store the OnePlan group name and the Authentication Key securely. This grants access to your OnePlan group for any program. Please note that the key will no longer be visible after the page is refreshed.

Note: It's recommended to generate a new authentication key for every integration and assign a descriptive name to each key, enabling clear association with its corresponding integration. This practice enhances security, simplifies management, and facilitates easier tracking and troubleshooting.

2024 Authentication Key Img.png

Jira

For the integration configuration, you will need to collect the following information from Jira:

  • Jira URL (e.g., https://{OrganizationName}.atlassian.net)

  • Jira Email

  • API token

To generate an API token in Jira:

  1. Log into Jira.

  2. Navigate to id.atlassian.com/manage-profile/security/api-tokens.

  3. Click Create API Token. A new window will appear.

  4. Give the API Token a unique Label/Title.

  5. Click Create. The API Token will appear.

  6. Click Copy. Green text will appear below the API Token field saying: API token copied to clipboard.

  7. Click Close.

OneConnect Setup Process

To complete the OneConnect setup, you need to be an Administrator or Editor in the OneConnect group you wish to set the integration up in.

  1. Go to https://my.oneconnect.ai (or https://eu.oneconnect.ai for European customers utilizing eu.oneplan.ai).

  2. Navigate to Jira Epics and OnePlan Plans. Click the Configure.

Jira_Epics_Integration_-_Select.png

OnePlan Connector

  1. Group Name
    • Input the name of the OnePlan Group name you intend to integrate with.
  2. Authentication Key
    • Paste the generated OnePlan Authentication Key obtained from OnePlan.
  3. Additional Options
    • Expand the section for additional configuration options.
  4. (Optional) Alternative OnePlan Environment URL
  5. (Optional) Button name
    • If integrating multiple Jira environments with a single OnePlan group, customize the name for the Jira button linked to the listed Jira environment.
  6. (Optional - Checkbox) Sync to Schedule
    • Unchecked: All listed work item types from Jira will be imported into the OnePlan Backlog.
    • Checked (Default): Allows users to manually bring in work item types from Jira to enter the OnePlan Schedule. For more information on this functionality, please review the Sync to Schedule functionality. 
  7. (Optional) OnePlan Default Plan Type
    • Specify a default plan type if the integration doesn’t automatically provide a plan type for plan-level work items in OnePlan. Enter a single value for this purpose.
  8. Test Connection
    • Click Test to verify the correctness of the connection settings to OnePlan.
    • A notification indicating Connected Successfully should appear in the top-right corner of the browser upon successful testing.
  9. Save Changes
    • After verifying the connection, click Save to retain the configured settings.
    •  
  1.  

Jira Connector

  1. Jira URL

    • Enter the URL of your Jira environment (e.g., https://{OrganizationName}.atlassian.net).

  2. Email

    •  Enter the Jira email to be used to access environment.

    • Note: It's recommended to use a service account for Jira access. 
  3. Jira API Token
    • Provide the API Token to access the Jira account.
  4. Additional Options
    • Expand the section for additional configuration options.
  5. Jira Issues to OnePlan Backlog
    • Enter the desired issue type(s) from Jira intended to be imported into OnePlan as Work Plan- Backlog items. Default types include Task, Bug, Story, and Sub-task. 
  6. Jira Issue to OnePlan Plan
    • Specify a single Jira issue type to be recognized as the plan-level work item in OnePlan. Default issue type is Epic.
  7. (Optional - Checkbox) Sync all issues in the backlog
    • Unchecked (Default): All issue types listed that are assigned to a sprint, will be imported.
    • Checked: All issue types listed, even those not assigned to a sprint, will be imported.
  8. (Optional - Checkbox) Roll up sub-tasks, and resources to its parent
    • Unchecked: Jira backlog items in OnePlan will each be assigned to their individual tasks.
    • Checked: Any child backlog items with unique user assignments will be aggregated under the parent backlog item.
  9. (Optional - Checkbox) Utilizing Jira Server
    • Check if authentication to Jira is through Jira Server; leave unchecked for authentication routed through the cloud. 
  10. (Optional - Checkbox) Apply Deltas at the Task level
    • Unchecked: The strategy will solely detect modifications at the plan level.
    • Checked: The strategy will encompass modifications made to the task/backlog items.
  11. (Optional - Checkbox) Use Bearer Authorization
    • Check to utilize bearer authorization for Jira on-premises environments.
  12. (Optional - Checkbox) Use Pre-filter functionality
    • Unchecked (Default): Retrieves all available data at the outset, then applies filters to the dataset.
    • Checked: Applies filters to refine the data queried at the outset, optimizing the information retrieval process. Please navigate to Jira Epics - Pre-Filter Functionality, for more information on pre-filters. 
  13. Test Connection
    • Click Test to verify the correctness of the connection settings to Jira.
    • A notification indicating Connected Successfully should appear in the top-right corner of the browser upon successful testing.
  14. Save Changes
    • After verifying the connection, click Save to retain the configured settings.

Related articles

Comments

0 comments

Please sign in to leave a comment.