Fast Data Extract BRApis

Fast Data Extract (FDX) BRApis enable you to extract data from a variety of sources. These BRApis can be written directly in a connector business rule, or the connector business rule can call a Workspace Assembly rule that contains the FDX BRApis. The connector rule is then referenced by the data source and used to import data into BI Blend. FDX BRApis can be combined with SQL scripts and filters to extract only the data needed.

There are different FDX BRApis available depending on the source you want to extract data from:

• OneStream Application: FDX BRApis can extract data from different places in your OneStream application.

  • Cube Views: Extract data through a Cube View definition. This is ideal for defining data definitions through a Cube View, including Dynamic Calc results.

  • Data Unit Members: Extract cube data to a BI Blend target table through defined Data Unit filters.

  • Stage Workflow Imports: The ability to leverage existing Stage data. Uses include reporting on existing attribute records contained in Stage or simply enhanced dashboard reporting on Stage data.

• Warehouse Data Source: FDX BRApis can extract data from internal or external warehouse data.

  • Internal: This refers to tables within your application database.

    Example: You can extract all or a subset of data from Solution Exchange solution tables and import them into BI Blend. Derivative rules can be used to further transform or perform calculations on data during the import.

  • External: This refers to external databases that are available to you.

    Example: You can use FDX APIs to extract a subset of data from your BI Blend tables and import them into BI Blend. As with internal tables, derivative rules can be used to transform and perform calculations on the data during import.

FDX Use and Benefits

Key differentiators between FDX BRApis and other collection methods are the support of parallel processing, in-memory processing, and management of the Time dimension.

Performance is enhanced because the BRApi is able to parallel process. For example, extracting data by cube Data Unit will parallel process all the Data Units defined in the filter. The FDX BRApis do not generate a .csv file as data management Export Data or Export File processes do. The results of the export are managed during the BI Blend in-memory processing.

In cases of very large datasets, where multiple periods are loaded, the processing time can be slow because each period is reflected as a data record. FDX BRApis offer solutions to pivot the Time records to columns to create a matrix data layout. See Time Pivot. The data source can associate each of the periods with an Attribute Value or xBlend Attribute Value dimension within the Integration settings. The design will treat each record as a collection of 36 periods when processing.

Review the following examples of how FDX BRApis can be used to move data:

• Can be used to extract OneStream data and metadata so that it can be used in external systems

• Can be used to pull data from Solution Exchange for use in dashboard reports

• Can be used to export dynamically calculated results from Cube Views

• Can be used to extract data from external systems into OneStream

• Can be used to pull transient data from external sources at a more frequent interval than monthly or weekly

• Can be used to create additional data points for use with SensibleAI Forecast

FDX BRApis

The FDX API functions are used within a Connection Action in a connector business rule or Workspace Assembly File. They are split into separate groups: Return and Extract.

Return

These API functions are used to return field column names to the Data Source Connector Fields.

The Connector Action Type GetFieldList returns the field column names to the Data Source Connector Fields using FDX APIs from the following data sources:

Data Source	FDX API
Cube View	FdxGetCubeViewOrDataUnitColumnList
Data Unit
Stage	FdxGetStageTargetColumnList
Warehouse	FdxGetWarehouseColumnList

Extract

These API functions are used to extract data using Fast Data Extract.

The Connector Action Type GetData runs these FDX APIs to extract data so that it can be imported. Data can be extracted from the following data sources:

Data Sources	FDX API	Description
Cube View	FdxExecuteCubeView	Extracts data defined through a Cube View. Any data presented in the Cube View is extracted, such as Dynamic Calculated results.
	FdxExecuteCubeViewTimePivot	Cube View data generates all Time as columns, which can be assigned as Attribute Value members in the Data Source.
Data Unit	FdXExecuteDataUnit	A cube data extract solution to extract data from Data Unit members.
	FdXExecuteDataUnitTimePivot	A cube data extract solution to extract data from Data Unit members. It generates all Time as columns, which can be assigned as Attribute Value members in the Data Source.
Stage	FdxExecuteStageTargetTimePivot	To extract existing workflow Stage data. It is extracting data from your Stage Target columns. It generates all Time as columns, which can be assigned as Attribute Value members in the Data Source.
Warehouse	FdXExecuteWarehouseTimePivot	To extract data from an external source system.

NOTE: You may need to use a Parser Rule to ensure your timestamp data conforms to the format required by Blend: MM/dd/yyyy hh:mm:ss