Skip to content

KPI#

Bases: SsasEditableRecord

TBD.

SSAS spec: Microsoft

Source code in pbi_core/ssas/model_tables/kpi/kpi.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
@define()
class KPI(SsasEditableRecord):
    """TBD.

    SSAS spec: [Microsoft](https://learn.microsoft.com/en-us/openspecs/sql_server_protocols/ms-ssas-t/1289ceca-8113-4019-8f90-8132a91117cf)
    """

    description: str | None = field(default=None, eq=True)
    measure_id: int = field(eq=True)
    status_description: str | None = field(default=None, eq=True)
    status_expression: str = field(eq=True)
    status_graphic: str = field(eq=True)
    target_description: str | None = field(default=None, eq=True)
    target_expression: str = field(eq=True)
    target_format_string: str = field(eq=True)
    trend_description: str | None = field(default=None, eq=True)
    trend_expression: str | None = field(default=None, eq=True)

    modified_time: Final[datetime.datetime] = field(eq=False, on_setattr=setters.frozen, repr=False)

    _commands: BaseCommands = field(default=SsasCommands.kpi, init=False, repr=False, eq=False)

    def pbi_core_name(self) -> str:
        """Returns the name displayed in the PBIX report."""
        return self.measure().pbi_core_name()

    def measure(self) -> "Measure":
        return self._tabular_model.measures.find({"id": self.measure_id})

    def children_base(self) -> frozenset["LinkedEntity"]:
        return LinkedEntity.from_iter(self.annotations(), by="annotation")

    def parents_base(self) -> frozenset["LinkedEntity"]:
        return LinkedEntity.from_iter({self.measure()}, by="measure")

pbi_core_name #

pbi_core_name() -> str

Returns the name displayed in the PBIX report.

Source code in pbi_core/ssas/model_tables/kpi/kpi.py 
38
39
40
def pbi_core_name(self) -> str:
    """Returns the name displayed in the PBIX report."""
    return self.measure().pbi_core_name()