Data Adapters

What is a Data Adapter Component?

Data Adapters specify the kind of data used within a Dashboard. Once the Data Adapter is configured and pointing to the appropriate data through a method query, run the Data Adapter to view the generated results table. Lastly, attach the Data Adapter to a Dashboard Component to display queried data on a Dashboard.

When to use

Use a Data Adapter when your dashboard needs to integrate and display data from external data sources. Also, if your application requires real-time updates or dynamic data fetching, the Data Adapter is essential for making sure that dashboards reflect the most current information.

When not to use

If the dashboard only requires static data that does not need to be connected to or fetched from an external data source, it’s more efficient to use static content or predefined datasets.

Properties

Types

Understanding the types of Data Adapters available for data binding in OneStream’s logical layer is paramount to the reporting experience.

• Excel files
• SQL Data Adapter
• Method Query Business Rule (Implementation defined)
• Pre-defined Method Queries (Defined and maintained by OS)
• Cube View

Excel types: Return data sourced from an Excel file. Parameters for method type ‘ExcelFile’ should include the following, each enclosed in curly braces:

• Example: {FileSourceType}{UrlOrFullFileName}{Sheet}{NamedRange}{UseFirstRowForColumnNames}{IncludeNumericColumns}{Filter}

SQL: A SQL query against either the Application or Framework database can be written as a Data Source. Reference substitution variables such as |WFProfile| from within the SQL statement. Select the database location and then enter the SQL statement to be run for the Data Adapter.

• Example: SELECT * FROM Customers

Pre-defined Method Queries: Use the pre-defined method queries for quick solutions. These queries are defined and maintained by OneStream.

• Example: WorkflowAndEntityStatus, UsersInGroups, and DataCellDetail

Method Query Business Rule: Use the Business Rule option when creating a custom rule to incorporate within a Method Query. The Business Rule is used as the first set of within the Method Query.

• Example: {Workspace.Current.AssemblyName}{FunctionName}{OptionalParameters}

Cube View: Choose a Cube View as the source of a Data Adapter. Additional options can be selected here to include supplemental information for the resulting tables. However, adding to what is defaulted may have a slight impact on performance.

This command type allows for a pre-configured Cube View to be the Data Source for a Dashboard. Click and begin typing the name of the Cube View in the blank field. As the first few letters are typed, the names are filtered, making it easier to find and select the one desired. If the name is unknown, expand the Cube View Groups option and scroll through the list to select the correct one. Once the Cube View is selected, click CTRL and Double Click. This will enter the correct name into the appropriate field.

Create a Data Adapter

1. Click Application > Presentation > Workspaces
2. Expand the Workspace and Dashboard Maintenance Unit where the Data Adapter will be created, then click on Data Adapters.
3. Click the Create Data Adapter button in the dashboard toolbar.
4. In Name and Description, enter a name and description for the Data Adapter. Do not use special characters, dashes (-) or underscores (_) in names.
5. In the Command Type field, select a Data Source option from the combo box.
6. Configure the rest of the Data Source fields based on which Command Type was selected.
7. Click Save.
8. Test the Data Adapter by clicking Test Data Adapter. The Data Preview dialog box will display the Query and the Data Table(s).
9. Click Close.