settings

ViewComponentDataSourceAttribute

Bases: PyCelonisBaseModel

Class for view component data source attribute.

id instance-attribute

id

Id of attribute.

pql instance-attribute

pql

PQL of attribute.

column_type class-attribute instance-attribute

column_type = None

Type of column (e.g. dimension, measure).

description class-attribute instance-attribute

description = None

Description of attribute.

display_name class-attribute instance-attribute

display_name = None

Display name of attribute.

name

name(i=0)

Returns name of data source attribute.

ViewComponentDataSourceFilter

Bases: PyCelonisBaseModel

Class for view component data source filter.

pql instance-attribute

pql

PQL of filter.

is_referenced class-attribute instance-attribute

is_referenced = Field(default=False)

Whether filter is reference from knowledge model.

to_pql

to_pql()

Returns PQL filter. For filters referenced from knowledge model, syntax is adjusted.

ViewComponentDataSource

Bases: PyCelonisBaseModel

Class for view component data source.

id instance-attribute

id

Id of data source.

description class-attribute instance-attribute

description = None

Description of data source.

display_name class-attribute instance-attribute

display_name = None

Display name of data source.

attributes class-attribute instance-attribute

attributes = Field(default_factory=list)

Attributes of data source, e.g. dimensions and kpis.

filters class-attribute instance-attribute

filters = Field(default_factory=list)

Filters of data source, e.g. filter attributes.

ViewComponentColumn

Bases: PyCelonisBaseModel

Class for view component data column.

id instance-attribute

id

order instance-attribute

order

ViewComponentDataColumn

Bases: ViewComponentColumn

Class for view component data column.

id instance-attribute

id

order instance-attribute

order

field instance-attribute

field

ViewComponentSortByDataColumn

Bases: ViewComponentDataColumn

Class for view component data column.

id instance-attribute

id

order instance-attribute

order

field instance-attribute

field

direction class-attribute instance-attribute

direction = Field(default='ASC')

ViewComponentKpiDataColumn

Bases: ViewComponentColumn

Class for view component data column.

id instance-attribute

id

order instance-attribute

order

kpi instance-attribute

kpi

ViewComponentData

Bases: PyCelonisBaseModel

Class for view component data.

sort_by class-attribute instance-attribute

sort_by = Field(default_factory=list)

ComponentSettings

Bases: PyCelonisBaseModel

Class for view component settings.

data class-attribute instance-attribute

data = Field(default_factory=ViewComponentData)

data_sources class-attribute instance-attribute

data_sources = Field(default_factory=list)