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

To configure a Jira integration in OneConnect, the following information is always required, regardless of the authentication method selected:

  • Jira URL
    Example: https://{OrganizationName}.atlassian.net

  • API Token
    A Jira API token generated from Atlassian

OneConnect supports multiple Jira authentication methods, which may require additional fields or authorization steps during setup (such as a username, OAuth app details, or an authorization flow).

Before configuring the integration, review the Jira Authentication Methods documentation to understand which authentication option is best suited for your environment and what additional information may be required.

 

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. Click on the Add Integration button.
  3. Navigate to Jira Epics and OnePlan Plans.
  4. Click the Configure.

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. (Optional) Authentication Key Name
    • Displays the name of the OnePlan Authentication Key associated with this integration. This field is for reference and tracking purposes only and does not impact the functionality of the integration. 
  4. Additional Options
    • Expand the section for additional configuration options.
  5. (Optional) Alternative OnePlan Environment URL
  6. (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.
  7. (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. 
  8. (Optional) OnePlan Default Plan Type
    • Specify a default plan type if the integration doesn’t automatically provide a plan type for plan-level items in OnePlan. Enter a single value for this purpose.
  9. 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.
  10. Save Changes
    • After verifying the connection, click Next to retain the configured settings.
  •  
Jira_Projects_-_Configuration_-_OnePlan.png

Jira Connector

  1. Jira URL
    • Enter the URL of your Jira environment (e.g., https://{OrganizationName}.atlassian.net).
  2. Username
    • 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 Plan Level Types (Comma Separated)
    • Specify Jira issue type(s) to be recognized as the plan-level work item in OnePlan. Default issue type is Epic.
  6. Jira Issue to OnePlan backlog/schedule (Comma Separated)
    • 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.
  7. (Optional - Checkbox) Sync all issues in the backlog
    • Unchecked: All issue types listed that are assigned to a sprint, will be imported.
    • Checked (Default): 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 (Default): 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) Apply Deltas at the Task level
    • Unchecked: The strategy will solely detect modifications at the plan level.
    • Checked (Default): The strategy will encompass modifications made to the task/backlog items.
  10. (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. 
  11. Advanced Options
    • Expand the section for advanced configuration options relating to alternative authentication methods.
  12. (Optional) Authorize button
    • If you are using Tokens with Scope, use this button during the setup process. See the setup steps for the token here. 
  13. (Optional) Custom Url
    • This should only be used for integrations that reference custom code. The URL will be provided by OnePlan. 
  14. (Optional - Checkbox) Utilizing Jira Server
    • Check if authentication to Jira is through Jira Server; leave unchecked for authentication routed through the cloud. 
  15. (Optional - Checkbox) Use Bearer Authorization
    • Check to utilize bearer authorization for Jira on-premises environments.
  16. (Optional - Checkbox) Use this integration in the Jira Marketplace app
    • If checked, this integration will be used by the OnePlan app installed from the Atlassian Marketplace.
  17. (Optional - Checkbox) Do not use enhanced search API
    • This is mainly for on-premise customers who use Jira's older APIs that are different than the latest cloud APIs that are in use. 
  18. (Optional - Checkbox) Use Jira Token with Scopes
    • Check to use Tokens with Scope. Make sure you fill out the Jira API Token, Client Id, Client Secret, Cloud ID and Scopes for Jira App. After entered, a Jira Administrator must click on the Authorize button. Review the Jira Authentication Methods page prior to using this method. 
  19. (Optional) Client Id
    • Used only if the token type is "Tokens with scopes". Enter the Client Id that was generated during the token setup.
  20. (Optional) Client Secret
    • Used only if the token type is "Tokens with scopes". Enter the Client Secret that was generated during the token setup.
  21. (Optional) Cloud ID
    • Used only if the token type is "Tokens with scopes". Enter the Cloud ID that was generated during the token setup.
  22. (Optional) Scopes for the Jira App
    • Used only if the token type is "Tokens with scopes".
  23. 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.
  24. Save Changes
    • After verifying the connection, click Next to retain the configured settings.

Was this article helpful?

1 out of 1 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.