Skip to main content

Tabular Data to OnePlan Plans

  • Updated

This integration was created to bulk import OnePlan Plan information from a .CSV file.

OnePlan

In order to do the OnePlan setup, you need to be an admin, meaning you are a 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 in to your OnePlan group with your Office365 account.

  2. Open the Admin pages by clicking on the Settings (gear) icon.

  3. Select Integration in the admin navigation.

  4. Click the + (plus) icon in the Authentication Keys section.

  5. Save the OnePlan Group Name and the Authentication Key somewhere safe, as this will give any program access to your OnePlan group. The key will no longer be viewable once the page refreshes.

3421b49e-b9a6-4759-8e0e-0a6b9f4fc028.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_custom_plan_field_to_the_plan_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.

    set_plan_external_id_field.png

OneConnect Setup

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.

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

    Tabular_data_to_oneplan_plans_select_integration.png

     

Tabular Data Section

  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: Enter the folder path where the file is located.

  3. Username: Enter the username.

    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 the SharePoint site.

    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. Password: Enter the password.

  5. (Optional – Checkbox) Using SharePoint Modern Authentication: See SharePoint Modern Authentication for more information.
  6. Expand Additional Options.
  7. (Optional) Client Id: Enter the Client ID generated from SharePoint site. To be used with the Modern Authentication checkbox.
  8. (Optional) Client Secret: Enter the Client Secret generated from SharePoint site. To be used with the Modern Authentication checkbox.
  9. Financial Cost Import File Name or Plan Import File Name: Enter the file name to be used for importing the plans into OnePlan.We currently only fully support the .CSV format. 
  10. Click Test to ensure that the connection settings to SharePoint/OneDrive are correct. A small notification of Connected Successfully should appear towards the top right of the page.
  11. Click Save.
tabular_data_section_of_integration_config_form.png

OnePlan Section

  1. Group Name: Enter the OnePlan Group name you will be integrating into.

  2. Authentication Key: Enter the OnePlan Authentication Key generated from OnePlan.

  3. (Optional) Alternate OnePlan Environment URL: If using an alternative environment than https://my.oneplan.ai, please select the appropriate URL here.

    Note

    Options currently are: https://au.oneplan.ai, https://ca.oneplan.ai, https://eu.oneplan.ai.

  4. (Optional) OnePlan Default Plan Type: Should any plan not have a plan type listed within the CSV file; the value listed here will be the default plan type.

  5. (Optional) Create plan(s) if External ID value does not already exist in OnePlan: Should an external ID not match a plan that already exists within OnePlan, this setting will create the Plan in OnePlan, with the Plan External ID set.

OnePlan_section_of_integration_configuration_form.png
  1. Click Test to ensure that the connection settings to OnePlan are correct. A small notification of Connected Successfully should appear towards the top right of the page.
  2. Click Save.
    1.  

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.

Multi-Choice Values

If attempting to set a multi-choice field with multiple values the values should be separated by a semicolon and a number sign combination in the CSV file: Value1;# Value2.

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.

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

Related articles

Comments

0 comments

Article is closed for comments.