OneAnalytics (SQL Server) Integration - Integration Setup

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.

1. Go to https://my.oneconnect.ai (or https://eu.oneconnect.ai for European customers utilizing eu.oneplan.ai).

2. Navigate to OneAnalytics for OnePlan. Click Configure.

   

OnePlan Connector

1. Group Name
   • Input 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. Additional Options
   • Expand the section for additional configuration options.
4. (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:
     • https://au.oneplan.ai 
     • https://ca.oneplan.ai 
     • https://eu.oneplan.ai
5. OData ID
   • Locate the OData ID within the Integration tab on the OnePlan Admin page. Access the Reporting Info field to find the unique identifier. The OData Id follows this format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxx-xxxxxxxx.
6. OnePlan OData Table names
   • The OnePlan OData tables slated for migration to SQL. It’s important to note that this process includes the retrieval of all available fields associated with each OData table, making it a comprehensive or “full sync” operation.
7. (Optional) Columns to Snapshot
   • If you prefer to capture specific fields from OnePlan, you can utilize this optional field. The specified fields should follow the format TableName{Field} (e.g., Resources{Name,UserId,Email,Generic}).  Please note that this feature is exclusive to the TakeOnePlanSnapshot strategy.
8. (Optional) Choice Column for Time Tracking
   • For those who desire to capture choice field values with time tracking. It is employed specifically when tracking the time elapsed since the last update for specific fields is necessary.  This feature is exclusive to the TakeOnePlanSnapshot strategy.
9. (Optional - Checkbox) Download only mapped plan level fields
   • Please review this article for best practices. 
   • Unchecked (Default): Retrieves all available plan level fields and stores them in the SQL database.
   • Checked: Retrieves only the mapped plan level fields and stores only those in the SQL database.
10. 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.
11. Save Changes
    • After verifying the connection, click Save to retain the configured settings.

SQL Server (v2) Connector

1. Server
   • Enter the name of the server that will host the data being imported.
2. Database
   • Input the name of the database intended for use.
3. Username
   • Enter the SQL Server username to be used to access the database.
   • Note: This user must have read/write access to the database.
   • Note: We encourage a service account to be used to access the SQL Server Database.
4. Password
   • Enter the password.
5. Additional Options
   • Expand the section for additional configuration options.
6. (Optional) Authentication Method
   • Currently, this integration supports two authentication methods: SQL Password and Active Directory Password.
   • (Default) SQL Password: This is the default option suitable for on-premises setups or when using  Azure as a Service.
   • Note: Windows Authentication (NTLM) is currently not supported. 
7. (Optional) Client Id
   • This is the app registration Client Id that will be generated by the Tenant Administrator within the client’s organization. To be used when Authentication Method is set to Active Directory Password.
8. (Optional) Client Secret
   • This is the app registration Client Secret that will be generated by the Tenant Administrator within the client’s organization. To be used when Authentication Method is set to Active Directory Password.
9. (Optional) SQL Version
   • This section allows you to specify how SQL is configured.
   • (Default) Azure: Specifically tailored for Azure as a Service.
   • Other: Applicable for SQL Server in the Cloud, or on-premises installations
10. (Optional) Column Type Mismatch Handling
    • Column type mismatch handling addresses scenarios where a column in SQL has an incorrect type (string, number, date, etc.), requiring the deletion and recreation of the column with the correct type.
    • (Default) Ignore: This option retains the column in the SQL server without deletion, and the field will be ignored.
    • Replace: This option permits the deletion of the column, followed by recreation using a different type.
11. Test Connection
    • Click Test to verify the correctness of the connection settings to SQL Server.
    • A notification indicating Connected Successfully should appear in the top-right corner of the browser upon successful testing.
12. Save Changes
    • After verifying the connection, click Save to retain the configured settings.