Class: EventInstruction

Specifies instructions to create a BusinessEvent.

URI: common_domain_model:EventInstruction

 classDiagram
    class EventInstruction
    click EventInstruction href "../EventInstruction/"
      EventInstruction <|-- BusinessEvent
        click BusinessEvent href "../BusinessEvent/"
      
      EventInstruction : corporateActionIntent
        
          
    
        
        
        EventInstruction --> "0..1" CorporateActionTypeEnum : corporateActionIntent
        click CorporateActionTypeEnum href "../CorporateActionTypeEnum/"
    

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

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

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

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

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

        
      

Inheritance

• EventInstruction
  • BusinessEvent

Slots

Name	Cardinality and Range	Description	Inheritance
intent	0..1 EventIntentEnum	The intent attribute is meant to be specified when the event qualification ca…	direct
corporateActionIntent	0..1 CorporateActionTypeEnum		direct
eventDate	0..1 date	Specifies the date on which the event is taking place	direct
eventTime	0..1 TimeZone	The time and zone of the date in which the event is taking place	direct
effectiveDate	0..1 date	The date on which the event contractually takes effect, when different from t…	direct
effectiveTime	0..1 TimeZone	The time and zone of the date in which the event contractually takes effect	direct
packageInformation	0..1 IdentifiedList	Specifies the package information in case the business event represents sever…	direct
instruction	* Instruction	Specifies the instructions to create the Business Event	direct

Usages

used by	used in	type	used
WorkflowStep	proposedEvent	range	EventInstruction
WorkflowStep	nextEvent	range	EventInstruction

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	{'corporateActionIntent': {'value_presence': 'PRESENT'}}	{'intent': {'value_presence': 'PRESENT', 'equals_string': 'CorporateActionAdjustment'}}

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/lmodel/common-domain-model

Mappings

Mapping Type	Mapped Value
self	common_domain_model:EventInstruction
native	common_domain_model:EventInstruction

LinkML Source

Direct

name: EventInstruction
description: Specifies instructions to create a BusinessEvent.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  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
    domain_of:
    - AgreementEventInstruction
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: EventIntentEnum
  corporateActionIntent:
    name: corporateActionIntent
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    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
    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
    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
    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
    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
    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
    domain_of:
    - AgreementEventInstruction
    - EventInstruction
    range: Instruction
    multivalued: true
rules:
- preconditions:
    slot_conditions:
      corporateActionIntent:
        name: corporateActionIntent
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      intent:
        name: intent
        value_presence: PRESENT
        equals_string: CorporateActionAdjustment
  description: CorporateAction

Induced

name: EventInstruction
description: Specifies instructions to create a BusinessEvent.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  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: EventInstruction
    domain_of:
    - AgreementEventInstruction
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: EventIntentEnum
  corporateActionIntent:
    name: corporateActionIntent
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: EventInstruction
    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: EventInstruction
    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: EventInstruction
    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: EventInstruction
    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: EventInstruction
    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: EventInstruction
    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: EventInstruction
    domain_of:
    - AgreementEventInstruction
    - EventInstruction
    range: Instruction
    multivalued: true
rules:
- preconditions:
    slot_conditions:
      corporateActionIntent:
        name: corporateActionIntent
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      intent:
        name: intent
        value_presence: PRESENT
        equals_string: CorporateActionAdjustment
  description: CorporateAction