activity

Representation for BPMN 2.0 activity.

CLASS	DESCRIPTION
Activity	An Activity is a Process step that can be atomic (Tasks) or decomposable (Sub-Processes).

Classes

Activity dataclass

Activity(
    *,
    id: Optional[str] = None,
    documentation: list[Documentation] = list(),
    extension_elements: Optional[ExtensionElements] = None,
    auditing: Optional[Auditing] = None,
    monitoring: Optional[Monitoring] = None,
    category_value_refs: list[str] = list(),
    name: Optional[str] = None,
    incoming: list[str] = list(),
    outgoing: list[str] = list(),
    io_specification: Optional[IoSpecification] = None,
    properties: list[Property] = list(),
    data_input_associations: list[DataInputAssociation] = list(),
    data_output_associations: list[DataOutputAssociation] = list(),
    potential_owners: list[PotentialOwner] = list(),
    human_performers: list[HumanPerformer] = list(),
    performers: list[Performer] = list(),
    resources: list[ResourceRole] = list(),
    standard_loop_characteristics: Optional[StandardLoopCharacteristics] = None,
    multi_instance_loop_characteristics: Optional[
        MultiInstanceLoopCharacteristics
    ] = None,
    loop_characteristics: Optional[LoopCharacteristics] = None,
    is_for_compensation: bool = False,
    start_quantity: int = 1,
    completion_quantity: int = 1,
    default: Optional[str] = None
)

Bases: FlowNode

An Activity is a Process step that can be atomic (Tasks) or decomposable (Sub-Processes).

Activities are executed by either a system (automated) or humans (manual).

ATTRIBUTE	DESCRIPTION
completion_quantity	This attribute defines the number of tokens that must be generated from the Activity. TYPE: int
data_input_associations	An optional reference to the DataInputAssociations. TYPE: list[DataInputAssociation]
data_output_associations	An optional reference to the DataOutputAssociations. TYPE: list[DataOutputAssociation]
default	The Sequence Flow that receives a token when conditionExpressions on other outgoing Sequence Flows are false. TYPE: Optional[str]
human_performers	People can be assigned to Activities in various roles. TYPE: list[HumanPerformer]
io_specification	The inputs and outputs, as well as the InputSets and OutputSets, for the Activity. TYPE: Optional[IoSpecification]
is_for_compensation	A flag that identifies whether this Activity is intended for compensation. TYPE: bool
loop_characteristics	An Activity may be performed once or may be repeated. TYPE: Optional[LoopCharacteristics]
multi_instance_loop_characteristics	This defines the creation of a specified number of Activity instances. TYPE: Optional[MultiInstanceLoopCharacteristics]
performers	People can be assigned to Activities in various roles. TYPE: list[Performer]
potential_owners	Potential owners of a User Task are persons who can claim and work on it. TYPE: list[PotentialOwner]
properties	Modeler-defined properties added to an Activity. TYPE: list[Property]
resources	Defines the resource that will perform or will be responsible for the Activity. TYPE: list[ResourceRole]
standard_loop_characteristics	This defines looping behavior based on a boolean condition. TYPE: Optional[StandardLoopCharacteristics]
start_quantity	This attribute defines the number of tokens that must arrive before the Activity can begin. TYPE: int

Attributes

completion_quantity class-attribute instance-attribute

completion_quantity: int = field(
    default=1, metadata={"name": "completionQuantity", "type": "Attribute"}
)

This attribute defines the number of tokens that must be generated from the Activity.

The default value is 1. The value MUST NOT be less than 1. This number of tokens will be sent down any outgoing Sequence Flow, assuming it’s conditions are satisfied. Note that any value greater than 1 is an advanced type of modeling and should be used with caution.

data_input_associations class-attribute instance-attribute

data_input_associations: list[DataInputAssociation] = field(
    default_factory=list,
    metadata={
        "name": "dataInputAssociation",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

An optional reference to the DataInputAssociations.

A DataInputAssociation defines how the DataInput of the Activity’s InputOutputSpecification is populated.

data_output_associations class-attribute instance-attribute

data_output_associations: list[DataOutputAssociation] = field(
    default_factory=list,
    metadata={
        "name": "dataOutputAssociation",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

An optional reference to the DataOutputAssociations.

default class-attribute instance-attribute

default: Optional[str] = field(
    default=None, metadata={"type": "Attribute", "is_reference": True}
)

The Sequence Flow that receives a token when conditionExpressions on other outgoing Sequence Flows are false.

The default Sequence Flow should not have a conditionExpression. Any such Expression is ignored.

human_performers class-attribute instance-attribute

human_performers: list[HumanPerformer] = field(
    default_factory=list,
    metadata={
        "name": "humanPerformer",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

People can be assigned to Activities in various roles.

io_specification class-attribute instance-attribute

io_specification: Optional[IoSpecification] = field(
    default=None,
    metadata={
        "name": "ioSpecification",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

The inputs and outputs, as well as the InputSets and OutputSets, for the Activity.

is_for_compensation class-attribute instance-attribute

is_for_compensation: bool = field(
    default=False, metadata={"name": "isForCompensation", "type": "Attribute"}
)

A flag that identifies whether this Activity is intended for compensation.

If false, then this Activity executes as a result of normal execution flow. If true, this Activity is only activated when a Compensation Event is detected and initiated under Compensation Event visibility scope.

loop_characteristics class-attribute instance-attribute

loop_characteristics: Optional[LoopCharacteristics] = field(
    default=None,
    metadata={
        "name": "loopCharacteristics",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

An Activity may be performed once or may be repeated.

If repeated, the Activity must have loopCharacteristics that define the repetition criteria (if the isExecutable attribute of the Process is set to true).

multi_instance_loop_characteristics class-attribute instance-attribute

multi_instance_loop_characteristics: Optional[
    MultiInstanceLoopCharacteristics
] = field(
    default=None,
    metadata={
        "name": "multiInstanceLoopCharacteristics",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

This defines the creation of a specified number of Activity instances.

The instances MAY execute in parallel or MAY be sequential.

performers class-attribute instance-attribute

performers: list[Performer] = field(
    default_factory=list,
    metadata={
        "name": "performer",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

People can be assigned to Activities in various roles.

potential_owners class-attribute instance-attribute

potential_owners: list[PotentialOwner] = field(
    default_factory=list,
    metadata={
        "name": "potentialOwner",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

Potential owners of a User Task are persons who can claim and work on it.

properties class-attribute instance-attribute

properties: list[Property] = field(
    default_factory=list,
    metadata={
        "name": "property",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

Modeler-defined properties added to an Activity.

resources class-attribute instance-attribute

resources: list[ResourceRole] = field(
    default_factory=list,
    metadata={
        "name": "resourceRole",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

Defines the resource that will perform or will be responsible for the Activity.

The resource, e.g., a performer, can be specified in the form of a specific individual, a group, an organization role or position, or an organization.

standard_loop_characteristics class-attribute instance-attribute

standard_loop_characteristics: Optional[StandardLoopCharacteristics] = field(
    default=None,
    metadata={
        "name": "standardLoopCharacteristics",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

This defines looping behavior based on a boolean condition.

The Activity will loop as long as the boolean condition is true. The condition is evaluated for every loop iteration, and may be evaluated at the beginning or at the end of the iteration.

start_quantity class-attribute instance-attribute

start_quantity: int = field(
    default=1, metadata={"name": "startQuantity", "type": "Attribute"}
)

This attribute defines the number of tokens that must arrive before the Activity can begin.

The default value is 1. The value must not be less than 1. Note that any value greater than 1 is an advanced type of modeling and should be used with caution.

Functions