Class: EventInstruction

name: EventInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_ProposedWorkflowStep","description":"Represents the proposal
      to create a business event that results in a workflow step containing an instruction,
      message details, identifiers, event timestamps, parties and accounts. The optional
      previous workflow step input provides workflow lineage to where there has been
      a correction or cancellation to the proposed step. The action is constrained
      so that when a previous workflow step is specified, the valid actions are as
      follows; New -> Correct and Correct -> Cancel. When a previous workflow is not
      specified, the action must be New.","inputs":[{"name":"messageInformation","type":"MessageInformation","cardinality":"0..1"},{"name":"timestamp","type":"EventTimestamp","cardinality":"1..*"},{"name":"eventIdentifier","type":"Identifier","cardinality":"1..*"},{"name":"party","type":"Party","cardinality":"0..*"},{"name":"account","type":"Account","cardinality":"0..*"},{"name":"previousWorkflowStep","type":"WorkflowStep","cardinality":"0..1"},{"name":"action","type":"ActionEnum","cardinality":"1..1"},{"name":"proposedEvent","type":"EventInstruction","cardinality":"1..1"},{"name":"approval","type":"WorkflowStepApproval","cardinality":"0..*"}],"output":{"name":"proposedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"}}]'
description: Specifies instructions to create a BusinessEvent.
comments:
- 'Rosetta condition: CorporateAction — if corporateActionIntent exists then intent
  = EventIntentEnum -> CorporateActionAdjustment'
- 'Rosetta func: Create_ProposedWorkflowStep — Represents the proposal to create a
  business event that results in a workflow step containing an instruction, message
  details, identifiers, event timestamps, parties and accounts. The optional previous
  workflow step input provides workflow lineage to where there has been a correction
  or cancellation to the proposed step. The action is constrained so that when a previous
  workflow step is specified, the valid actions are as follows; New -> Correct and
  Correct -> Cancel. When a previous workflow is not specified, the action must be
  New.'
in_subset:
- cdm_event_workflow
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- intent
- corporateActionIntent
- eventDate
- eventTime
- effectiveDate
- effectiveTime
- packageInformation
- instruction
slot_usage:
  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.
    range: EventIntentEnum
    required: false
  effectiveDate:
    name: effectiveDate
    description: The date on which the event contractually takes effect, when different
      from the event date.

name: EventInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_ProposedWorkflowStep","description":"Represents the proposal
      to create a business event that results in a workflow step containing an instruction,
      message details, identifiers, event timestamps, parties and accounts. The optional
      previous workflow step input provides workflow lineage to where there has been
      a correction or cancellation to the proposed step. The action is constrained
      so that when a previous workflow step is specified, the valid actions are as
      follows; New -> Correct and Correct -> Cancel. When a previous workflow is not
      specified, the action must be New.","inputs":[{"name":"messageInformation","type":"MessageInformation","cardinality":"0..1"},{"name":"timestamp","type":"EventTimestamp","cardinality":"1..*"},{"name":"eventIdentifier","type":"Identifier","cardinality":"1..*"},{"name":"party","type":"Party","cardinality":"0..*"},{"name":"account","type":"Account","cardinality":"0..*"},{"name":"previousWorkflowStep","type":"WorkflowStep","cardinality":"0..1"},{"name":"action","type":"ActionEnum","cardinality":"1..1"},{"name":"proposedEvent","type":"EventInstruction","cardinality":"1..1"},{"name":"approval","type":"WorkflowStepApproval","cardinality":"0..*"}],"output":{"name":"proposedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"}}]'
description: Specifies instructions to create a BusinessEvent.
comments:
- 'Rosetta condition: CorporateAction — if corporateActionIntent exists then intent
  = EventIntentEnum -> CorporateActionAdjustment'
- 'Rosetta func: Create_ProposedWorkflowStep — Represents the proposal to create a
  business event that results in a workflow step containing an instruction, message
  details, identifiers, event timestamps, parties and accounts. The optional previous
  workflow step input provides workflow lineage to where there has been a correction
  or cancellation to the proposed step. The action is constrained so that when a previous
  workflow step is specified, the valid actions are as follows; New -> Correct and
  Correct -> Cancel. When a previous workflow is not specified, the action must be
  New.'
in_subset:
- cdm_event_workflow
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  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.
    range: EventIntentEnum
    required: false
  effectiveDate:
    name: effectiveDate
    description: The date on which the event contractually takes effect, when different
      from the event date.
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
    rank: 1000
    owner: EventInstruction
    domain_of:
    - CounterpartyPositionBusinessEvent
    - EventInstruction
    range: EventIntentEnum
    required: false
  corporateActionIntent:
    name: corporateActionIntent
    description: The intent of a corporate action on the position.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    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
    rank: 1000
    owner: EventInstruction
    domain_of:
    - 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
    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
    close_mappings:
    - fpml_5_10:CodeValue.effectiveDate
    rank: 1000
    owner: EventInstruction
    domain_of:
    - CodeValue
    - CounterpartyPositionBusinessEvent
    - IndexTransitionInstruction
    - StockSplitInstruction
    - ClosedState
    - EventInstruction
    - LegalAgreementBase
    - MinimumTransferAmountAmendment
    - TerminationCurrencyAmendment
    - PriceQuantity
    - FallbackRateParameters
    - CalculationPeriodDates
    - EconomicTerms
    - CancelableProvision
    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
    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
    rank: 1000
    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
    rank: 1000
    owner: EventInstruction
    domain_of:
    - EventInstruction
    range: Instruction
    multivalued: true
    inlined: true
    inlined_as_list: true