Set up the Microsoft Planner integration

  • Updated

This article explains how to set up the integration between your OnePlan environment and Microsoft Planner.

There are several ways to connect to Microsoft Planner. Please review this article before you make a decision.

OnePlan

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

Enable OnePlan App Permissions

These steps will require action from the client's Tenant Administrator to enable app permissions and consent on behalf of the organization. 

  1. Log into your OnePlan group using your OnePlan login credentials.
  2. Open the OnePlan Getting Started setup form. This can be found by clicking on the question mark circle 2.png icon in the top right of your OnePlan page, and selecting Getting Started. 
  3. Navigate to Step 5 - Integrations, and click on Microsoft Teams - Enable Permissions link to allow the tenant administrator to grant permissions. 
    1. The tenant administrator will have to provide their tenant credentials to approve the app permissions on behalf of the organization. 

What the Microsoft Teams - Enable Permissions button grants OnePlan

When enabled, OnePlan will be granted the following Delegated permissions within the OnePlan Enterprise App in Entra ID:

  • Microsoft Graph - Group.ReadWrite.All
  • Microsoft Graph - Team.ReadBasic.All

These permissions are required because the Microsoft Planner integration can both create new groups and add plans to existing groups, depending on how you choose to connect your OnePlan plan to Microsoft Planner. The Group.ReadWrite.All permission specifically enables these capabilities. 

OneConnect Setup Process

To complete the OneConnect setup, you need have Administrator or Editor privileges in the OneConnect group you wish to set the integration up in. If using an alternative OnePlan environment than my.oneplan.ai, follow these steps:

  1. Go to https://my.oneconnect.ai (or https://eu.oneconnect.ai for European customers utilizing eu.oneplan.ai).
  2. Navigate to OnePlan and Microsoft Planner. Click 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. Additional Options
    • Expand the section for additional configuration options.
  4. (Optional) Alternate OnePlan Environment URL
  5. 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.
  6. Save Changes
    1. After verifying the connection, click Save to retain the configured settings.

Microsoft Planner Connector

There are multiple ways to connect to Microsoft Planner via the integrations. Please review the supported Authentication Methods to decide what is the best option for your company. 

  1. (Optional - Button) Authorize
    • If you want to use the OnePlan created Enterprise Application in Microsoft Entra ID to connect to Planner, click on the blue Authorize button. This will add the Enterprise Application to your tenant. This will require the Organization’s Tenant Admin to log in and accept the permissions. Please note that the ‘Authorize’ button needs to be clicked only once during the setup.
  2. (Optional – Checkbox) Use integration credentials to connect to Planner
    • (Default) Unchecked :When this option is not selected, then the integration connects to Planner using the user's account who is logged into OnePlan, there is no need for a username and password to be configured. You can proceed by simply clicking the blue Authorize button.
    • Checked: If this option is selected, a username and password are required and those will be used to connect to Planner. This is the so called "Service Account" approach. However, providing a Client Id an Client Secret is still optional if the blue Authorize button was used.
  3. (Optional) Username
    • Enter the username to be used to access Planner. A username and password must be entered if the "Use integration credentials to connect to Planner" checkbox is checked.
    • Note: The username must not have Multi-Factor Authentication (MFA) associated with it. Because of this, we encourage a service account to be used to access Planner.
    • Note: It is standard best practice to have a single service account associated with a single integration. If a service account is associated to multiple integrations, throttling can occur from Microsoft, which can lead to strategy failures.
  4. (Optional) Password
    • Enter the password for the account. 
  5. Additional Options
    • Expand the section for additional configuration options.
  6. (Optional) Client Id (Entra App Id)
    • Enter the Client Id generated from Entra Id, in case you use your own application in Microsoft Entra Id.
  7. (Optional) Client Secret (Entra App Secret)
    • Enter the Client Secret generated from the Entra Id, in case you use your own application in Microsoft Entra Id.
  8. (Optional) Plan Prefix Text
    • Some organizations have prefix requirements for their groups configured in Microsoft Entra ID (via a Naming Policy). If there is a value within this text field, that value will be prepended to the Plan name before being exported to Planner to fulfill those organizational requirements.
  9. (Optional) Plan Suffix Text
    • Some organizations have suffix requirements for their groups configured in Microsoft Entra ID (via a Naming Policy). If there is a value within this text field, that value will be added to the Plan name before being exported to Planner to fulfill those organizational requirements.
  10. Test Connection
    • Click Test to verify the correctness of the connection settings to SharePoint/OneDrive.
    • A notification indicating Connected Successfully should appear in the top-right corner of the browser upon successful testing.
  11. Save Changes
    • After verifying the connection, click Save to retain the configured settings.

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.