Tabular Data to OnePlan Resource Planner

  • Updated

This integration is designed to streamline the process of importing resource plan data into the OnePlan Resource Planner using a .CSV file. Specifically, it facilitates the importation of resource allocation data for existing resource types within the planner.

How to Use OnePlan with Tabular Data

This integration focuses on importing Resource hours into their relevant Cost Types within the Resource Planner associated with a specific plan.

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.

  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

Resource Planner Setup & How to Locate Fields for CSV Import

Finding the Plan External ID

The Plan External Id serves as the identifier for the plan. You can retrieve this value through various methods while inside a plan:

  1. Using Developer Tools
    • Open the Console
      • Chrome Browser: CTRL + SHFT + i OR right click on the browser and select Inspect.
      • Edge: CTRL + SHFT + j
    • Type: PlanId and press Enter.
    • The value will be displayed in red and enclosed in single quotation marks.
  2. Using Shared With
    • Click on the personal image of the user you are logged in as (located on the top right of the page).
    • Select Share With.
    • Navigate to the end of the text and locate PlanID={PlanIdValue}.

Set the Plan External ID

The Plan External Id is not an OOTB field. This will be a custom field that the user will have to create, modify, and set themselves.

  1. Create 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). This field type should be a text field.
  2. Add custom plan field to the Plan Details
    • 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. Be sure to save the changes at the top of the page next to the Plan Type dropdown!
  3. Set Plan External Id Field to the custom field created
    • Still in OnePlan Configuration, go to Resource Plan -> Advanced.
    • Click on the dropdown for the External Id Field, and select the custom field you want to use. This setting will automatically save.

Finding the Resource Plan Type Name

Resource Plan Type Name (or Type Name in the OnePlan field mappings section) signifies the name of the Resource Plan Type where the imported information will be allocated. In OnePlan, the default options are Committed, Scheduled, and Timesheets.

If you wish to create a custom Resource Plan Type, follow these steps:

  1. Go to the OnePlan Admin pages.
  2. Navigate to Resource Plan and select Types.
  3. Click on Types + button.
  4. Provide a name of the Resource Plan Type.
  5. Within the Available Apps section, ensure that Resource Plan is selected.
  6. Within the Plan Types section, select which plan types the new Resource Plan Type name is associated with.
  7. Click ADD.

Identifying Resources

For non-generic resources, the email address is used to identify which resource to choose from. This is because there is always the possibility of having more than one employee with the same name.

For generic resources, the Display Name of that resource can be used (i.e., Developer).

Expected Fiscal Month Period Format

The fiscal month period should be in the format of 2022-05-22T00:00:01 (YYYY-MM-DDTHH:MM:SS).

Hours

Positive values are accepted up to 2 decimal places. Should there be more than 2 decimal places the values will round up visually in the Resource Planner.

OneConnect Setup Process

To complete the OneConnect setup, you need have Administrator or Editor privileges in the OneConnect group you wish to set the integration up in.
  1. Go to https://my.oneconnect.ai (or https://eu.oneconnect.ai for European customers utilizing eu.oneplan.ai).

  2. Navigate to Tabular Data to OnePlan Resource Planner. Click Configure.Select_Tabular_Data_to_Resource_Planner_Integration.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. Folder must exist at the /Documents level or equivalent.
    3. Resource Import File Name: Specify the file name to be used for the Resource Planner import. .CSV file formation 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 to find a method that works 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 Options.
  3. Test & Save – Confirm the connection to SharePoint/OneDrive authenticates and save your settings. These are at the bottom of the connector.
    1. Test the connection to verify correct 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: Enter the OnePlan Group Name: The name of the OnePlan Group name 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 are options relating to the integration that might fulfill your needs.
    1. Do not remove existing data: Located in Additional Options.
      • Unchecked: All previously imported data will be deleted from OnePlan and replaced with the data in the CSV file.
      • Checked: Only the data in the CSV file will be updated in the Resource Planner. Any existing data for the same resource in other months will remain unchanged.
    2. Select Delete Scope: This setting is only used when “Do not remove existing data” is unchecked. It defines which data is removed each time the strategy runs. Located in Additional Options.
      • All Resources: Removes all resources from the Resource Planner before replacing the data with the CSV file.
      • Included Resources: Only removes and replaces resources listed in the CSV file, leaving other data intact.
    3. Process Zero Hours: Works with the “Included Resources” delete scope to allow full resource removal via CSV. Located in Additional Options.
      • To completely remove a resource from a plan, include a row with the relevant data and set the hours value to 0.
  3. Test & Save - Confirm the connection to OnePlan authenticates and save your settings. Located at the bottom of the connector.
    1. Test the connection to verify correct 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 Settings.png

Integration Information

Default Field Mappings

Users – BulkResrcImport

Tabular Data Fields

OnePlan Fields

Direction

Notes

Fiscal Month Period

Fiscal Month Period

Both

Required

Hours

Hours

Both

Required

Plan External ID

Plan External ID

Both

Required

Resource

Resource

Both

Required

Type Name

Type Name

Both

Required

Note

In the event of a successful integration but an inability to locate the file or a mismatch in column names, the field mappings will not automatically populate. In such cases, manual creation of the field mappings becomes necessary.

Strategies

ResourceImportToResourcePlanner

This strategy synchronizes Resources from Tabular Data to the Resource Planner.

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. 

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

Filters can be applied to this strategy on the Tabular Data -> OnePlan section within the Users -> BulkResrcImport table.

Mandatory Fields

Plan External Id, Resource, Type Name, Hours, and Fiscal Month Period are all considered mandatory fields. Each row should have these five fields entered with a value. 

Integration Limitations

Resource must exist in OnePlan for the Integration to Allocate Time 

Any and all resources within the CSV file must exist in OnePlan for the Resource Planner to allocate time in the resource planner.

Resource Plan Custom Fields 

You can set values for custom Resource Plan fields directly within the integration.

To Create a Custom Field

To create custom Resource Plan fields:

  1. Navigate to the OnePlan Configuration page.
  2. Navigate to Resource Plan and expand Custom Fields.
  3. Click the + button.
  4. Provide a Name for the custom field.
  5. Select a Type from the Field Type dropdown.
  6. Once you’ve entered your desired field details, click Save.

NOTE: Custom fields for the resource plan will not appear automatically in the field mappings section. To ensure fields are updated/generated correctly, the column name in the CSV must exactly match the Custom Field name, including sensitivity.

Entering Boolean (Yes/No) Values

To populate or update Yes/No fields in your Resource Plan:

  • Enter true (lowercase) in the CSV cell to mark the checkbox as checked.
  • Leave the cell blank to leave the checkbox unchecked.

Resource Planner Boolean.png

Entering Choice Values

To populate or update choice fields, you’ll need the GUID ID for each choice. Here’s how to find it:

  1. Append /api/apps/subs/c6608526-312c-4082-9e55-f60885d4a680 to the end of your OnePlan URL and press Enter.
  2. Locate the CustomFields object and find Choices. This section contains a collection of GUID pairs. Use the GUID values in the CSV.

Resource Planner Choice GUID.png

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request