Jira Project Integration - Integration Setup

  • Updated

This integration focuses on synchronizing data between OnePlan and Jira. Each Jira Project will come into OnePlan as a Plan level item, and all the listed Jira issue types will come into the OnePlan Work Plan – Backlog section as tasks.

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. Open the Admin pages by clicking on the settings (gear) icon located on the top right of the browser.
  3. Select the Integration section on the lefthand navigation panel.
  4. Adjacent to the Authentication Keys section click the + Add Key button.
  5. Give the Authentication Key a name/title to indicate what it is to be used for, once named, click ADD
  6. Save the OnePlan Group Name and the Authentication Key somewhere safe, as this will give any program access to your OnePlan group. The key will no longer be viewable once the page refreshes.

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 have 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 Project and OnePlan Plans. Click the Configure button.
Jira_Projects_-_Select_Integration.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) 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.
  7. 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
  8. Save Changes
    • After verifying the connection, click Save 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. Email

    • Enter the designated Jira email for accessing the 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.

      Jira_Projects_-_Configuration_-_Jira.png

       

  6. (Optional - Checkbox) Sync all issues in the backlog
    • Unchecked (Default): All issue types listed that are assigned to a sprint, will be imported.
  7. (Optional - Checkbox) Roll up sub-task 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.
  8. (Optional - Checkbox) Utilizing Jira Server
    • Check if authentication to Jira is through Jira Server; leave unchecked for authentication routed through the cloud.
  9. (Optional – Checkbox) Set unassigned project assignees as Unassigned
    • In Jira, the project assignee is usually set to be the Project Lead. When this box is checked, the Project Assignee will be changed from the Project Lead to show as Unassigned within OnePlan

  10. (Optional - Checkbox) Use Bearer Authorization

    • Check to utilize bearer authorization for Jira on-premises environments.

  11. 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.
  12. Save Changes
    • After verifying the connection, click Save to retain the configured settings.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request