Skip to content
common-domain-model

Class: BusinessEvent

A business event represents a life cycle event of a trade. The combination of the state changes results in a qualifiable life cycle event. An example of a Business Event is a PartialTermination which is a defined by a quantity change primitive event.

URI: common_domain_model:BusinessEvent

 classDiagram
    class BusinessEvent
    click BusinessEvent href "../BusinessEvent/"
      EventInstruction <|-- BusinessEvent
        click EventInstruction href "../EventInstruction/"
      
      BusinessEvent : after
        
          
    
        
        
        BusinessEvent --> "*" TradeState : after
        click TradeState href "../TradeState/"
    

        
      BusinessEvent : corporateActionIntent
        
          
    
        
        
        BusinessEvent --> "0..1" CorporateActionTypeEnum : corporateActionIntent
        click CorporateActionTypeEnum href "../CorporateActionTypeEnum/"
    

        
      BusinessEvent : effectiveDate
        
      BusinessEvent : effectiveTime
        
          
    
        
        
        BusinessEvent --> "0..1" TimeZone : effectiveTime
        click TimeZone href "../TimeZone/"
    

        
      BusinessEvent : eventDate
        
      BusinessEvent : eventQualifier
        
      BusinessEvent : eventTime
        
          
    
        
        
        BusinessEvent --> "0..1" TimeZone : eventTime
        click TimeZone href "../TimeZone/"
    

        
      BusinessEvent : instruction
        
          
    
        
        
        BusinessEvent --> "*" Instruction : instruction
        click Instruction href "../Instruction/"
    

        
      BusinessEvent : intent
        
          
    
        
        
        BusinessEvent --> "0..1" EventIntentEnum : intent
        click EventIntentEnum href "../EventIntentEnum/"
    

        
      BusinessEvent : packageInformation
        
          
    
        
        
        BusinessEvent --> "0..1" IdentifiedList : packageInformation
        click IdentifiedList href "../IdentifiedList/"

Inheritance

Section titled “Inheritance”

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
eventQualifier 0..1
string		 The CDM event qualifier, which corresponds to the outcome of the isEvent qual… direct
after *
TradeState		 Specifies the after trade state(s) created direct
intent 0..1
EventIntentEnum		 The intent attribute is meant to be specified when the event qualification ca… EventInstruction
corporateActionIntent 0..1
CorporateActionTypeEnum		 EventInstruction
eventDate 0..1
date		 Specifies the date on which the event is taking place EventInstruction
eventTime 0..1
TimeZone		 The time and zone of the date in which the event is taking place EventInstruction
effectiveDate 0..1
date		 The date on which the event contractually takes effect, when different from t… EventInstruction
effectiveTime 0..1
TimeZone		 The time and zone of the date in which the event contractually takes effect EventInstruction
packageInformation 0..1
IdentifiedList		 Specifies the package information in case the business event represents sever… EventInstruction
instruction *
Instruction		 Specifies the instructions to create the Business Event EventInstruction
Expressions & Logic

All Of

Section titled “All Of”

