OneStream Documentation

https://documentation.onestream.com/
Admin
The OneStream documentation provides comprehensive guides and resources for the OneStream platform,...
Tokens:118,169
Snippets:564
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Smart Integration Connector Installation Steps

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Details the required sequence for setting up the OneStream Smart Integration Connector, from installing the local gateway server to configuring data sources.

```APIDOC
Smart Integration Connector Setup:

1. Install OneStream Smart Integration Connector Local Gateway Server:
   - Software: OneStreamSmartIntegrationConnectorGateway-#.#.#.#####.msi
   - Environment: Windows Server 2019+

2. Create Gateway in OneStream Windows Application:
   - Purpose: Connect OneStream Cloud instance to a Local Gateway on the Local Gateway Server.

3. Export and Import Gateway Configuration:
   - Export: Gateway configuration from OneStream Windows application.
   - Import: Configuration to the Gateway Settings in the OneStream Local Gateway Configuration.

4. Database Connection Gateways (for local database access):
   a. Define Local Gateway Connection:
      - Include Data Sources through the OneStream Local Gateway Configuration.
   b. Test Data Sources:
      - Confirm communication for configured Data Sources.
      - NOTE: Direct connection testing may require building test business rules for validation.
   c. Define Custom Database Connection:
      - In the OneStream System Configuration Setup.

Post-Installation:
- Access remote data sources via business rules, member formulas, or dashboard data adapters in OneStream through the Smart Integration Connector.
```

--------------------------------

### Smart Integration Connector Installation Steps

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Details the required sequence for setting up the OneStream Smart Integration Connector, from installing the local gateway server to configuring data sources.

```APIDOC
Smart Integration Connector Setup:

1. Install OneStream Smart Integration Connector Local Gateway Server:
   - Software: OneStreamSmartIntegrationConnectorGateway-#.#.#.#####.msi
   - Environment: Windows Server 2019+

2. Create Gateway in OneStream Windows Application:
   - Purpose: Connect OneStream Cloud instance to a Local Gateway on the Local Gateway Server.

3. Export and Import Gateway Configuration:
   - Export: Gateway configuration from OneStream Windows application.
   - Import: Configuration to the Gateway Settings in the OneStream Local Gateway Configuration.

4. Database Connection Gateways (for local database access):
   a. Define Local Gateway Connection:
      - Include Data Sources through the OneStream Local Gateway Configuration.
   b. Test Data Sources:
      - Confirm communication for configured Data Sources.
      - NOTE: Direct connection testing may require building test business rules for validation.
   c. Define Custom Database Connection:
      - In the OneStream System Configuration Setup.

Post-Installation:
- Access remote data sources via business rules, member formulas, or dashboard data adapters in OneStream through the Smart Integration Connector.
```

--------------------------------

### MySQL Connection String Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Provides an example connection string for configuring a MySQL data source. It specifies server, port, user ID, password substitution, and database name. The MySQL Data Provider should be selected.

```SQL
Server = localhost;Port=3306;uid=root;pwd=|password|;database=gatewaymysql;
```

--------------------------------

### MySQL Connection String Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Provides an example connection string for configuring a MySQL data source. It specifies server, port, user ID, password substitution, and database name. The MySQL Data Provider should be selected.

```SQL
Server = localhost;Port=3306;uid=root;pwd=|password|;database=gatewaymysql;
```

--------------------------------

### Microsoft SQL Server Connection String Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Provides an example connection string for configuring a Microsoft SQL Server data source. It includes parameters for server, database, user ID, password substitution, and connection pooling. The SqlClient Data Provider is recommended.

```SQL
Server=localhost;Initial Catalog=Sales_DB;User ID=sa;Password=|password|;Max Pool Size=1000;Connect Timeout=60;
```

--------------------------------

### Microsoft SQL Server Connection String Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Provides an example connection string for configuring a Microsoft SQL Server data source. It includes parameters for server, database, user ID, password substitution, and connection pooling. The SqlClient Data Provider is recommended.

```SQL
Server=localhost;Initial Catalog=Sales_DB;User ID=sa;Password=|password|;Max Pool Size=1000;Connect Timeout=60;
```

--------------------------------

### Oracle Database Connection Strings

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Provides example connection strings for Oracle databases. It covers configurations for Oracle Data Provider for .NET (ODP.NET) and OracleClient, including options for using TNSNames.ora or direct connection details.

```APIDOC
Oracle Data Provider for .NET:
  Data Source=oracletest;User Id=OneStream1;Password=|password|;

Oracle Data Provider without TNSNames.ora:
  Data Source=(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=MyHost)(PORT=MyPort)))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=MyOracleSID))); User Id=myUsername;Password=|password|;
```

--------------------------------

### Oracle Database Connection Strings

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Provides example connection strings for Oracle databases. It covers configurations for Oracle Data Provider for .NET (ODP.NET) and OracleClient, including options for using TNSNames.ora or direct connection details.

```APIDOC
Oracle Data Provider for .NET:
  Data Source=oracletest;User Id=OneStream1;Password=|password|;

Oracle Data Provider without TNSNames.ora:
  Data Source=(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=MyHost)(PORT=MyPort)))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=MyOracleSID))); User Id=myUsername;Password=|password|;
```

--------------------------------

### OracleClient Database Provider Setup

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Steps to configure an OracleClient database provider in the utility. This includes setting the Data Source Name, Connection String, and selecting the OracleClient Data Provider.

```APIDOC
1. Navigate to Data Sources.
2. Add a new Data Source item.
3. Data Source Name: Sales_EMEA
4. Connection String: Data Source=oracletest;User Id=OneStream1;Password=|password|
5. Enter Connection String Password for security.
6. Select 'OracleClient Data Provider' from Database Provider.
7. Test Connection and save.
```

