OneStream: Read Adapter
Description
Section titled “Description”Reads a data adapter in a OneStream workspace over your OneStream connection and lands its rows in a table. It makes one call to the adapter for each consolidation member you list, and replaces the target table with the rows of all of them. Use it to bring consolidated results into a project, for example to reconcile a model to them.
This step appears in the step menu under OneStream. Data Foundation uses it when you add OneStream as a source.
Configuration
Section titled “Configuration”Source
Section titled “Source”| Field | Required | Notes |
|---|---|---|
| OneStream Connection | Yes | The OneStream connection to read through. |
| Environment | No | The connection’s environment. Defaults to default. |
| Application | No | Leave blank to use the application saved on the connection. A step must have one or the other. |
| Workspace | No | Leave blank to use the workspace saved on the connection. |
| Adapter | Yes | The data adapter to read. Foundation_Results is the adapter described on the connection page. |
| Adapter Table | No | The table name within the adapter’s data set. |
| Run Sequence First | No | A Data Management sequence to run before reading, to refresh what the adapter reads. |
Data Slice
Section titled “Data Slice”| Field | Notes |
|---|---|
| Members | One consolidation member per line. The step calls the adapter once for each, with the member in the substitution variable Member. Blank makes one call on the adapter’s default member. |
| Substitution Variables | One Name=Value per line, for example Time=2026M1. |
| View | Year to date (the default) or Periodic. Passed to the adapter in the substitution variable View. |
| Sign | As stored (the default) or Flip sign, which negates every amount. |
| Amount Scale | A multiplier applied to every amount. Defaults to 1. Use 1000 when OneStream serves values in thousands. |
Variables in the application, workspace, table, sequence, members and substitution values are filled in as the workflow runs.
Target
Section titled “Target”| Field | Required | Notes |
|---|---|---|
| Target table | Yes | The table the rows land in. It is replaced on every run and must be a table, not a view. |
Output
Section titled “Output”The target table has the adapter’s columns: entity, account, time, scenario, view, amount, currency, flow, ud1, ud2, ud3 and ud4. Every column lands as text except amount, which is numeric after the scale and sign are applied.
If the adapter returns no rows, the target table is replaced with an empty one and the step finishes with a warning that names the adapter, not an error.