The class must satisfy all of:

  • AnonymousClassExpression({ ‘description’: ‘EventDate’, ‘slot_conditions’: {‘eventDate’: SlotDefinition({‘name’: ‘eventDate’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })

Usages

Section titled “Usages”
used by used in type used
WorkflowStep businessEvent range BusinessEvent

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Annotations

Section titled “Annotations”
property value
rosetta_root_type true
rosetta_metadata key

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:BusinessEvent
native common_domain_model:BusinessEvent

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: BusinessEvent
annotations:
  rosetta_root_type:
    tag: rosetta_root_type
    value: 'true'
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A business event represents a life cycle event of a trade. The combination
  of the state changes results in a qualifiable life cycle event. An example of a
  Business Event is a PartialTermination which is a defined by a quantity change primitive
  event.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: EventInstruction
attributes:
  eventQualifier:
    name: eventQualifier
    description: The CDM event qualifier, which corresponds to the outcome of the
      isEvent qualification logic which qualifies the lifecycle event as a function
      of its features (e.g. PartialTermination, ClearingSubmission, Novation, ...).
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    domain_of:
    - AgreementEvent
    - BusinessEvent
    range: string
  after:
    name: after
    description: Specifies the after trade state(s) created.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    domain_of:
    - AgreementEvent
    - BusinessEvent
    - CounterpartyPositionBusinessEvent
    range: TradeState
    multivalued: true
all_of:
- description: EventDate
  slot_conditions:
    eventDate:
      name: eventDate
      value_presence: PRESENT

Induced

Section titled “Induced”
name: BusinessEvent
annotations:
  rosetta_root_type:
    tag: rosetta_root_type
    value: 'true'
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A business event represents a life cycle event of a trade. The combination
  of the state changes results in a qualifiable life cycle event. An example of a
  Business Event is a PartialTermination which is a defined by a quantity change primitive
  event.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: EventInstruction
attributes:
  eventQualifier:
    name: eventQualifier
    description: The CDM event qualifier, which corresponds to the outcome of the
      isEvent qualification logic which qualifies the lifecycle event as a function
      of its features (e.g. PartialTermination, ClearingSubmission, Novation, ...).
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: BusinessEvent
    domain_of:
    - AgreementEvent
    - BusinessEvent
    range: string
  after:
    name: after
    description: Specifies the after trade state(s) created.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: BusinessEvent
    domain_of:
    - AgreementEvent
    - BusinessEvent
    - CounterpartyPositionBusinessEvent
    range: TradeState
    multivalued: true
  intent:
    name: intent
    description: The intent attribute is meant to be specified when the event qualification
      cannot be programmatically inferred from the event features. As a result it
      is only associated with those primitives that can give way to such ambiguity,
      the quantityChange being one of those. An example of such is a reduction in
      the trade notional, which could be interpreted as either a trade correction
      (unless a maximum period of time post-event is specified as part of the qualification),
      a partial termination or a portfolio rebalancing in the case of an equity swap.
      On the other hand, an event such as the exercise is not expected to have an
      associated intent as there should not be ambiguity.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: BusinessEvent
    domain_of:
    - AgreementEventInstruction
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: EventIntentEnum
  corporateActionIntent:
    name: corporateActionIntent
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: BusinessEvent
    domain_of:
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: CorporateActionTypeEnum
  eventDate:
    name: eventDate
    description: Specifies the date on which the event is taking place. This date
      is equal to the trade date in the case of a simple execution. However it can
      be different from the trade date, for example in the case of a partial termination.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: BusinessEvent
    domain_of:
    - AgreementEventInstruction
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: date
  eventTime:
    name: eventTime
    description: The time and zone of the date in which the event is taking place.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - EventInstruction
    range: TimeZone
  effectiveDate:
    name: effectiveDate
    description: The date on which the event contractually takes effect, when different
      from the event date.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: BusinessEvent
    domain_of:
    - CodeValue
    - AgreementEventInstruction
    - ClosedState
    - CounterpartyPositionBusinessEvent
    - IndexTransitionInstruction
    - StockSplitInstruction
    - PriceQuantity
    - FallbackRateParameters
    - CalculationPeriodDates
    - LegalAgreementBase
    - EventInstruction
    - MinimumTransferAmountAmendment
    - TerminationCurrencyAmendment
    - CancelableProvision
    - EconomicTerms
    range: date
  effectiveTime:
    name: effectiveTime
    description: The time and zone of the date in which the event contractually takes
      effect.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: BusinessEvent
    domain_of:
    - EventInstruction
    - EconomicTerms
    range: TimeZone
  packageInformation:
    name: packageInformation
    description: Specifies the package information in case the business event represents
      several trades executed as a package (hence this attribute is optional). The
      package information is only instantiated once at the business event level to
      preserve referential integrity, whereas individual trades make reference to
      it to identify that they are part of a package.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: BusinessEvent
    domain_of:
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: IdentifiedList
  instruction:
    name: instruction
    description: Specifies the instructions to create the Business Event.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: BusinessEvent
    domain_of:
    - AgreementEventInstruction
    - EventInstruction
    range: Instruction
    multivalued: true
all_of:
- description: EventDate
  slot_conditions:
    eventDate:
      name: eventDate
      value_presence: PRESENT