This article explains how to set up an integration for SharePoint list items to become plans in OnePlan.
To complete the OnePlan setup, you need to be an admin (user with Owner permissions) in OnePlan. If the Advanced Settings are NOT enabled, contact OnePlan for assistance.
-
Log into your OnePlan group using your OnePlan login credentials.
-
Access the Admin pages by clicking on the settings (gear) icon at the top right of the browser.
-
Navigate to the Integration section in the left-hand navigation panel.
-
Next to the Authentication Keys section click the + Add Key button.
-
Provide a descriptive name or title for the Authentication Key to denote its purpose, then click ADD.
- 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.
-
Go to https://my.oneconnect.ai (or https://eu.oneconnect.ai for European customers utilizing eu.oneplan.ai).
-
Click on the SharePoint Lists to OnePlan Plans integration tile. Click Configure.
SharePoint Connector
-
SharePoint URL
- Enter the SharePoint URL where the file is located (e.g., https://{OrganizationName}.sharepoint.com/sites/{SiteName}). Note: We do not support SharePoint Server.
-
Username
- Enter the username.
- Note: Ensure that the provided username does not have Multi-Factor Authentication (MFA) associated with it. It is recommended to use a dedicated service account to access the SharePoint site. Best practice dictates one service account per integration to avoid data throttling and potential strategy failures by Microsoft.
-
Password
- Enter the password.
-
(Optional – Checkbox) SharePoint Modern Authentication
- For more information on how to set up SharePoint Modern Authentication. If this box is checked, please enter the Client Id and Client Secret in the Additional Options section.
-
Additional Options
- Expand the section for additional configuration options.
-
(Optional) Client Id
- If using Modern Authentication, enter the Client ID generated from the SharePoint site.
-
(Optional) Client Secret
- If using Modern Authentication, enter the Client Secret generated from the SharePoint site.
-
SharePoint list names to import
- Enter the names of all lists intended for integration into OnePlan. It is crucial that these names correspond exactly to the front-end names of the respective lists in SharePoint.
-
(Optional - Checkbox) Check this box if only single list specified
- If importing a single SharePoint list to OnePlan, check this box. This will add the SP List ID field mapping to their integration.
-
(Optional) Email Copy To
-
To include someone else that is not already being notified of this integration status, enter the email here.
-
-
(Optional) If you are using an Entra service principle to connect to SharePoint
- Click here to learn more about connecting SharePoint via Entra service principals.
- Expand the section called Advanced Options
- Check the "Use a Service Principal to connect to SharePoint Online" checkbox.
- Click the Authorize button. (you must be a tenant administrator to do that)
-
Test Connection
- Click Test to verify the correctness of the connection settings to SharePoint.
- A notification indicating Connected Successfully should appear in the top-right corner of the browser upon successful testing.
-
Save Changes
- After verifying the connection, click Save to retain the configured settings.
OnePlan Connector
-
Group Name
- Input the name of the OnePlan Group name you intend to integrate with.
-
Authentication Key
- Paste the generated OnePlan Authentication Key obtained from OnePlan.
- Additional Options
- Expand the section for additional configuration options
-
(Optional) Alternate OnePlan Environment URL
- If using an environment other than the default (https://my.oneplan.ai), select the appropriate URL from the available options:
-
(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.
-
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.
-
Save Changes
- After verifying the connection, click Save to retain the configured settings.
Integration Information
OnePlan Changes
Once the integration is complete, an integration event will be created within the OnePlan integration page.
Integration Event
Integration events are automated responses that will bring data over from OnePlan into SharePoint List.
What this event does is trigger the OnePlanToSharePoint strategy for any item that is connected to the SharePoint list. This will bring any values that are mapped to go from OnePlan to SharePoint to be updated.
What triggers this event is after a connected item has been saved in OnePlan.
Default Field Mappings
SP List(s) - Plans
|
SharePoint Fields |
OnePlan Fields |
Direction |
Notes |
|---|---|---|---|
|
Title |
Name |
Both |
Required |
|
SP List ID |
SP List Name |
Both |
Recommended Field Mappings
|
SharePoint Field |
OnePlan Field |
Direction |
Notes |
|---|---|---|---|
|
Custom Column Name |
Portfolio Plan Type |
SharePoint to OnePlan |
Recommended |
We highly recommend that a column be made within SharePoint list (Text or Choice) and in that column, have the name of the plan type desired be listed. The out of the box options are Portfolio, Program, Project, Epic, Objective, Idea, & Key Result. If this field mapping is not included, all list items will be assigned the Plan value listed in the OnePlan connector.
If the SharePoint list is brought into OnePlan without this field mapping or a valid value in the OnePlan connector, the list items will not appear in My Portfolio, however, the list items will be located at Home -> Plans section -> click All Plans.
The following scheduled jobs are installed by default.
This strategy syncs Projects from SharePoint to OnePlan
Sync list from SharePoint to OnePlan
If the SharePoint list items have already been imported into OnePlan and are not visible in My Portfolio, these steps can have the SharePoint list item show in My Portfolio:
-
Going to Home Page. In the bottom left panel labelled Plans, click on the All Plans tab to see all plans that are created.
-
Click on the Hamburger icon on the left of the plan name and select Reorganize. A new window will appear.
-
Select the Plan Type desired. Then click Reorganize.
-
The Plan item will now appear in My Portfolio.
Integration Limitations
Integration intended for OnePlan Plan Fields
This integration is intended to create plans and assign values to the fields listed in the OnePlan Configuration > Fields section.
The only exception to this is the ability to assign a Name, an Owner, and a Plan Type to the plan. No other system fields or Plan features can be set (Favorite, Shared With, Comments, etc.).