Namespace BiExcellence.OpenBi.Api.DataProviders
Classes
- AffectedDataProvider
Another dataprovider in the session that this one's state is mapped onto when it executes.
- AffectedDataProviderResult
What one affected dataprovider looks like after the execute.
- ChartDefinition
A stored chart definition.
- CreateDataProviderCommentRequest
A comment on one cell of the executed grid.
- CreateDataProviderDefinitionRequest
A dataprovider to build from a definition rather than from a source object.
- DataProviderAlertLevel
An exception (alert level) range on a key figure: the cells whose value falls in it are flagged.
- DataProviderAxisData
One member of the tuple that a grid cell or chart value sits at: one value of one dimension.
- DataProviderChartData
The executed grid, reshaped for charting.
- DataProviderChartDataOptions
How the executed grid is reshaped for charting.
- DataProviderChartDataRequest
A chart definition to render this dataprovider's values into.
- DataProviderChartLabel
One axis entry of a chart: a category or a series.
- DataProviderChartValue
One point of a chart.
- DataProviderComment
A stored data comment.
- DataProviderCondition
A condition defined on the dataprovider, which the caller can switch on and off.
- DataProviderDatabaseSchema
The tables and views a database-backed dataprovider can read.
- DataProviderDefinition
The state of a dataprovider: what it reads, how it is laid out and what it is filtered by. It is the body of
GET/POST dataproviders/{id}/definitionand ofPOST dataproviders/{id}/execute.
- DataProviderDimension
A characteristic: a column of the result that the values are grouped by.
- DataProviderDimensionAttribute
An attribute of a dimension - a second column that travels with the dimension's values.
- DataProviderDocument
A document the source system attaches to the dataprovider's context.
- DataProviderDrillState
One expanded or collapsed node of a hierarchy or of a drill down.
- DataProviderDrillStates
The values DrillState and DrillState take. They are the SAP BEx single-letter codes, which is what the engine stores.
- DataProviderElement
Anything in a definition that has an id and a display name.
- DataProviderElementCollection<T>
A list of definition elements that can also be reached by id -
definition.Dimensions["COUNTRY"]. Serializes as a plain JSON array.
- DataProviderElementExtensions
Layout helpers over the elements of a DataProviderDefinition: selecting them by axis or visibility, and moving them around while keeping the positions of the others consistent.
- DataProviderExecuteResult
The shape of the grid after an execute. The data itself is read separately.
- DataProviderExecutedEventArgs
What came out of an execute, or what went wrong.
- DataProviderF4Value
One value a dimension or a variable can be filtered on.
- DataProviderF4Values
The value help for one dimension or variable.
- DataProviderF4ValuesRequest
The value help options as a body, plus the filter context to narrow the values by. Only needed where the caller holds variable answers the dataprovider has not been executed with yet - otherwise the dataprovider's own filters narrow the values and the query-string form says everything.
- DataProviderFilter
One condition on a dimension value or a key figure: a single value, an interval or a text match.
- DataProviderGridCell
One cell of the grid.
- DataProviderGridCellContents
Reads the SAP BEx content code a grid cell carries.
- DataProviderGridData
A window of the executed grid.
- DataProviderHierarchy
A hierarchy that can be activated on a dimension.
- DataProviderKeyFigure
A number the dataprovider reads: a column of the source or a formula over them.
- DataProviderNode
One entry of the source system's catalog: a cube, a query, a folder or a stored view.
- DataProviderNodeTypes
The kinds of node Type can carry.
- DataProviderSchemaField
One column of a table or view in the source database.
- DataProviderSchemaObject
One table or view in the source database.
- DataProviderSortTuple
One value of one dimension that a key figure is sorted by.
- DataProviderUsedConnection
A connection template a dataprovider needs before its data can be read.
- DataProviderVariable
A question the source asks before it delivers data.
- DataProviderView
A dataprovider that is open in the session, together with the definition the caller is working on.
- ExecuteDataProviderRequest
The definition to execute, and what else to re-execute with it.
- GenerateChartDefinitionRequest
A chart definition to store.
- NullableDbTypeJsonConverter
Reads and writes an optional System.Data.DbType by name, the same way the required ones on the same payload are written.
JsonStringEnumConverter<DbType>converts System.Data.DbType itself and not System.Nullable<T> of it, so a property that may say "not stated" needs this one instead. Mirrors the server-side converter of the same name.
- OpenBiApiClientDataProviderExtensions
Extension methods for the
/dataprovidersand/chartdefinitionsREST APIs - the reporting engine.
- OpenDataProviderRequest
What to open on an already validated connection.
- OpenDataProviderResult
What was opened, and what still has to be validated before it delivers data.
- SaveDataProviderViewRequest
How to store the dataprovider's current state as a reusable view.
- SavedDataProviderView
A stored view, as it can be opened again.
- SetDataProviderPlanValueRequest
One planned value, written into the plan buffer.
Enums
- DataProviderAggregation
How the values of a key figure are aggregated.
- DataProviderAxis
The axis a dimension sits on.
- DataProviderCalculationTime
When a key figure formula is evaluated.
- DataProviderDimensionType
How a dimension gets its values.
- DataProviderElementType
The kind of definition element
DELETE dataproviders/{id}/elementsremoves.
- DataProviderExportFormat
The document formats the executed grid can be exported to.
- DataProviderFilterOperator
The comparison a filter makes.
- DataProviderFilterSign
Whether a filter includes or excludes what it matches.
- DataProviderGridCellContent
What a grid cell holds, read off the SAP BEx content code in Type.
- DataProviderOpenSource
What the dataprovider in the session was opened from.
- DataProviderSchemaObjectType
Whether a database schema entry is a table or a view.
- DataProviderSortMode
How a dimension or key figure is sorted.
- DataProviderSortType
What a dimension is sorted by.
- DataProviderStateEffect
Which part of this dataprovider's state is mapped over to an affected dataprovider on execute.
- DataProviderSumState
Whether a dimension shows its totals row.
- DataProviderVariableEntryType
Whether a variable has to be answered before the dataprovider can execute.
- DataProviderVariableSelection
How many values a variable accepts.
- DataProviderVariableType
What a variable asks for.