--------------------------------

### OleDb Data Provider Connection String (Oracle)

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Example connection string for configuring an OleDb data source, typically for Oracle databases. It specifies the provider, data source, and user credentials.

```Configuration
Provider=OraOLEDB.Oracle;Data Source=localhost:1521/XE;Initial Catalog=myDataBase;User Id=myUsername;Password=|password|;
```

--------------------------------

### PostgreSQL (Npgsql Data Provider) Setup

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Instructions for setting up a PostgreSQL database connection using the Npgsql Data Provider. This includes defining the Data Source Name, Connection String, and selecting the Npgsql provider.

```APIDOC
1. Navigate to Data Sources.
2. Add a new Data Source item.
3. Data Source Name: RevenueMgmtPostGres
4. Connection String: Server=localhost;Port=5432;Database=revmgt;User Id=onestream;Password=|password|;
5. Enter Connection String Password for security.
6. Select 'Npgsql Data Provider' from Database Provider.
7. Test Connection and save.
```

--------------------------------

### OracleClient Database Provider Setup

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Steps to configure an OracleClient database provider in the utility. This includes setting the Data Source Name, Connection String, and selecting the OracleClient Data Provider.

```APIDOC
1. Navigate to Data Sources.
2. Add a new Data Source item.
3. Data Source Name: Sales_EMEA
4. Connection String: Data Source=oracletest;User Id=OneStream1;Password=|password|
5. Enter Connection String Password for security.
6. Select 'OracleClient Data Provider' from Database Provider.
7. Test Connection and save.
```

--------------------------------

### PostgreSQL (Npgsql Data Provider) Setup

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Instructions for setting up a PostgreSQL database connection using the Npgsql Data Provider. This includes defining the Data Source Name, Connection String, and selecting the Npgsql provider.

```APIDOC
1. Navigate to Data Sources.
2. Add a new Data Source item.
3. Data Source Name: RevenueMgmtPostGres
4. Connection String: Server=localhost;Port=5432;Database=revmgt;User Id=onestream;Password=|password|;
5. Enter Connection String Password for security.
6. Select 'Npgsql Data Provider' from Database Provider.
7. Test Connection and save.
```

--------------------------------

### OleDb Data Provider Connection String (Oracle)

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Example connection string for configuring an OleDb data source, typically for Oracle databases. It specifies the provider, data source, and user credentials.

```Configuration
Provider=OraOLEDB.Oracle;Data Source=localhost:1521/XE;Initial Catalog=myDataBase;User Id=myUsername;Password=|password|;
```

--------------------------------

### Microsoft Entra Authentication Connection String Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Example connection string for authenticating to Azure SQL databases using Microsoft Entra ID service principal authentication with the OneStream Gateway. This enables secure access to cloud SQL databases.

```APIDOC
Server=demo.database.windows.net; Authentication=Active Directory Service Principal; Encrypt=True; Database=testdb; User Id=AppId; Password=|password|;
```

--------------------------------

### ODBC Data Provider Connection String (Oracle)

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Example connection string for configuring an ODBC data source, typically for Oracle databases using a system DSN. It includes driver details and server connection information.

```Configuration
Driver={Microsoft ODBC for Oracle};Server=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=199.199.199.199)(PORT=1523))(CONNECT_DATA=(SID=dbName)));Uid=myUsername;Pwd=|password|;
```

--------------------------------

### ODBC Data Provider Connection String (Oracle)

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Example connection string for configuring an ODBC data source, typically for Oracle databases using a system DSN. It includes driver details and server connection information.

```Configuration
Driver={Microsoft ODBC for Oracle};Server=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=199.199.199.199)(PORT=1523))(CONNECT_DATA=(SID=dbName)));Uid=myUsername;Pwd=|password|;
```

--------------------------------

### Integrated Security Connection String (SQL Server)

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Example connection string for SQL Server using integrated security (Trusted Connection). This method leverages Windows authentication to avoid storing credentials directly in the connection string.

```SQL
Data Source=localhost,Initial Catalog=OneStream_GolfStreamDemo_2022;Trusted_Connection=True;
```

--------------------------------

### Microsoft Entra Authentication Connection String Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Example connection string for authenticating to Azure SQL databases using Microsoft Entra ID service principal authentication with the OneStream Gateway. This enables secure access to cloud SQL databases.

```APIDOC
Server=demo.database.windows.net; Authentication=Active Directory Service Principal; Encrypt=True; Database=testdb; User Id=AppId; Password=|password|;
```

--------------------------------

### Integrated Security Connection String (SQL Server)

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Example connection string for SQL Server using integrated security (Trusted Connection). This method leverages Windows authentication to avoid storing credentials directly in the connection string.

```SQL
Data Source=localhost,Initial Catalog=OneStream_GolfStreamDemo_2022;Trusted_Connection=True;
```

--------------------------------

### Oracle Data Provider for .NET Setup

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Steps to configure an Oracle Data Provider for .NET (ODP.NET) database provider. This involves specifying the Data Source Name, Connection String, and selecting the ODP.NET provider.

```APIDOC
1. Navigate to Data Sources.
2. Data Source Name: Sales_SouthAmerica
3. Connection String: Data Source=oracletest;User Id=OneStream1;Password=|password|
4. Enter Connection String Password for security.
5. Select 'Oracle Data Provider for .NET' from Database Provider.
6. Add the new data source.
7. Test Connection and save.
```

--------------------------------

### Oracle Data Provider for .NET Setup

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Steps to configure an Oracle Data Provider for .NET (ODP.NET) database provider. This involves specifying the Data Source Name, Connection String, and selecting the ODP.NET provider.

