OneStream for Data Foundation
Connect PlaidCloud to OneStream so Data Foundation can read your consolidated results and reconcile its management group profit and loss to them. OneStream is supported through its connector: PlaidCloud signs in with OAuth 2.0 client credentials and reads a data adapter that your OneStream administrator builds. It only reads. If you name a Data Management sequence, PlaidCloud runs that sequence first to refresh what the adapter reads, and runs nothing else.
OneStream is a source of results to reconcile to, not of ledger lines: its rows land as the Consolidated scenario of the model’s budget table, version OneStream. See Reconcile to Your Consolidation System.
What Your OneStream Administrator Sets Up
Section titled “What Your OneStream Administrator Sets Up”The Foundation tab writes an access request for you to send. It asks for the following.
-
A client for PlaidCloud in OneStream’s identity service that uses the client credentials grant, with a service user who can run the adapter and, if you want PlaidCloud to refresh results first, the Data Management sequence.
-
In the application and workspace you report on, a data adapter named Foundation_Results that returns one table of the consolidated results with exactly these columns:
Column Holds entityThe consolidation member: an entity, an elimination member or the group total. accountThe account code. Base accounts only. timeThe month, as YYYY-MM.scenarioThe scenario. viewYTDorPeriodic. PlaidCloud reads only the rows of the view you choose.amountA number, in the sign and scale your reports show. currencyThe currency the amount is stated in: your group’s reporting currency. flow,ud1,ud2,ud3,ud4Flow and user-defined dimensions. Base members only. Serve base members of the account, flow and user-defined dimensions. A parent member’s row would count its children twice. The adapter reads the consolidation member from the substitution variable
Memberand the view fromView. -
The members to read: the entities, the elimination members and the group total.
Create the Connection
Section titled “Create the Connection”-
Open Tools > Connections and click
New Connection, then choose REST - OneStream. -
Fill in the fields:
Field Value Host The OneStream base URL, starting with https://.Client ID The client ID of the PlaidCloud client. Client Secret Its secret. Stored encrypted and never shown again. Token URL Leave blank to use the Host followed by /identity/connect/token.Default Application Used by a read that leaves its application blank. Default Workspace Used by a read that leaves its workspace blank. Timeout (seconds) Defaults to 120. -
Click
Create.
You can also create the connection on the Foundation tab when you add the source: choose Create a new connection and fill in API host URL, Client ID, Client secret, Token URL, Application and Workspace, which mean the same as the fields above.
Add It to a Data Foundation Project
Section titled “Add It to a Data Foundation Project”On the Foundation tab, add the connection as a source, as you would any other (see Connect Your ERP), OneStream lists no members to tick, so the form asks for the consolidation member to read: enter it under Name. Then, under System settings, describe the adapter’s amounts. The settings show by these names:
| Setting | What it means |
|---|---|
view |
ytd (the default) when the adapter’s amounts are year to date, or periodic. Year-to-date rows land as periodic amounts. |
sign |
natural (the default): each account in its own sign, as OneStream reports it. debit_positive: debits positive. |
scale |
The multiplier to whole currency units: 1000 when OneStream serves thousands. Defaults to 1. |
fy_start_month |
The month your fiscal year starts, from 1 to 12, for converting year to date to periodic. Defaults to 1. |
application, workspace |
Override the connection’s. Leave blank to use the connection’s. |
table |
The table name within the adapter’s data set. Defaults to Results. |
sequence |
A Data Management sequence run before the read to refresh what the adapter reads. |
Map the OneStream members to your entities with a code-map file that applies to this source. See Entity Crosswalk. The source reads no history window: the adapter’s own substitution variables bound it.
A load that returns no rows from the adapter finishes with a warning, not an error, and the table is empty.
Read the Adapter in a Workflow
Section titled “Read the Adapter in a Workflow”To read the adapter into a table of your own, use OneStream: Read Adapter.