This integration is designed to streamline the process of importing financial data into the OnePlan Financial Planner using a .CSV file. Specifically, it facilitates the importation of financial data for existing cost categories within the planner. If you require guidance on importing financial data for new cost categories or incorporating information into custom fields, please consult the documentation on the OnePlan and Tabular Data Financial Import with Custom Fields integration.
To complete the OnePlan setup, you need to be an admin (user with Owner permissions) in OnePlan.
-
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.
Financial Plan Setup & How to Locate Fields for the CSV Import
Setting Up Plan External Id
-
Create Custom Plan Field
- Navigate to the Admin pages by clicking on the settings (gear) icon at the top right of the browser.
- In the Fields section, while beneath the Plan Fields section click on + New Field.
- Provide a name for the field (e.g., Plan External ID), set the field type to text, and click Save.
-
Add Custom Field to Plan Details
- While in the Admin pages, navigate to Plan Details section.
- Choose the desired Plan Type from the dropdown.
- In the far-right column labelled Fields, locate the custom field created and drag the field into the relevant section within the Plan Details form.
- Remember to Save the changes made, the button is located next to the Plan Type dropdown.
-
Select Custom Field for Financial Import
- While in the Admin pages, navigate to Financial Plan section.
- Navigate to the Import section.
- Click on the External Id Field dropdown and select the custom field that was created.
Locating Cost Type Name
- While inside the OnePlan Admin page, select the Financial Plan section.
- Navigate to the Cost Types section.
In OnePlan, default Cost Type names include Budget, Forecast, Actuals, Benefits, & Program Budget. It's important to note that administrators have the flexibility to add, edit, or delete these cost types based on their company preferences.
Assigning an External Id to Cost Categories
- Navigate to the Admin page.
- Access Financial Plan section.
- Select Cost Categories.
- Click on the edit (paper and pencil) icon.
- Enter a unique External Id for each cost Category options.
Please note that the cost categories do not automatically create External Ids, and therefore must be manually assigned. Possible External Ids can be letters, numbers, or a mix of the two.
Expected Cost Date Format
The cost date values should be in the format of 2022-05-22T00:00:01 (YYYY-MM-DDTHH:MM:SS).
Cost Value
The expected cost value can be a positive or negative number, and can take up to two decimal places.
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.
-
Go to https://my.oneconnect.ai (or https://eu.oneconnect.ai for European customers utilizing eu.oneplan.ai).
-
Configure the following integration: Tabular Data Cost and OnePlan Financial Planner Cost External Import. 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, throttle 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
-
(Optional) Client Id
- Enter the Client Id generated from the SharePoint site.
-
(Optional) Client Secret
- Enter the Client Secret generated from the SharePoint site.
-
Financial Cost 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:
-
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.
Integration Information
Default Field Mappings
Tabular Data Fields | OnePlan Fields | Direction | Notes |
Currently, default field mappings are not predefined for this integration. When the file is read, the possible field names will populate the Tabular Data dropdown within the Field Mappings section. The Out-of-the-Box (OOTB) field names for the OnePlan Financial Cost import dropdown include:
- Plan External Id (Text)
- Cost External Id (Text)
- Cost Type Name (Text)
- Cost Value (Decimal/Number) Cost value can take up to two decimal places.
- Cost Date (Date) Cost date will be in the format of 2022-05-22T00:00:01 (YYYY-MM-DDTHH:MM:SS).
Default Scheduled Strategies
CostImportToFinancialPlanner
Synchronize Cost from Tabular Data to OnePlan Financial Planner.
Mandatory Fields
Plan External Id, Cost External Id, Cost Type Name, Cost Value, and Cost Date are all considered mandatory fields. Each row should have these five fields entered with a value.
Recommended Suggestions
Ensure Cost External Id Values are Unique
If there are multiple Cost External Id’s that have the same value, the CostImportToFinancialPlanner strategy will run, however there is no control over which Cost Category the Cost Values are allocated to.
Integration Limitations
Only Financial Data will be Entered
Exclusively financial data will be inputted into the financial planner through this integration. It is important to note that this integration is designed solely to import financial data related to existing cost categories. The integration does not generate detailed rows, and custom fields will neither be filled nor utilized.
- FinancialPlannerImport.csv366 Bytes