```APIDOC
1. Navigate to Data Sources.
2. Data Source Name: Sales_SouthAmerica
3. Connection String: Data Source=oracletest;User Id=OneStream1;Password=|password|
4. Enter Connection String Password for security.
5. Select 'Oracle Data Provider for .NET' from Database Provider.
6. Add the new data source.
7. Test Connection and save.
```

--------------------------------

### Data Management Steps Example: Explicit Syntax

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Workspaces/8.1%20Configure%20the%20Service%20Factory

Illustrates the required explicit syntax for Data Management Steps, showing how to reference a Service Factory.

```APIDOC
Workspace.MyWorkspace.MyMU.WSMU
  Description: Required explicit syntax for Data Management Steps to reference a Service Factory.
  Example:
    Used when the factory is on the same Maintenance Unit as the step, using 'Current' keyword for robustness.
```

--------------------------------

### Parameter Naming Convention Example

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Parameter%20Guides/best-practices

Illustrates the recommended prefix and naming style for parameters to ensure quick identification and avoid special characters.

```text
ParamProductSegment
ParamCostCenter
ParamColumnColor
```

--------------------------------

### Data Management Steps Example: Explicit Syntax

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Workspaces/8.1 Configure the Service Factory

Illustrates the required explicit syntax for Data Management Steps, showing how to reference a Service Factory.

```APIDOC
Workspace.MyWorkspace.MyMU.WSMU
  Description: Required explicit syntax for Data Management Steps to reference a Service Factory.
  Example:
    Used when the factory is on the same Maintenance Unit as the step, using 'Current' keyword for robustness.
```

--------------------------------

### Install .NET Runtimes for OneStream

Source: https://documentation.onestream.com/1375907/Content/Upgrade%208.0/8.0 Pre Installation Upgrade Checklist

Lists the required .NET runtime installations for OneStream servers and clients. This includes ASP.NET Core Runtime and .NET Desktop Runtime, specifying minimum versions.

```Shell Script
# For App Server and Web Servers:
# Install ASP.NET Core Runtime (Hosting Bundle) - minimum v8.0.2
# Install .NET Desktop Runtime (x64) - minimum v8.0.2

# For Client:
# Install .NET Desktop Runtime (x64) - minimum v8.0.2
```

--------------------------------

### Restart OneStream Gateway Service Commands

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Demonstrates how to restart the OneStream Smart Integration Connector Gateway service using command-line utilities. This is an alternative to using the Windows Services GUI.

```bash
net start "OneStream Smart Integration Connector Gateway"
net stop "OneStream Smart Integration Connector Gateway"
```

--------------------------------

### Restart OneStream Gateway Service Commands

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Demonstrates how to restart the OneStream Smart Integration Connector Gateway service using command-line utilities. This is an alternative to using the Windows Services GUI.

```bash
net start "OneStream Smart Integration Connector Gateway"
net stop "OneStream Smart Integration Connector Gateway"
```

--------------------------------

### OneStream Gateway Service Restart via Configuration

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Instructions on how to restart the OneStream Smart Integration Connector Gateway service directly through the OneStream Local Gateway Configuration tool.

```APIDOC
1. Open the OneStream Local Gateway Configuration.
2. Click Tools > Restart OneStream Smart Integration Connector Gateway.
```

--------------------------------

### SQL Query Example

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Parameter%20Guides/bound-list-settings

Illustrative SQL query for a parameter, demonstrating data retrieval.

```SQL
SELECT MemberName, Description FROM Members WHERE Dimension = 'Account'
```

--------------------------------

### OneStream Gateway Service Restart via Configuration

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Instructions on how to restart the OneStream Smart Integration Connector Gateway service directly through the OneStream Local Gateway Configuration tool.

```APIDOC
1. Open the OneStream Local Gateway Configuration.
2. Click Tools > Restart OneStream Smart Integration Connector Gateway.
```

--------------------------------

### Direct Load Info Query Example

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Presentation/Data%20Adapters

Retrieves results from the StageDirectLoadInformation table. This method query is structured to specify workflow profile, scenario, time, and filter parameters.

```APIDOC
{Workflow Profile Name}{Scenario Name}{Time Name}{Filter}
```

--------------------------------

### Stage Summary Target Data Query Example

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Presentation/Data%20Adapters

Queries Summary Target Data, automatically determining whether to manage it as Row or Blob and returning results accordingly. The method query format is consistent with other adapter methods.

```APIDOC
{Workflow Profile Name}{Scenario Name}{Time Name}{Filter}
```

--------------------------------

### Example Connection Strings for Databases

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Data%20Collection%20Guides/Connector%20Data%20Source

Provides example connection strings for various database systems commonly used with OneStream integrations. These strings are used to establish communication between the OneStream application server and external data sources.

```SQL Server
Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=DBName;Data Source=SQLSERVERNAME
```

```ORACLE (11i or R12)
Provider=OraOLEDB.Oracle.1;Password=<xxxxx>;Persist Security Info=True;User ID=<username>;Data Source=frepro.world
```

```DB2
Provider=IBMDA400.DataSource.1;Password=<xxxxx>;Persist Security Info=True;User ID=OSuser;Data Source=HUTCH400;Use SQL Packages=True
```

```MS Access
Provider=Microsoft.ACE.OLEDB.12.0;Data Source=\\UNCFileShare\DB1.accdb;Mode=Read|Share Deny None;Persist Security Info=False
```

--------------------------------

### Install .NET Runtimes for OneStream

Source: https://documentation.onestream.com/1375907/Content/Upgrade%208.0/8.0%20Pre%20Installation%20Upgrade%20Checklist

Lists the required .NET runtime installations for OneStream servers and clients. This includes ASP.NET Core Runtime and .NET Desktop Runtime, specifying minimum versions.

