Platform Release 8.0 to 9.2 Readiness

Upgrading your OneStream Platform to Version 8.2.0 or later requires .NET 8.

Business Rules

NOTE: Users upgrading from Platform Version 8.0.0 or later are not expected to require Business Rule maintenance.

Users upgrading from a Platform Version earlier than 8.0.0 will require Business Rule maintenance as Platform Version 8.0.0 includes updates and enhancements to the Business Rules compiler to improve syntax detection. Administrators must resolve these errors to compile business rules fully. Warning messages identify line items that will function, but you should update them to support the latest compiler’s requirements. Resolving these warnings varies. You may be able to use a provided replacement function or change a function’s properties.

System.Data.SqlClient to Microsoft.Data.SqlClient Migration

IMPORTANT:
To maintain consistency with Microsoft's recommendations, in Platform Version 8.1.0, the data access driver for SQL Server will be changed from System.Data.SqlClient to Microsoft.Data.SqlClient. This migration will be automatic and will take place during the database upgrade process. All references to System.Data.SqlClient will automatically be changed to Microsoft.Data.SqlClient in Business Rules, Member Formulas, and the like.

NOTE:
These updates will take place automatically during the database upgrade to Platform Version 8.1.0, and when using the Load function of Application Load/Extract, instances of System.Data.SqlClient will automatically convert to Microsoft.Data.SqlClient.

IMPORTANT:
If an application was migrated after the Platform Version 8.1.0 upgrade from Application Copy (Cloud Administration Tools (CAT)) or a database BACPAC file, then the migration from System.Data.SqlClient to Microsoft.Data.SqlClient will need to be applied directly to that application. On-premises customers can run the Upgrade SqlClient Namespace References from the OneStream Database Configuration utility to replace System.Data.SqlClient references. SaaS customers can request to have this run by contacting OneStream Support (https://www.onestream.com/support/).

See Platform v8+ Upgrade Resource.

Example

Business Rule Updates: Update Using and Import statements to reference Microsoft.Data.SqlClient using the following code:

C# Before 8.1.0

Copy
using System.Data.SqlClient;
...
SqlConnection conn1 = new System.Data.SqlClient.SqlConnection();
System.Data.SqlClient.SqlConnection conn2 = (System.Data.SqlClient.SqlConnection)conn1;

C# for 8.1.0

Copy
using Microsoft.Data.SqlClient;
...
SqlConnection conn1 = new Microsoft.Data.SqlClient.SqlConnection();
SqlConnection conn2 = (Microsoft.Data.SqlClient.SqlConnection)conn1;    

Visual Basic Before 8.1.0

Copy
Imports System.Data.SqlClient
...
Dim conn1 As New System.Data.SqlClient.SqlConnection()
Dim conn2 As System.Data.SqlClient.SqlConnection = CType(conn1, System.Data.SqlClient.SqlConnection)

Visual Basic for 8.1.0

Copy
Imports Microsoft.Data.SqlClient
...
Dim conn1 As New Microsoft.Data.SqlClient.SqlConnection()
Dim conn2 As SqlConnection = CType(conn1, Microsoft.Data.SqlClient.SqlConnection)

Custom DLLs

If your implementation or business rules reference custom DLLs that are not provided by OneStream, these DLLs must be .NET 8 compatible. Contact OneStream Support (https://www.onestream.com/support/) to discuss available upgrade options.

ERPConnect (SAP)

ERPConnect45.dll enabling connection to SAP systems is no longer available in Platform Versions 8.0.0 and later. A newer version ERPConnectStandard20.dll is available through the download "DLL Packages" from the Platform page of the Solution Exchange.

On-premises Customers:

  1. Download ERPConnectStandard20.dll file to your integrations folder.

  2. Install the required Microsoft Visual C++ Redistributable latest supported downloads.

  3. Download and copy SAP NetWeaver RFC Library DLL (sapnwrfc.dll) to the integrations folder.
    See Theobald Software ERPConnect Requirements.

  4. Modify your business rules to use the ERPConnectStandard20.dll.

Cloud/SaaS Customers: ERPConnect is available through Smart Integration Connector. See the Smart Integration Connector Guide or contact OneStream Support (https://www.onestream.com/support/) to discuss more upgrade options.

Smart Integration Connector

Smart Integration Connector is required for OneStream Cloud integration with local customer data sources when using OneStream Platform Version 8.0.0 or later. VPN is no longer supported with Platform Version 8.0.0 or later and reached end of service for versions earlier than Platform Version 8.0.0 on August 31, 2024.

See the Smart Integration Connector Guide.

Authentication

Cloud Customers: OneStream IdentityServer is required for OneStream Platform Version 8.0.0 or later. See the Identity and Access Management Guide.

Self-hosted Customers: No changes necessary. Legacy authentication support is the standard for self-hosted customers.

VBA Changes

ProcessSSOAuthenticationAndCreateToken is no longer supported as an authentication option from VBA scripts. See Visual Basic for Applications (VBA) Procedures.

Client API Changes

Client API is no longer provided with Platform Version 8.0.0 or later. OneStream recommends Task Scheduler or REST API to replace existing Client API use cases.

Tiles Page

The ClickOnce journey is enhanced to launch the application with a single click of the Open button while eliminating the tiles page. See Deployment using ClickOnce.

Help Documentation

Help documentation has moved from within the application to https://documentation.onestream.com/docs/. Clicking the in-app help icon routes you to this site.

Business Rule Groups

In Platform Version 8.0.0 the default for new Business Rule Access or Maintenance Groups is the Administrators group. This default can be changed by the Server Configuration Utility.

OneStream Solution Compatibility

Visit OneStream Solution Information on OneStream Community to ensure your OneStream Solutions are ready for your OneStream Platform upgrade.