OnePlan Migration Tool - Setup

  • Updated

The OnePlan Migration Tool facilitates the import of structured data from comma separated (CSV UTF-8) files into OnePlan. It supports various OnePlan entities and is designed for one-time migrations, not ongoing integrations.

OnePlan

To complete the OnePlan setup, you need to be an admin (user with Owner permissions) in OnePlan. If the Advanced Settings are enabled for your group, continue to the next steps. If the Advanced Settings are NOT enabled, contact OnePlan for assistance.

Required Authentication Key Permissions: OnePlan Migration Tool

Create an authentication key for this integration in OnePlan. For the steps to create a key, see How to Create and Rotate Authentication Keys in OnePlan. When you create the key, select the following settings.

Global Scopes — None required. Leave OData and Backup cleared.

Data Type Permissions
Configuration Read
Plans Read, Create, Update
Workplan Read, Create, Update
Resources Read, Create, Update
Resource Plans All (Read, Create, Update, Delete)
Financials All (Read, Create, Update, Delete)
Integrations Read, Create, Delete

Note: Selecting Update or Delete also selects Read. The Integrations permissions allow OneConnect to add and remove the integration in OnePlan when it is installed or uninstalled. Grant only the permissions listed so the key has the minimum access the integration needs.

After you create the key, save the OnePlan group name and the authentication key in a secure location. You enter both in OneConnect during setup. The key cannot be viewed again after you leave the page.

Note: It is recommended to generate a new authentication key for every integration and to give each key a descriptive name that identifies its integration. This practice enhances security, simplifies management, and makes tracking and troubleshooting easier.

 

OneConnect Setup Process

Note

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

  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. Find the OnePlan Migration Tool tile. 
  4. Click on the tile.

 

Tabular Data Connector

Connecting to a file for Tabular Data involves three key sections, each with its associated fields. 

  1. Authorize button: This button must be authenticated by a Microsoft Tenant Administrator. This is required for the service principle connection. Please review this article for more information. 
  2. Locating CSV - For the tool to connect to the CSV file, these fields must be filled out:
    1. SharePoint or OneDrive URL: Enter the SharePoint/OneDrive URL where the file is located. (e.g., https://{OrganizationName}.sharepoint.com/sites/{SiteName}).
    2. Folder Path: The folder where the file is located.

Enter the filenames for each csv file that you are planning to use:

  1. Plan Import File Name - use it if you are importing plans
  2. WorkPlan Import File Name - use it if you are importing tasks or similar work plan items
  3. Resource Import File Name - use it if you are importing resources
  4. Resource Plan Import File Name - use it if you are importing resource plans

  5. Financial Cost Import File Name - use it if you are importing financials
     

    These fields are under the Advanced Options. 

    Test & Save - Confirm the connection to SharePoint/OneDrive authenticates and save your settings. These buttons are located at the bottom of your connector. 

    1. Test the connection to verify the settings. A notification indicating Connected Successfully should appear in the top-right corner of the browser upon successful testing.
    2. Save the configuration to finalize setup. 

 

OnePlan Connector

Connecting to OnePlan involves three key sections, each with its associated fields. 

  1. Connect to OnePlan - 
    1. Optional: Group Name: The name of the OnePlan Group you intend to integrate with. 
    2. Authentication Key: Paste the generated OnePlan Authentication Key obtained from OnePlan.
    3. Optional: Alternate OnePlan Environment URL: If using an environment other than the default environment, select the appropriate URL from the available options. Located in Additional Options. 
  2. Additional Integration Settings - These optional settings will modify how the integration functions to better suit your needs. 
    1. Optional: OnePlan Default Plan Type: In case a plan lacks a designated plan type in the CSV file, the specified value here will serve as the default plan type. Located in Additional Options. 
  3. Test & Save - Confirm the connection to OnePlan authenticates and save your settings. These buttons are located at the bottom of your connector. 
    1. Test the connection to verify the settings. A notification indicating Connected Successfully should appear in the top-right corner of the browser upon successful testing.
    2. Save the configuration to finalize setup. 

Tabular Data Integration OnePlan Settings.png

 

Related to

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.