```Shell Script
# For App Server and Web Servers:
# Install ASP.NET Core Runtime (Hosting Bundle) - minimum v8.0.2
# Install .NET Desktop Runtime (x64) - minimum v8.0.2

# For Client:
# Install .NET Desktop Runtime (x64) - minimum v8.0.2
```

--------------------------------

### Member List Example: Invoking from Cube View

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Workspaces/8.1 Configure the Service Factory

Shows how to reference a Member List parameter from a Cube View, requiring explicit syntax and shareable Workspaces.

```APIDOC
[Workspace.MyWorkspace.MyMU.WSMU,MyMemberList]
  Description: Invokes a Member List 'MyMemberList' from a Service Factory in 'MyMU' of 'MyWorkspace'. Requires explicit syntax and shareable Workspaces.
  Usage:
    From a Cube View.
```

--------------------------------

### Example Connection Strings for Databases

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Data Collection Guides/Connector Data Source

Provides example connection strings for various database systems commonly used with OneStream integrations. These strings are used to establish communication between the OneStream application server and external data sources.

```SQL Server
Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=DBName;Data Source=SQLSERVERNAME
```

```ORACLE (11i or R12)
Provider=OraOLEDB.Oracle.1;Password=<xxxxx>;Persist Security Info=True;User ID=<username>;Data Source=frepro.world
```

```DB2
Provider=IBMDA400.DataSource.1;Password=<xxxxx>;Persist Security Info=True;User ID=OSuser;Data Source=HUTCH400;Use SQL Packages=True
```

```MS Access
Provider=Microsoft.ACE.OLEDB.12.0;Data Source=\\UNCFileShare\DB1.accdb;Mode=Read|Share Deny None;Persist Security Info=False
```

--------------------------------

### Direct Load Info Query Example

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Presentation/Data Adapters

Retrieves results from the StageDirectLoadInformation table. This method query is structured to specify workflow profile, scenario, time, and filter parameters.

```APIDOC
{Workflow Profile Name}{Scenario Name}{Time Name}{Filter}
```

--------------------------------

### Parameter Sort Order Design Example

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Parameter%20Guides/best-practices

Demonstrates a staggered sort order strategy to facilitate the insertion of new parameters without reordering existing ones.

```text
Parameter 1: Sort Order 5
Parameter 2: Sort Order 25

(Allows insertion of new parameters with sort orders 6-24 without reordering existing ones.)
```

--------------------------------

### Migrate System.Data.SqlClient to Microsoft.Data.SqlClient in C#

Source: https://documentation.onestream.com/1375907/Content/Upgrade%208.0/8.1 .NET 6 Readiness

Demonstrates the code changes required in C# to update references from System.Data.SqlClient to Microsoft.Data.SqlClient for compatibility with OneStream Platform Release 8.1 and later.

```C#
using System.Data.SqlClient;
...
SqlConnection conn1 = new System.Data.SqlClient.SqlConnection();
System.Data.SqlClient.SqlConnection conn2 = (System.Data.SqlClient.SqlConnection)conn1;
```

```C#
using Microsoft.Data.SqlClient;
...
SqlConnection conn1 = new Microsoft.Data.SqlClient.SqlConnection();
SqlConnection conn2 = (Microsoft.Data.SqlClient.SqlConnection)conn1;
```

--------------------------------

### Migrate System.Data.SqlClient to Microsoft.Data.SqlClient in C#

Source: https://documentation.onestream.com/1375907/Content/Upgrade%208.0/8.1%20.NET%206%20Readiness

Demonstrates the code changes required in C# to update references from System.Data.SqlClient to Microsoft.Data.SqlClient for compatibility with OneStream Platform Release 8.1 and later.

```C#
using System.Data.SqlClient;
...
SqlConnection conn1 = new System.Data.SqlClient.SqlConnection();
System.Data.SqlClient.SqlConnection conn2 = (System.Data.SqlClient.SqlConnection)conn1;
```

```C#
using Microsoft.Data.SqlClient;
...
SqlConnection conn1 = new Microsoft.Data.SqlClient.SqlConnection();
SqlConnection conn2 = (Microsoft.Data.SqlClient.SqlConnection)conn1;
```

--------------------------------

### Update OneStream Gateway Service Permissions

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup and Installation

Steps to update the OneStream Smart Integration Connector Gateway service to run as a specific user account. This is crucial for the service to access necessary resources and maintain connections.

```APIDOC
1. Open Windows Services.
2. Navigate to "OneStream Smart Integration Connector Gateway".
3. Right-click and open "Properties".
4. Go to the "Log On" tab.
5. Change log on from "Local System account" to "This account" and enter domain/login credentials.
6. Click "Apply" and "OK".
7. Restart the service.
```

--------------------------------

### Member List Example: Invoking from Cube View

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Workspaces/8.1%20Configure%20the%20Service%20Factory

Shows how to reference a Member List parameter from a Cube View, requiring explicit syntax and shareable Workspaces.

```APIDOC
[Workspace.MyWorkspace.MyMU.WSMU,MyMemberList]
  Description: Invokes a Member List 'MyMemberList' from a Service Factory in 'MyMU' of 'MyWorkspace'. Requires explicit syntax and shareable Workspaces.
  Usage:
    From a Cube View.
```

--------------------------------

### Service Factory with DynamicDashboard (C#)

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Workspaces/8.1 Configure the Service Factory

An example of a Service Factory assembly file in C# that specifically uses the DynamicDashboard object. Unused objects are commented out to ensure correct compilation.

```csharp
namespace DynamicCode {
    public class WsAssemblyFactory {
        // Components
        // Dashboards
        // DataManagementStep
        // DataSet
        public DynamicDashboard DynamicDashboard;
        // Dynamic Cube View
        // Finance Business Rules
        // SqlTableEditor
        // TableViews
        // XFBRString
    }
}
```

