OneStream

Execute Data Management sequences and steps, run Cube Views, dashboard adapters and SQL queries against OneStream applications.

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 7 actions:

Action	Purpose	Parameters
authentication/logon_and_return_cookie	Verify Web API installation and authentication. Returns an authentication message or a failure message along with an HTTP code.	No parameters
data_management/execute_sequence	Execute a Data Management Sequence consolidations, business rules, etc. and return a success/failure message.	applicationName (string) required sequenceName (string) required workspaceName (string) customSubstVarsAsCommaSeparatedPairs (string)
data_management/execute_step	Execute a Data Management Step within a group and return a success/failure message.	applicationName (string) required dataManagementGroupName (string) required stepName (string) required customSubstVarsAsCommaSeparatedPairs (string)
data_provider/get_dataset_for_adapter	Execute a Dashboard Data Adapter and return a JSON DataSet with the results.	applicationName (string) required workspaceName (string) isSystemLevel (boolean) adapterName (string) required resultDataTableName (string) required customSubstVarsAsCommaSeparatedPairs (string)
data_provider/get_dataset_for_cubeview_command	Execute a Cube View and return a JSON DataSet with the results. Optionally controls how POV columns and labels are included.	applicationName (string) required cubeViewName (string) required dataTablePerCubeViewRow (boolean) resultDataTableName (string) required cubeViewDataTableOptions (object) customSubstVarsAsCommaSeparatedPairs (string)
data_provider/get_dataset_for_sql_command	Execute a SQL query against the OneStream application or an external database referenced by the configuration. Requires Administrator role.	applicationName (string) required sqlQuery (string) required dbLocation (string) xfExternalDbConnectionName (string) resultDataTableName (string) required customSubstVarsAsCommaSeparatedPairs (string)
data_provider/get_dataset_for_method_command	Execute one of the pre-defined OneStream method commands and return its DataSet. Requires Administrator role.	applicationName (string) required command (string) required commandArgs (string) resultDataTableName (string) required customSubstVarsAsCommaSeparatedPairs (string)