component

Module for knowledge model components.

FinalAttribute

Bases: AttributeMetadata

Class for knowledge model read only record attributes.

id class-attribute instance-attribute

id = Field(None, alias='id')

display_name class-attribute instance-attribute

display_name = Field(None, alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(None, alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(None, alias='description')

scope class-attribute instance-attribute

scope = Field(None, alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(None, alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(None, alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(None, alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(None, alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(None, alias='filterIds')

column_type class-attribute instance-attribute

column_type = Field(None, alias='columnType')

unit class-attribute instance-attribute

unit = Field(None, alias='unit')

format class-attribute instance-attribute

format = Field(None, alias='format')

type_ class-attribute instance-attribute

type_ = Field(None, alias='type')

get_column

get_column()

Returns query of attribute.

Returns:

• PQLColumn –

  PQLColumn with attribute query.

Examples:

Extract data based on PQLs from knowledge model:

from pycelonis.pql import (
    PQL,
    PQLColumn,
)

record = knowledge_model.get_content().records.find_by_id(
    "ACTIVITIES"
)
attribute = record.attributes.find_by_id(
    "ACTIVITY_EN"
)

query = (
    PQL()
    + attribute.get_column()
)

(
    data_query,
    query_environment,
) = knowledge_model.resolve_query(
    query
)
df = data_model.export_data_frame(
    data_query,
    query_environment,
)

FinalIdentifier

Bases: PqlBaseMetadata

Class for knowledge model read only record identifiers.

id class-attribute instance-attribute

id = Field(None, alias='id')

display_name class-attribute instance-attribute

display_name = Field(None, alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(None, alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(None, alias='description')

scope class-attribute instance-attribute

scope = Field(None, alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(None, alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(None, alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(None, alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(None, alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(None, alias='filterIds')

get_column

get_column()

Returns query of identifier.

Returns:

• PQLColumn –

  PQLColumn with identifier query.

Examples:

Extract data based on PQLs from knowledge model:

from pycelonis.pql import (
    PQL,
    PQLColumn,
)

record = knowledge_model.get_content().records.find_by_id(
    "ACTIVITIES"
)
identifier = record.identifier

query = (
    PQL()
    + identifier.get_column()
)

(
    data_query,
    query_environment,
) = knowledge_model.resolve_query(
    query
)
df = data_model.export_data_frame(
    data_query,
    query_environment,
)

FinalRecord

Bases: BusinessRecordMetadata

Class for knowledge model read only records.

id class-attribute instance-attribute

id = Field(None, alias='id')

display_name class-attribute instance-attribute

display_name = Field(None, alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(None, alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(None, alias='description')

scope class-attribute instance-attribute

scope = Field(None, alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(None, alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(None, alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(None, alias='autoGenerated')

augmented class-attribute instance-attribute

augmented = Field(None, alias='augmented')

pql class-attribute instance-attribute

pql = Field(None, alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(None, alias='filterIds')

new_attributes class-attribute instance-attribute

new_attributes = Field(None, alias='newAttributes')

augmented_attributes class-attribute instance-attribute

augmented_attributes = Field(
    None, alias="augmentedAttributes"
)

flags class-attribute instance-attribute

flags = Field(None, alias='flags')

priorities class-attribute instance-attribute

priorities = Field(None, alias='priorities')

data_triggers class-attribute instance-attribute

data_triggers = Field(None, alias='dataTriggers')

type_ class-attribute instance-attribute

type_ = Field(None, alias='type')

attributes instance-attribute

attributes

identifier instance-attribute

identifier

FinalFilter

Bases: FilterMetadata

Class for knowledge model read only filters.

id class-attribute instance-attribute

id = Field(None, alias='id')

display_name class-attribute instance-attribute

display_name = Field(None, alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(None, alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(None, alias='description')

scope class-attribute instance-attribute

scope = Field(None, alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(None, alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(None, alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(None, alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(None, alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(None, alias='filterIds')

global_ class-attribute instance-attribute

global_ = Field(None, alias='global')

type_ class-attribute instance-attribute

type_ = Field(None, alias='type')

get_filter

get_filter()

Returns query of filter.

Returns:

• PQLFilter –

  PQLColumn with filter query.

Examples:

Extract data based on PQLs from knowledge model:

from pycelonis.pql import (
    PQL,
    PQLColumn,
)

km_filter = knowledge_model.get_content().filters.find_by_id(
    "FILTER"
)

query = (
    PQL()
    + PQLColumn(
        name="<name>",
        query="<query>",
    )
    + km_filter.get_filter()
)

(
    data_query,
    query_environment,
) = knowledge_model.resolve_query(
    query
)
df = data_model.export_data_frame(
    data_query,
    query_environment,
)