--------------------------------

### Service Factory with DynamicDashboard (C#)

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Workspaces/8.1%20Configure%20the%20Service%20Factory

An example of a Service Factory assembly file in C# that specifically uses the DynamicDashboard object. Unused objects are commented out to ensure correct compilation.

```csharp
namespace DynamicCode {
    public class WsAssemblyFactory {
        // Components
        // Dashboards
        // DataManagementStep
        // DataSet
        public DynamicDashboard DynamicDashboard;
        // Dynamic Cube View
        // Finance Business Rules
        // SqlTableEditor
        // TableViews
        // XFBRString
    }
}
```

--------------------------------

### OneStream Configuration File Paths

Source: https://documentation.onestream.com/1375907/Content/Upgrade%208.0/8.0 Pre Installation Upgrade Checklist

Identifies the default locations for OneStream's appsettings.json file on both web and application servers. These paths are crucial for locating configuration settings before an upgrade.

```Windows Configuration
Web servers: C:\Program Files\OneStream Software\OneStream WebRoot\OneStreamWeb\appsettings.json
Application servers: C:\Program Files\OneStreamSoftware\OneStreamAppRoot\OneStreamApp\appsettings.json
```

--------------------------------

### Database Query Rule in C# (Partial)

Source: https://documentation.onestream.com/1375907/Content/SIC/Business%20Rules

An incomplete C# code snippet for a remote business rule that queries a database and intends to return a DataTable. The example shows the setup for connection string and SQL query.

```csharp
// SIC Function referenced by other examples here
namespace OneStream.BusinessRule.SmartIntegrationFunction.GetDataFromDB
{
 public class MainClass
 {
 private const string DataSourceName = "";
 public DataTable RunOperation()
 {
 DataTable dataTableResults = new DataTable();
 string connectionString, sql;

```

--------------------------------

### Database Query Rule in C# (Partial)

Source: https://documentation.onestream.com/1375907/Content/SIC/Business Rules

An incomplete C# code snippet for a remote business rule that queries a database and intends to return a DataTable. The example shows the setup for connection string and SQL query.

```csharp
// SIC Function referenced by other examples here
namespace OneStream.BusinessRule.SmartIntegrationFunction.GetDataFromDB
{
 public class MainClass
 {
 private const string DataSourceName = "";
 public DataTable RunOperation()
 {
 DataTable dataTableResults = new DataTable();
 string connectionString, sql;

```

--------------------------------

### .NET String.Format Example

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Parameter%20Guides/bound-list-settings

Example of using .NET String.Format syntax for custom display text in parameters.

```.NET
string formatString = "The color is {0}.";
string value = "Blue";
string displayText = String.Format(formatString, value); 
// displayText will be "The color is Blue."
```

--------------------------------

### GetRemoteGatewayJobStatus VB Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Business%20Rules

Demonstrates invoking a remote gateway job and polling its status using VB.NET. This example simulates a long-running task and checks for job completion. Requires `allowRemoteCodeExec = true`.

```vb
' Invoke long running job as part of a Data management/Extender rule
Public Function Main(ByVal si As SessionInfo, ByVal globals As BRGLOBALS, ByVal api As Object, ByVal args As ExtenderArgs) As Object
  Dim jobID As Guid
  Dim objRemoteRequestResultDto As RemoteRequestResultDto = BRApi.Utilities.ExecRemoteGatewayJob(si, "LongRunningTest", Nothing, "testConnection",String.Empty)

  If (objRemoteRequestResultDto.RemoteResultStatus = RemoteMessageResultType.JobRunning) Then
  jobID = objRemoteRequestResultDto.RequestJobID
  BRApi.ErrorLog.LogMessage(si, "Remote Job Queued and Running - JobID: " & jobID.ToString())
  'Example waiting 20 seconds for job to complete
  For loopControl = 0 To 10
  System.Threading.Thread.Sleep(2000)
  Dim objJobStatus As RemoteJobStatusResultDto = BRApi.Utilities.GetRemoteGatewayJobStatus(si, JobID, "testconnection2")
  If (objJobStatus.RemoteJobState = RemoteJobState.Running)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Still running - JobID: " & jobID.ToString())
  ElseIf (objJobStatus.RemoteJobState = RemoteJobState.Completed)
  ' Checking the return type from the remote job
  If (Not (objJobStatus.RemoteJobResult.ResultSet Is Nothing))
  Dim xfDT = New XFDataTable(si, objJobStatus.RemoteJobResult.ResultSet, Nothing, 1000)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Datatable Returned - JobID: " & jobID.ToString())
  Return Nothing
  ElseIf (Not (objJobStatus.RemoteJobResult.ResultDataSet Is Nothing))
  Dim xfDT = New XFDataTable(si, objJobStatus.RemoteJobResult.ResultDataSet.Tables(0), Nothing, 1000)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Dataset Returned - JobID: " & jobID.ToString())
  ElseIf (Not (objJobStatus.RemoteJobResult.ObjectResultValue Is Nothing))
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Object Returned - JobID: " & jobID.ToString())
  Return Nothing
  End If
  ElseIf (objJobStatus.RemoteJobState = RemoteJobState.JobNotFound)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Not Found - JobID: " & jobID.ToString())
  Return Nothing
  ElseIf (objJobStatus.RemoteJobState = RemoteJobState.RequestTimeOut)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Timed Out - JobID: " & jobID.ToString())
  Return Nothing
  ElseIf (objRemoteRequestResultDto.RemoteResultStatus = RemoteMessageResultType.Exception)
  BRApi.ErrorLog.LogMessage(si, "Exception During Exeuction of Job: " & objRemoteRequestResultDto.RemoteException.ToString())
  End If
  Next
  ElseIf (objRemoteRequestResultDto.RemoteResultStatus = RemoteMessageResultType.Exception)
  BRApi.ErrorLog.LogMessage(si, "Exception Executing Job: " & objRemoteRequestResultDto.RemoteException.ToString())
  Else
  BRApi.ErrorLog.LogMessage(si, "General Job Execution Error - State: " & objRemoteRequestResultDto.RemoteResultStatus.ToString())
  End If
  Return Nothing
End Function
```

