The OneStream to Workiva integration enables organizations to automate the extraction, transformation, and delivery of data from OneStream Cloud into the Workiva platform. This integration can be implemented using either a direct API-based connection through Workiva Chains and the HTTP Connector, or a file-based SFTP workflow using the OneStream Smart Integration Connector (SIC).
Both integration methods support the ingestion of data into Workiva for downstream connected reporting processes.
API Integration
API Connection Requirements
- OneStream Cloud Environment: The API integration approach is supported only when OneStream is hosted within a publicly accessible cloud environment.
- Dedicated Service Account: For security, auditing, and operational stability, create a dedicated non-interactive service account within OneStream specifically for the integration.
- Minimum Required Permissions: Assign the service account only the permissions required to access the relevant Cube Views and associated data.
- Personal Access Token (PAT): Generate a PAT using the service account credentials and securely store the token immediately after creation, as it may not be retrievable afterward.
- Network and Firewall Access: Ensure Workiva’s static IP addresses are allow listed to permit outbound HTTPS (port 443) communication to the OneStream API endpoint.
Configure the API Integration
The API integration leverages the GetCubeView or GetAdoDataSetForCubeViewCommand endpoints to retrieve Cube View data from OneStream.
Workiva Chains can authenticate against OneStream, execute the API request, transform the returned JSON payload, and load the resulting dataset into Wdata tables for reporting and downstream processing.
Workiva Configuration Steps
-
Securely Store the PAT: Create a Workspace Variable (for example,
onestream_api_pat) within Chain Builder and mark the variable as Secret to encrypt the value and prevent unauthorized visibility. - Enable Required Connectors: Verify that the HTTP Connector, JSON Transformation Connector, and Tabular Transformation Connector are enabled and properly configured within the Workiva environment.
- Create the Destination Wdata Table: Export a sample Cube View from OneStream as a CSV file and use it as the template for the Wdata table schema. Record the Table ID for use within the Chain configuration.
- Transform and Map Data: Convert the JSON response into a tabular format if required, then map OneStream field names to the corresponding Workiva table columns and data types.
- Configure Chain Automation: Configure the Chain's trigger mechanism to control when it executes options include running on a defined schedule, on demand (manual execution), as a step within a larger orchestration workflow, or triggered by a control sheet.
Required API Parameters
| Parameter | Required | Description |
| BaseWebServerUrl | Yes | The base URL of the OneStream application server. |
| ApplicationName | Yes | The name of the OneStream application containing the Cube View. |
| CubeViewName | Yes | The Cube View used to retrieve the dataset. |
| CubeName | Yes | The associated Cube name used by the Cube View. |
SFTP Integration
In an SFTP-based integration, OneStream exports data files (typically CSV format) to an intermediate SFTP location using Smart Integration Connector. Workiva Chains then retrieves the files using the SFTP connector, processes the data, and loads it into Wdata tables.
This approach is commonly used in organizations where direct API access is unavailable or there is a preference to not create or use CubeViews.
| Customer IT / Finance Team Responsibilities | Implementation Partner Responsibilities |
|
|