Skip to main content

Tabular Data to OnePlan Plans

© 2024 OnePlan Solutions. All Rights Reserved.
Download Article

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

Set Plan External ID

The Plan External Id is not an out-of-the-box (OOTB) field. Plan External Id will be used in place of Plan ID. This will be a custom field that the user will have to create, modify, and set themselves.

  1. Create a custom plan field. In the OnePlan Configuration page, go to Fields > Plan Fields > Click New Field. Give the field a name (E.g., Plan External Id).

    Note

    This field type should be a text field.

  2. Add the custom plan field to the Plan Details form. While still in the OnePlan Configuration page, go to Plan Details > Plan Type. Pick the plan type you wish to have this new field in. In the far-right column labeled Fields, locate the custom field, and drag into the plan section you wish to have this field show up in the Plan Details page.

    Important

    Be sure to save the changes at the top of the page next to the Plan Type drop-down!

    Add Plan External Id field to Details Form.png

  3. 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

  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

    • Specify the folder path where the file is situated.

  3. 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.

  4. Password

    • Enter the password.

  5. (Optional – Checkbox) SharePoint Modern Authentication
    1. See SharePoint Modern Authentication for more information. If this box is checked, please enter the Client Id and Client Secret in the Additional Options section.
  6. Additional Options
    • Expand the section for additional configuration options.
  7. (Optional) Client Id
    • If using Modern Authentication, enter the Client ID generated from the SharePoint site.
  8. (Optional) Client Secret
    • If using Modern Authentication, enter the Client Secret generated from the SharePoint site.
  9. Financial Cost Import File Name or Plan Import File Name
    • Specify the file name to be used for the Plan import. Currently, only the .CSV format is fully supported. 
  10. (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)
  11. 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.
  12. Save Changes
    • After verifying the connection, click Save to retain the configured settings.
      Tabular Data Settings.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.
      Tabular Data Integration OnePlan Settings.png

  3. Additional Options
    • Expand the section for additional configuration options.

  4. (Optional) Alternate OnePlan Environment URL

  5. (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.

  6. (Optional) Create plan(s) if External ID value does not already exist in OnePlan

    • If an external Id does not correspond to an existing plan within OnePlan, this configuration will initiate the creation of the plan in OnePlan, with the Plan External ID duly set.

  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.

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.

Default Scheduled 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.

If desired, a schedule can be set when clicking on the pencil icon in the Schedules Tab within the integration. The Schedule Type dropdown is beneath the Properties section.

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. 

Related articles

Comments

0 comments

Article is closed for comments.