--------------------------------

### GetRemoteGatewayJobStatus VB Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Business Rules

Demonstrates invoking a remote gateway job and polling its status using VB.NET. This example simulates a long-running task and checks for job completion. Requires `allowRemoteCodeExec = true`.

```vb
' Invoke long running job as part of a Data management/Extender rule
Public Function Main(ByVal si As SessionInfo, ByVal globals As BRGLOBALS, ByVal api As Object, ByVal args As ExtenderArgs) As Object
  Dim jobID As Guid
  Dim objRemoteRequestResultDto As RemoteRequestResultDto = BRApi.Utilities.ExecRemoteGatewayJob(si, "LongRunningTest", Nothing, "testConnection",String.Empty)

  If (objRemoteRequestResultDto.RemoteResultStatus = RemoteMessageResultType.JobRunning) Then
  jobID = objRemoteRequestResultDto.RequestJobID
  BRApi.ErrorLog.LogMessage(si, "Remote Job Queued and Running - JobID: " & jobID.ToString())
  'Example waiting 20 seconds for job to complete
  For loopControl = 0 To 10
  System.Threading.Thread.Sleep(2000)
  Dim objJobStatus As RemoteJobStatusResultDto = BRApi.Utilities.GetRemoteGatewayJobStatus(si, JobID, "testconnection2")
  If (objJobStatus.RemoteJobState = RemoteJobState.Running)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Still running - JobID: " & jobID.ToString())
  ElseIf (objJobStatus.RemoteJobState = RemoteJobState.Completed)
  ' Checking the return type from the remote job
  If (Not (objJobStatus.RemoteJobResult.ResultSet Is Nothing))
  Dim xfDT = New XFDataTable(si, objJobStatus.RemoteJobResult.ResultSet, Nothing, 1000)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Datatable Returned - JobID: " & jobID.ToString())
  Return Nothing
  ElseIf (Not (objJobStatus.RemoteJobResult.ResultDataSet Is Nothing))
  Dim xfDT = New XFDataTable(si, objJobStatus.RemoteJobResult.ResultDataSet.Tables(0), Nothing, 1000)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Dataset Returned - JobID: " & jobID.ToString())
  ElseIf (Not (objJobStatus.RemoteJobResult.ObjectResultValue Is Nothing))
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Object Returned - JobID: " & jobID.ToString())
  Return Nothing
  End If
  ElseIf (objJobStatus.RemoteJobState = RemoteJobState.JobNotFound)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Not Found - JobID: " & jobID.ToString())
  Return Nothing
  ElseIf (objJobStatus.RemoteJobState = RemoteJobState.RequestTimeOut)
  BRApi.ErrorLog.LogMessage(si, "Remote Job Timed Out - JobID: " & jobID.ToString())
  Return Nothing
  ElseIf (objRemoteRequestResultDto.RemoteResultStatus = RemoteMessageResultType.Exception)
  BRApi.ErrorLog.LogMessage(si, "Exception During Exeuction of Job: " & objRemoteRequestResultDto.RemoteException.ToString())
  End If
  Next
  ElseIf (objRemoteRequestResultDto.RemoteResultStatus = RemoteMessageResultType.Exception)
  BRApi.ErrorLog.LogMessage(si, "Exception Executing Job: " & objRemoteRequestResultDto.RemoteException.ToString())
  Else
  BRApi.ErrorLog.LogMessage(si, "General Job Execution Error - State: " & objRemoteRequestResultDto.RemoteResultStatus.ToString())
  End If
  Return Nothing
End Function
```

--------------------------------

### Manually Stop and Start OneStream Service (PowerShell)

Source: https://documentation.onestream.com/1375907/Content/SIC/Troubleshooting

Provides PowerShell commands to manually stop and start the OneStream Smart Integration Connector Gateway service. This is an alternative to using the command prompt for service management.

```powershell
stop-service -ServiceName OneStreamSmartIntegration
start-service -ServiceName OneStreamSmartIntegration
```

--------------------------------

### Stage Summary Target Data Query Example

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Presentation/Data Adapters

Queries Summary Target Data, automatically determining whether to manage it as Row or Blob and returning results accordingly. The method query format is consistent with other adapter methods.

```APIDOC
{Workflow Profile Name}{Scenario Name}{Time Name}{Filter}
```

--------------------------------

### Manually Stop and Start OneStream Service (Command Prompt)

Source: https://documentation.onestream.com/1375907/Content/SIC/Troubleshooting

Provides commands to manually stop and start the OneStream Smart Integration Connector Gateway service using an elevated command prompt. This is useful for troubleshooting service-related errors.

```batch
net stop OneStreamSmartIntegration
net start OneStreamSmartIntegration
```

--------------------------------

### SQL Data Source Configuration

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Presentation/Data%20Adapters

Configure SQL queries for data adapters, referencing substitution variables like |WFProfile|. Supports specifying database locations (Application, Framework, External) and defining output table names.

```APIDOC
SQL Data Source Configuration:
  Database Location:
    - Application: Current OneStream Application database.
    - Framework: Connected OneStream Framework database.
    - External: Any other database outside of OneStream.
  External Database Connection: Name defined in OneStream Server Configuration Utility (if Database Location is External).
  SQL Query: The SQL statement to run. Supports substitution variables (e.g., |WFProfile|).
  Results Table List: Name for the resulting table generated by the Data Adapter. Defaults to 'Table'.
```

