Tabular Data to OnePlan Plans

  • Updated

This integration was created to bulk create and update OnePlan Plan information from a .CSV file.

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.

  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

 

Plan External ID

Identifying Plans with External IDs

Each plan must be uniquely identified by a Plan External Id.

  • The Id allows OnePlan to match existing plans for updates or create new plans if they don't exist. 
  • The field must be set up and mapped manually in OnePlan (it is not out-of-the-box). 

 Step 1: Create the Custom Field

  1. In OnePlan, go to Settings (gear icon) > Fields. 
  2. Select Plan Fields, then click New Field. 
  3. Name is something like "Plan External Id".
  4. Set the field type to Text. 

Step 2: Assign as External ID Field

  1. In OnePlan go to Settings (gear icon). 
  2. Go to Financial Plan > Import.
  3. Use the External Id Field dropdown to select your new custom field.
  4. The selection saves automatically. 

Note: This field is now used by OnePlan to identify plans for syncing. 

Step 3: Add Field to Plan Details (Optional)

Add the custom field to the Plan Details form so it can be located easily and updated manually if needed. 

  1. In OnePlan Configuration page, navigate to Plan Details.
  2. Select a Plan Type you want this field added to.
  3. In the far-right column labeled Fields, find your custom field.
  4. Drag and drop the field into the desired section of the Plan Details layout. 
  5. Click Save next to the Plan Type dropdown. 
Add Plan External Id field to Details Form.png

  1. Set Plan External Id Field to the custom field created. Still in OnePlan Configuration, go to Financial Plan > Import. Click on the drop-down for the External Id Field, and select the custom field created. This setting will automatically save.

    Financial Plan Import add field.png

 Entering Multi-Choice Values

To populate or update any desired resource multichoice fields, ensure that between the values a semicolon + number sign (;#) is between them without spaces (i.e., value1;#value2).

OneConnect Setup Process

Note

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

  1. Go to https://my.oneconnect.ai (or https://eu.oneconnect.ai for European customers utilizing eu.oneplan.ai)

  2. Locate the Tabular Data to OnePlan Plans integration. Click Configure.

    Tabular Data to OnePlan Plans.png

     

Tabular Data Connector

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

  1. Locating CSV - For the integration to connect to the CSV, all three 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.
    3. Financial Cost Import File Name or Plan Import File Name: Specify the file name to be used for the Plan import. CSV file format is fully supported. Located in Additional Options. 
  2. Authentication Options - Each option here is a separate way to authenticate to SharePoint. Please review the SharePoint Authentication Methods page to find a method that aligns best for your company. 
    1. Username and Password: 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. 
    2. Optional: Enable SharePoint Modern Authentication (Deprecated): For further information on using SharePoint Modern Authentication. This option includes entering a Client Id and Client Secret. 
      • Client Id and Client Secret: To be used when authenticating using the SharePoint Modern authentication option. Located in Additional Options. 
    3. Optional: If you are using an Entra service principle to connect to SharePoint: The checkbox will authenticate the integration via the Service Principal that will be created via the Authorize button. Located in Advanced Options. 
      • Authorize button: This button must be authenticated by a Microsoft Tenant Administrator. Located in Advanced Settings. 
  3. 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. 

Tabular Data Settings.png

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. 
    2. Optional: Create plan(s) if External ID value does not already exist in OnePlan: If the CSV file has an External Id that does not exist in OnePlan, a new plan will be created. Existing Ids will be updated. 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

Integration Information

Default Field Mappings

Currently, we do not have default field mappings for this integration.

Mandatory Fields to be Mapped

At minimum, only two values need to be mapped on the OnePlan side for the data to come into OnePlan: Name and Plan External ID.

Strategies

SyncPlansByPrimaryKey: This strategy synchronizes Tabular Data rows as Plans into OnePlan.

This strategy has been set to Enabled, however the Schedule Type has been set to None. This means that the strategy will not trigger on a set schedule and will only run when manually triggered through OneConnect.

This strategy will grab the file listed in the Tabular Data connector, process each row of data, and bring over any values mapped to OnePlan. 

If the "Create plan(s) if External ID value does not already exist in OnePlan" is not checked, then only existing plans will be updated. No new plans will be created. If this field is checked, then new plans can be created while existing plans will be updated based on if the External Id exists already. 

This strategy does not have the ability to filter data. All data in the .CSV file will be processed when the strategy runs. 

Important CSV information

Beginning the CSV row with a #

In the CSV file, should the row begin with a number sign (#), that row will be treated as a comment, and will not be processed.

Estimated Start/Estimated End

Estimated Start and Estimated End dates in OnePlan are special fields within OnePlan. These dates will change if there are any tasks within the Schedule section of the Work Plan, as those values have a higher precedence than the values within the integration/API call.

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. No other system fields or plan features, such as Favorite, Shared With, Comments, etc., can be configured.

Exception: The sole exception to this rule is the capacity to set a Name, an Owner, and a Plan Type to the plan.

Not all OnePlan Fields Recommended to Update/Map

Some fields in OnePlan are considered unadvisable to map within the integration, as they incorporate additional backend functionality that may be susceptible to disruptions if modified through an integration. Therefore, it is advised against mapping any plan level field whose function is Calculated, Roll Up, or Trend types.

For plans of the Standard type, the following are the special fields that are not recommended for use.

Actual Hours Count Forecast Schedule Mode
Actuals Default Task Mode Governance Problems Timesheet Charge
Benefits Default Task Type Governance Warnings Timesheet Type
Budget Estimated End Plan Count  
Committed Effort Estimated Start Program Budget  

Hierarchy is not Supported

Unfortunately, at this time, this integration does not support hierarchy. All plans created will not have an associated parent plan. 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request