cmem_client.models.rule_block¤
Corporate Memory rule block models for data integration.
A rule block is a reusable transformation unit: a named operator tree with
declared input ports, referenced from transform and linking rules instead of
being copied into them. Rule blocks are project-scoped task items of type
RuleBlock and are available from Corporate Memory 26.2 onwards.
The whole body of a rule block is a single opaque object parameter named
ruleBlockModel. Only its ports are modelled explicitly here, because they
are the part callers typically read and report; the operator tree, the input
examples and the editor layout are passed through untouched.
Classes:
- RuleBlock – A rule block description (Build).
- RuleBlockData – The data section of a rule block task.
- RuleBlockMetadata – Metadata of a rule block.
- RuleBlockModel – The complete rule block model: ports, operator tree, examples and layout.
- RuleBlockPort – A declared input port of a rule block.
- RuleBlockSearchResultSet – A rule block search result set.
RuleBlock¤
Bases: ReadRepositoryItem
A rule block description (Build).
Functions:
- get_id – Get the combined ID of the rule block.
Attributes:
- data (
RuleBlockData) – - id (
str) – - item_links (
list[ItemLink]) – - metadata (
RuleBlockMetadata) – - model_config –
- project_id (
str) – - tags (
list[Tag]) –
data¤
get_id¤
Get the combined ID of the rule block.
id¤
item_links¤
metadata¤
model_config¤
project_id¤
tags¤
RuleBlockData¤
Bases: Model
The data section of a rule block task.
Attributes:
- model_config –
- rule_block_model (
RuleBlockModel) – - task_type (
str) – - type (
str) –
model_config¤
rule_block_model¤
task_type¤
type¤
RuleBlockMetadata¤
Bases: TypedDict
Metadata of a rule block.
Attributes:
- created (
str) – - createdByUser (
str) – - description (
str) – - label (
str) – - lastModifiedByUser (
str) – - modified (
str) –
created¤
createdByUser¤
description¤
label¤
lastModifiedByUser¤
modified¤
RuleBlockModel¤
Bases: Model
The complete rule block model: ports, operator tree, examples and layout.
The defaults are those of an empty rule block as DataIntegration creates it;
it rejects a model whose layout lacks nodePositions.
Attributes:
- input_examples (
list[Any]) – - layout (
dict[str, Any]) – - model_config –
- operator_tree (
Any) – - ports (
list[RuleBlockPort]) – - ui_annotations (
dict[str, Any]) –
input_examples¤
layout¤
model_config¤
operator_tree¤
ports¤
ui_annotations¤
ui_annotations: dict[str, Any] = Field(alias='uiAnnotations', default_factory=lambda: {'stickyNotes': []})
RuleBlockPort¤
Bases: Model
A declared input port of a rule block.
Attributes:
- deprecated (
bool) – - description (
str) – - display_order (
int) – - id (
str) – - label (
str) – - model_config –
deprecated¤
description¤
display_order¤
id¤
label¤
model_config¤
RuleBlockSearchResultSet¤
Bases: Model
A rule block search result set.
Attributes:
- model_config –
- results (
list[RuleBlock]) –