--------------------------------

### Member Filter Builder Syntax Examples

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Cube%20Views/Member%20Filter%20Builder%20Introduction

Examples of syntax used within the Member Filter Builder for creating complex member filters, including member expansions, where clauses, and time functions.

```APIDOC
Member Expansion Example:
UD2#AllProducts.Children.Where(Name Contains Clubs)

Time Function Example:
T#POVPrior1

Description:
These examples illustrate the specific syntax required for building member filters. The 'Where' clause allows for conditional filtering of members based on properties like 'Name'. Time functions enable referencing specific time periods. The 'Samples' tab provides further examples for calculations and custom member lists.
```

--------------------------------

### SQL Data Source Configuration

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Presentation/Data Adapters

Configure SQL queries for data adapters, referencing substitution variables like |WFProfile|. Supports specifying database locations (Application, Framework, External) and defining output table names.

```APIDOC
SQL Data Source Configuration:
  Database Location:
    - Application: Current OneStream Application database.
    - Framework: Connected OneStream Framework database.
    - External: Any other database outside of OneStream.
  External Database Connection: Name defined in OneStream Server Configuration Utility (if Database Location is External).
  SQL Query: The SQL statement to run. Supports substitution variables (e.g., |WFProfile|).
  Results Table List: Name for the resulting table generated by the Data Adapter. Defaults to 'Table'.
```

--------------------------------

### Member Filter Builder Syntax Examples

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Cube Views/Member Filter Builder Introduction

Examples of syntax used within the Member Filter Builder for creating complex member filters, including member expansions, where clauses, and time functions.

```APIDOC
Member Expansion Example:
UD2#AllProducts.Children.Where(Name Contains Clubs)

Time Function Example:
T#POVPrior1

Description:
These examples illustrate the specific syntax required for building member filters. The 'Where' clause allows for conditional filtering of members based on properties like 'Name'. Time functions enable referencing specific time periods. The 'Samples' tab provides further examples for calculations and custom member lists.
```

--------------------------------

### GetRemoteGatewayJobStatus C# Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Business%20Rules

Demonstrates invoking a remote gateway job and polling its status using C#. This example simulates a long-running task and checks for job completion, handling different return types like DataTables or Datasets. Requires `allowRemoteCodeExec = true`.

```csharp
// Invoke long running job as part of a Data management/Extender rule
public object Main(SessionInfo si, BRGlobals globals, object api, ExtenderArgs args)
{
  Guid jobID;
  RemoteRequestResultDto objRemoteRequestResultDto = BRApi.Utilities.ExecRemoteGatewayJob(si, "LongRunningTest", null/* TODO Change to default(_) if this is not a reference type */, "testConnection", string.Empty);

  if ((objRemoteRequestResultDto.RemoteResultStatus == RemoteMessageResultType.JobRunning))
  {
  jobID = objRemoteRequestResultDto.RequestJobID;
  BRApi.ErrorLog.LogMessage(si, "Remote Job Queued and Running - JobID: " + jobID.ToString());

  for (var loopControl = 0; loopControl <= 10; loopControl++)
  {
  System.Threading.Thread.Sleep(2000);
  RemoteJobStatusResultDto objJobStatus = BRApi.Utilities.GetRemoteGatewayJobStatus(si, jobID, "testconnection2");
  if ((objJobStatus.RemoteJobState == RemoteJobState.Running))
  BRApi.ErrorLog.LogMessage(si, "Remote Job Still running - JobID: " + jobID.ToString());
  else if ((objJobStatus.RemoteJobState == RemoteJobState.Completed)
  )
  {
  // Checking the return type from the remote job
  if (!(objJobStatus.RemoteJobResult.ResultSet == null))
  {
  var xfDT = new XFDataTable(si, objJobStatus.RemoteJobResult.ResultSet, null, 1000);
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Datatable Returned - JobID: " + jobID.ToString());
  return null;
  }
  else if (!(objJobStatus.RemoteJobResult.ResultDataSet == null))
  {
  var xfDT = new XFDataTable(si, objJobStatus.RemoteJobResult.ResultDataSet.Tables[0], null, 1000);
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Dataset Returned - JobID: " + jobID.ToString());
  }
  else if (!(objJobStatus.RemoteJobResult.ObjectResultValue == null))
  {
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Object Returned - JobID: " + jobID.ToString());
  return null;
  }
  }
  else if ((objJobStatus.RemoteJobState == RemoteJobState.JobNotFound))
  {
  BRApi.ErrorLog.LogMessage(si, "Remote Job Not Found - JobID: " + jobID.ToString());
  return null;
  }
  else if ((objJobStatus.RemoteJobState == RemoteJobState.RequestTimeOut))
  {
  BRApi.ErrorLog.LogMessage(si, "Remote Job Timed Out - JobID: " + jobID.ToString());
  return null;
  }
  else if ((objRemoteRequestResultDto.RemoteResultStatus == RemoteMessageResultType.Exception))
  BRApi.ErrorLog.LogMessage(si, "Exception During Exeuction of Job: " + objRemoteRequestResultDto.RemoteException.ToString());
  }
  }
  else if ((objRemoteRequestResultDto.RemoteResultStatus == RemoteMessageResultType.Exception))
  BRApi.ErrorLog.LogMessage(si, "Exception Executing Job: " + objRemoteRequestResultDto.RemoteException.ToString());
  else
  BRApi.ErrorLog.LogMessage(si, "General Job Execution Error - State: " + objRemoteRequestResultDto.RemoteResultStatus.ToString());
  return null;
}
```

--------------------------------

### GetRemoteGatewayJobStatus C# Example

