This article explains how to set up the integration between OnePlan and Tabular Data for bulk resource import.
This integration focuses on importing resources in bulk into OnePlan via a .CSV file.
To complete the OnePlan setup, you need to be an admin (user with Owner permissions) in OnePlan.
-
Log into your OnePlan group using your Office365 account.
-
Open the Admin pages by clicking on the Settings (gear) icon.
-
Select Integration in the Admin Navigation panel.
-
Click the + (plus) icon in the Authentication Keys section.
-
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.
These steps will require action from the client's Tenant Administrator to enable app permissions and consent on behalf of the organization.
- Log into your OnePlan group using your Office365 account.
- Open the OnePlan configuration pages by clicking on the Settings (gear) icon.
- Please note that some steps listed below should have been covered during Technical Readiness.
- Select Users in the Admin Navigation panel.
-
Expand the AD Synchronization section.
-
At the bottom of the section, locate: To synchronize users you must enable app permissions: here. Click on the blue here button to allow the tenant administrator to grant permissions.
- The tenant administrator will have to provide their tenant credentials to approve the app permissions on behalf of the organization.
- Once the permissions have been granted for step 5, go to the OnePlan configuration page, go to Integration section, locate: To allow integration to this tenant, please make sure you are logged in with a tenant admin and click here. Click on the blue here button to allow the tenant administrator to grant permissions.
- The tenant administrator will have to provide their tenant credentials to approve the app permissions on behalf of the organization.
- Once the permissions have been granted for step 6, navigate to https://my.oneplan.ai/account/ConsentIntegration to provide tenant admin consent for the OnePlan group.
- The tenant administrator will have to provide their tenant credentials to approve the app permissions on behalf of the organization.
OneConnect Setup
To complete the OneConnect setup, you need to be an Administrator or Editor in the OneConnect group to set the integration up.
-
Go to https://my.oneconnect.ai
-
Navigate to Tabular Data to OnePlan Resource Center Import. Click on the Configure button.
Tabular Data Section
- 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 username.
- Note: 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. It is standard best practice to have a single service account associated with a single integration. When service accounts are connected to multiple integrations, Microsoft has been known to throttle data which can lead to strategy failures.
- Password: Enter the password associated to the username.
- (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.
- Expand Additional Options.
- (Optional) Client Id: Enter the Client Id generated from the SharePoint site. To be used with SharePoint Modern Authentication checkbox.
- (Optional) Client Secret: Enter the Client Secret generated from the SharePoint site. To be used with SharePoint Modern Authentication checkbox.
- Resource Import File Name: Enter the file name to be used for the Resource import. We currently only fully support the .CSV format.
- 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.
- Click Save.
OnePlan Section
- Group Name: Enter the OnePlan Group name you will be integrating to.
- Authentication Key: Enter the OnePlan Authentication Key generated from OnePlan.
- Expand Additional Options.
- (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: au.oneplan.ai, ca.oneplan.ai, and eu.oneplan.ai.
- 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.
- Click Save.
Integration Information
Default Field Mappings
Currently there are no default field mappings for this integration.
Default Scheduled Strategies
SynchResources
Synchronize resources from Tabular Data into the OnePlan Resource Center.
Out of the Box OnePlan Resource fields
Display Name (Text): The name is associated to the resource. Display Name field mapping is mandatory for generic users (as generic users do not have an email associated with them). If a user is marked as generic, we only use the Display Name to create that user in the Resource Center.
Email (Email): The email address that is used for all non-generic users. Email field mapping is mandatory for all non-generic users. The email address is queried against the company's Azure Active Directory (AD). If the email does not exist in the company's Azure AD, the resource will not be created.
Role (GUID): The user's role within the organization. For more information on how to locate a GUID, please navigate to the Locate Field GUIDs section below.
Timesheet Administrator (True/False): This will approve the resource of being a timesheet administrator. The value in the CSV file can be set to true or false, these values are not case sensitive.
Global Permissions (Text): Global Permissions will provide the resource in OnePlan with the appropriate license and access to specific OnePlan sections.
Global Permissions has recently been upgraded to the new Enterprise Security Groups method. For more information on the new version of Global Permissions, please navigate to the Enterprise Security Groups (New) section below. For more information on the previous version of Global Permissions, please navigate to the Global Permissions (Discontinued Method) section below.
Cost (Number): The resources cost. This number value can go up to 2 decimal places (e.g., 21.95).
Rate (Number): The resources rate. This number value can go up to 2 decimal places (e.g., 53.64).
Generic (True/False): This will determine if the resource is generic or not. The value in the CSV file can be set to true or false, these values are not case sensitive. Depending on the value, will affect what fields are mandatory for the resource. This field value cannot be updated for a user once that user has been created. If the generic value is different than the user who is already created, it will create a second user. If this field is not mapped, OneConnect will automatically assume the user is not generic.
Inactive (True/False): This will determine if the resource is still active/available or if the resource is inactive/unavailable. The value in the CSV file can be set to true, false, active or inactive. these values are not case sensitive. If this value is not mapped, OneConnect will automatically assume the user is active.
Quantity (Number): The number of resources for a particular resource. This number value can go up to 2 decimal places (e.g., 2.75).
Business Unit (GUID): The business unit the resource is associated to. For more information on how to locate a GUID, please navigate to the Locate Field GUIDs section below.
Manager (Email): The email of the manager of the resource.
Mandatory Fields
If the following fields do not have any values associated to them, the resource will not be created in OnePlan.
Email - This field is mandatory for any non-generic resource.
Display Name - This field is mandatory for any generic resource.
Locate Field GUIDs
1. Open the OnePlan Configuration page by clicking on the Settings (gear) icon.
2. Go to Fields in the Admin Navigation, expand Resource Fields.
3. Locate the choice field desired, and click on the Edit icon. The Edit Choices form will open.
4. In the column title, click on the dropdown arrow to expand the options available, select Columns, and select Id. These values are the GUIDs for the specific choice options.
Note: If the GUIDs do not match, no value will populate that field in the Resource Center.
Enterprise Security Groups (New)
OnePlan has recently released a change in how users are given permission to access OnePlan. Enterprise Security Groups allow more control over what groups of users will have access to within OnePlan.
To set the Enterprise Security Group, the Global Permissions field will still be used to set the group access for the user. However, to set the Enterprise Security Group for new users going forward the front-end name of the security group will now be used. For example, if the security group has the name of “Timesheet Users Type 2”, then that is the value that should be entered within the Global Permissions column in the CSV file.
If no value is entered within the Global Permissions column, then the default value set within the OnePlan Configuration page will be set automatically. Please note that to update a user’s Enterprise Security Group, a value must be entered in the CSV file, otherwise the previously set value will stay the same.
Global Permissions (Discontinued Method)
This section covers the now discontinued method of allocating licenses/access to OnePlan.
When previously importing users into OnePlan, if the user is new, then the user will be created with the permissions level number given if this field is mapped:
- 0 gives user permission of None
- 1 gives user permission of Team Member
- 2 gives user permission of Contributor
- 3 gives user permission of Manager
- 4 gives user permission of Owner
- 5 gives user permission of Executive
Today because of the switch to Enterprise Security Groups, these number values will still work if the Enterprise Security Group name has not been altered or removed.
Integration Limitations
Integration will not Delete Resources
This integration will not delete Resources. Resources can be created, updated, or marked as inactive.
Resource Access is Only Assigned from Resource Center
This integration will only alter fields that are related to the Resource Center. The ability to update what plans the user has access to cannot be done from this integration.
To alter what OnePlan Modules/Sections are available to the Enterprise Security Group, please navigate to the OnePlan Configuration page and go to Users. The Enterprise Security Group section will reside there.
User Principal Name (UPN) is not Supported as an Alternative to Email
Currently, only email is used to be queried from the clients Azure Active Directory to give the person access to OnePlan. User Principal Name cannot be used as an alternative to the email.
Comments
0 comments
Article is closed for comments.