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.
This integration focuses on importing Resource hours into their relevant Cost Types within the Resource Planner associated with a specific plan.
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.
-
Log into your OnePlan group using your OnePlan login credentials.
-
Access the Admin pages by clicking on the settings (gear) icon at the top right of the browser.
-
Navigate to the Integration section in the left-hand navigation panel.
-
Next to the Authentication Keys section click the + Add Key button.
-
Provide a descriptive name or title for the Authentication Key to denote its purpose, then click ADD.
-
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.
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:
-
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.
- Open the Console
-
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}.
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:
- Go to the OnePlan Admin pages.
- Navigate to Resource Plan and select Types.
- Click on Types + button.
- Provide a name of the Resource Plan Type.
- Within the Available Apps section, ensure that Resource Plan is selected.
- Within the Plan Types section, select which plan types the new Resource Plan Type name is associated with.
- 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.
-
Go to https://my.oneconnect.ai (or https://eu.oneconnect.ai for European customers utilizing eu.oneplan.ai).
- Navigate to Tabular Data to OnePlan Resource Planner. Click Configure.
Tabular Data Connector
-
SharePoint or OneDrive URL
- Enter the SharePoint/OneDrive URL where the file is located (e.g., https://{OrganizationName}.sharepoint.com/sites/{SiteName}).
-
Folder Path
- Enter the folder path where the file is located.
-
Username
- Enter the SharePoint/OneDrive username to be used to access environment.
- 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.
-
Password
- Enter the password.
-
(Optional – Checkbox) SharePoint Modern Authentication
- For more information on how to set up SharePoint Modern Authentication.If this box is checked, please enter the Client Id and Client Secret in the Additional Options section.
-
Additional Options
- Expand the section for additional configuration options.
-
(Optional) Client Id
- Enter the Client ID generated from SharePoint site.
-
(Optional) Client Secret
- Enter the Client Secret generated from SharePoint site.
-
Resource Import File Name
- Enter the file name to be used for the Financial Planner (i.e., FinancialImport.csv).
-
(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)
-
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.
-
Save Changes
- After verifying the connection, click Save to retain the configured settings.
OnePlan Connector
-
Group Name
- Input the name of the OnePlan Group name you intend to integrate with.
-
Authentication Key
- Paste the generated OnePlan Authentication Key obtained from OnePlan.
-
Additional Options
- Expand the section for additional configuration options.
-
(Optional) Alternate OnePlan Environment URL
- If using an environment other than the default (https://my.oneplan.ai), select the appropriate URL from the available options:
-
(Optional) Do not remove existing data
-
-
- Unchecked (Default): All previously imported data will be removed from OnePlan and replaced by the .csv file.
- Checked: Only data in the CSV file will be replaced in the Resource Planner. If there is data in other months for the resource within a plan that are not in the CSV file, those values will not be modified.
-
-
-
(Optional) Select a Delete Scope
- This field is to be used when the Do not remove existing data box is unchecked. Delete Scope determines which data is targeted for removal each time the ResourceImportToResourcePlanner strategy runs.
- All Resources (Default): Remove all resources from the OnePlan plans Resource Planner. The data will then be replaced with the information uploaded from the CSV file.
- Included Resources: The resources in the CSV file will be removed from the OnePlan plans Resource Planner and the data will be replaced with the information uploaded from the CSV file.
-
Process Zero Hours
- Process Zero Hours is specifically designed for use in conjunction with the Delete Scope of Included Resources feature. This capability enables the complete removal of resources from a plan via a CSV file. This is achieved by entering a row containing all the relevant data, and setting the hours value to 0.
-
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.
-
Save Changes
- After verifying the connection, click Save to retain the configured settings.
Strategies
ResourceImportToResourcePlanner
This strategy synchronizes Resources from Tabular Data to the Resource Planner.
Filters can be applied to this strategy on the Tabular Data -> OnePlan section within the Users -> BulkResrcImport table.
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.
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
Integration does not write to Resource Plan Custom Fields
Currently, the Tabular Data Resource Planner integration does not update or write to any of the Resource Planner Custom Fields.
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.
Comments
0 comments
Article is closed for comments.