Source: https://documentation.onestream.com/1375907/Content/SIC/Business Rules

Demonstrates invoking a remote gateway job and polling its status using C#. This example simulates a long-running task and checks for job completion, handling different return types like DataTables or Datasets. Requires `allowRemoteCodeExec = true`.

```csharp
// Invoke long running job as part of a Data management/Extender rule
public object Main(SessionInfo si, BRGlobals globals, object api, ExtenderArgs args)
{
  Guid jobID;
  RemoteRequestResultDto objRemoteRequestResultDto = BRApi.Utilities.ExecRemoteGatewayJob(si, "LongRunningTest", null/* TODO Change to default(_) if this is not a reference type */, "testConnection", string.Empty);

  if ((objRemoteRequestResultDto.RemoteResultStatus == RemoteMessageResultType.JobRunning))
  {
  jobID = objRemoteRequestResultDto.RequestJobID;
  BRApi.ErrorLog.LogMessage(si, "Remote Job Queued and Running - JobID: " + jobID.ToString());

  for (var loopControl = 0; loopControl <= 10; loopControl++)
  {
  System.Threading.Thread.Sleep(2000);
  RemoteJobStatusResultDto objJobStatus = BRApi.Utilities.GetRemoteGatewayJobStatus(si, jobID, "testconnection2");
  if ((objJobStatus.RemoteJobState == RemoteJobState.Running))
  BRApi.ErrorLog.LogMessage(si, "Remote Job Still running - JobID: " + jobID.ToString());
  else if ((objJobStatus.RemoteJobState == RemoteJobState.Completed)
  )
  {
  // Checking the return type from the remote job
  if (!(objJobStatus.RemoteJobResult.ResultSet == null))
  {
  var xfDT = new XFDataTable(si, objJobStatus.RemoteJobResult.ResultSet, null, 1000);
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Datatable Returned - JobID: " + jobID.ToString());
  return null;
  }
  else if (!(objJobStatus.RemoteJobResult.ResultDataSet == null))
  {
  var xfDT = new XFDataTable(si, objJobStatus.RemoteJobResult.ResultDataSet.Tables[0], null, 1000);
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Dataset Returned - JobID: " + jobID.ToString());
  }
  else if (!(objJobStatus.RemoteJobResult.ObjectResultValue == null))
  {
  BRApi.ErrorLog.LogMessage(si, "Remote Job Completed - Object Returned - JobID: " + jobID.ToString());
  return null;
  }
  }
  else if ((objJobStatus.RemoteJobState == RemoteJobState.JobNotFound))
  {
  BRApi.ErrorLog.LogMessage(si, "Remote Job Not Found - JobID: " + jobID.ToString());
  return null;
  }
  else if ((objJobStatus.RemoteJobState == RemoteJobState.RequestTimeOut))
  {
  BRApi.ErrorLog.LogMessage(si, "Remote Job Timed Out - JobID: " + jobID.ToString());
  return null;
  }
  else if ((objRemoteRequestResultDto.RemoteResultStatus == RemoteMessageResultType.Exception))
  BRApi.ErrorLog.LogMessage(si, "Exception During Exeuction of Job: " + objRemoteRequestResultDto.RemoteException.ToString());
  }
  }
  else if ((objRemoteRequestResultDto.RemoteResultStatus == RemoteMessageResultType.Exception))
  BRApi.ErrorLog.LogMessage(si, "Exception Executing Job: " + objRemoteRequestResultDto.RemoteException.ToString());
  else
  BRApi.ErrorLog.LogMessage(si, "General Job Execution Error - State: " + objRemoteRequestResultDto.RemoteResultStatus.ToString());
  return null;
}
```

--------------------------------

### Migrate System.Data.SqlClient to Microsoft.Data.SqlClient in Visual Basic

Source: https://documentation.onestream.com/1375907/Content/Upgrade%208.0/8.1%20.NET%206%20Readiness

Illustrates the necessary code modifications in Visual Basic to transition from System.Data.SqlClient to Microsoft.Data.SqlClient, ensuring compatibility with OneStream Platform Release 8.1 and newer versions.

```VB
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)
```

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

--------------------------------

### Migrate System.Data.SqlClient to Microsoft.Data.SqlClient in Visual Basic

Source: https://documentation.onestream.com/1375907/Content/Upgrade%208.0/8.1 .NET 6 Readiness

Illustrates the necessary code modifications in Visual Basic to transition from System.Data.SqlClient to Microsoft.Data.SqlClient, ensuring compatibility with OneStream Platform Release 8.1 and newer versions.

```VB
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)
```

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

--------------------------------

### Bound List Method Query Syntax and Example

Source: https://documentation.onestream.com/1375907/Content/Design%20and%20Reference/Parameter%20Guides/parameter-types

Defines the structure for method queries used in Bound List parameters, including placeholders for dimension type, name, member filter, and a WHERE clause. An example demonstrates its usage for listing entity descendants.

```APIDOC
{Dimension type}{Dimension name}{Member Filter}{where clause}
```

```APIDOC
{Entity}{CorpEntities}{E#Root.TreeDescendants}{}
```

--------------------------------

### Update OneStream Gateway Service Permissions

Source: https://documentation.onestream.com/1375907/Content/SIC/Setup%20and%20Installation

Steps to update the OneStream Smart Integration Connector Gateway service to run as a specific user account. This is crucial for the service to access necessary resources and maintain connections.

```APIDOC
1. Open Windows Services.
2. Navigate to "OneStream Smart Integration Connector Gateway".
3. Right-click and open "Properties".
4. Go to the "Log On" tab.
5. Change log on from "Local System account" to "This account" and enter domain/login credentials.
6. Click "Apply" and "OK".
7. Restart the service.
```
Tokens:
Raw