Skip to content
common-domain-model

Class: WorkflowStep

A workflow step represents the state of a business event. The workflow step contains a reference to a previous WorkflowStep in order to preserve lineage. A workflow step is accepted if it contains a business event, proposed if proposedEvent is present and is rejected if the rejected flag is set.

URI: common_domain_model:WorkflowStep

 classDiagram
    class WorkflowStep
    click WorkflowStep href "../WorkflowStep/"
      WorkflowStep : account
        
          
    
        
        
        WorkflowStep --> "*" Account : account
        click Account href "../Account/"
    

        
      WorkflowStep : action
        
          
    
        
        
        WorkflowStep --> "0..1" ActionEnum : action
        click ActionEnum href "../ActionEnum/"
    

        
      WorkflowStep : approval
        
          
    
        
        
        WorkflowStep --> "*" WorkflowStepApproval : approval
        click WorkflowStepApproval href "../WorkflowStepApproval/"
    

        
      WorkflowStep : businessEvent
        
          
    
        
        
        WorkflowStep --> "0..1" BusinessEvent : businessEvent
        click BusinessEvent href "../BusinessEvent/"
    

        
      WorkflowStep : counterpartyPositionBusinessEvent
        
          
    
        
        
        WorkflowStep --> "0..1" CounterpartyPositionBusinessEvent : counterpartyPositionBusinessEvent
        click CounterpartyPositionBusinessEvent href "../CounterpartyPositionBusinessEvent/"
    

        
      WorkflowStep : creditLimitInformation
        
          
    
        
        
        WorkflowStep --> "0..1" CreditLimitInformation : creditLimitInformation
        click CreditLimitInformation href "../CreditLimitInformation/"
    

        
      WorkflowStep : eventIdentifier
        
          
    
        
        
        WorkflowStep --> "1..*" Identifier : eventIdentifier
        click Identifier href "../Identifier/"
    

        
      WorkflowStep : messageInformation
        
          
    
        
        
        WorkflowStep --> "0..1" MessageInformation : messageInformation
        click MessageInformation href "../MessageInformation/"
    

        
      WorkflowStep : nextEvent
        
          
    
        
        
        WorkflowStep --> "0..1" EventInstruction : nextEvent
        click EventInstruction href "../EventInstruction/"
    

        
      WorkflowStep : party
        
          
    
        
        
        WorkflowStep --> "*" Party : party
        click Party href "../Party/"
    

        
      WorkflowStep : previousWorkflowStep
        
          
    
        
        
        WorkflowStep --> "0..1" WorkflowStep : previousWorkflowStep
        click WorkflowStep href "../WorkflowStep/"
    

        
      WorkflowStep : proposedEvent
        
          
    
        
        
        WorkflowStep --> "0..1" EventInstruction : proposedEvent
        click EventInstruction href "../EventInstruction/"
    

        
      WorkflowStep : rejected
        
      WorkflowStep : timestamp
        
          
    
        
        
        WorkflowStep --> "1..*" EventTimestamp : timestamp
        click EventTimestamp href "../EventTimestamp/"
    

        
      WorkflowStep : workflowState
        
          
    
        
        
        WorkflowStep --> "0..1" WorkflowState : workflowState
        click WorkflowState href "../WorkflowState/"

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
timestamp 1..*
EventTimestamp		 The set of timestamp(s) associated with the event as a collection of [dateTim… direct
businessEvent 0..1
BusinessEvent		 Life cycle event for the step direct
counterpartyPositionBusinessEvent 0..1
CounterpartyPositionBusinessEvent		 Documents the life cycle event for a position direct
proposedEvent 0..1
EventInstruction		 The proposed event for a workflow step direct
rejected 0..1
Boolean		 Flags this step as rejected direct
approval *
WorkflowStepApproval		 Optional party approvals for the current workflow step direct
previousWorkflowStep 0..1
WorkflowStep		 Optional previous workflow step that provides lineage to workflow steps that … direct
nextEvent 0..1
EventInstruction		 The intended next event can be specified, even if the instructions are not kn… direct
messageInformation 0..1
MessageInformation		 Contains all information pertaining the FpML messaging header direct
eventIdentifier 1..*
Identifier		 The identifier(s) that uniquely identify a lifecycle event direct
action 0..1
ActionEnum		 Specifies whether the event is a new, a correction or a cancellation direct
party *
Party		 The specification of the event parties direct
account *
Account		 Optional account information that could be associated to the event direct
creditLimitInformation 0..1
CreditLimitInformation		 direct
workflowState 0..1
WorkflowState		 The event workflow information, i direct
Expressions & Logic

All Of

Section titled “All Of”

The class must satisfy all of:

  • AnonymousClassExpression({ ‘description’: (’CounterpartyPositionBusinessEventOrBusinessEventOrProposedEventChoice: ’ ’Choice rule to control that either positionBusinessEvent is present, ’ ’businessEvent is present or proposedEvent is present, but not more than one ’ ‘at the same time.’), ‘exactly_one_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘counterpartyPositionBusinessEvent’: SlotDefinition({ ‘name’: ‘counterpartyPositionBusinessEvent’, ‘value_presence’: PresenceEnum(text=‘PRESENT’) })} }), AnonymousClassExpression({ ‘slot_conditions’: {‘businessEvent’: SlotDefinition({‘name’: ‘businessEvent’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘proposedEvent’: SlotDefinition({‘name’: ‘proposedEvent’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })] })

Usages

Section titled “Usages”
used by used in type used
Lineage eventReference range WorkflowStep
Workflow steps range WorkflowStep
WorkflowStep previousWorkflowStep range WorkflowStep

Comments

Section titled “Comments”
  • Rosetta condition WorkflowStepStatus is not stated in LinkML: (businessEvent exists and nextEvent -> instruction is absent and rejected is absent) or (nextEvent -> instruction exists and businessEvent is absent and rejected is absent) or (rejected exists and businessEvent is absent and nextEvent is absent) or (proposedEvent exists and nextEvent is absent and rejected is absent) or (previousWorkflowStep exists and action = ActionEnum -> Cancel)

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:WorkflowStep
native common_domain_model:WorkflowStep

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: WorkflowStep
annotations:
  rosetta_root_type:
    tag: rosetta_root_type
    value: 'true'
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A workflow step represents the state of a business event. The workflow
  step contains a reference to a previous WorkflowStep in order to preserve lineage.
  A workflow step is accepted if it contains a business event, proposed if proposedEvent
  is present and is rejected if the rejected flag is set.
comments:
- 'Rosetta condition WorkflowStepStatus is not stated in LinkML: (businessEvent exists
  and nextEvent -> instruction is absent and rejected is absent) or (nextEvent ->
  instruction exists and businessEvent is absent and rejected is absent) or (rejected
  exists and businessEvent is absent and nextEvent is absent) or (proposedEvent exists
  and nextEvent is absent and rejected is absent) or (previousWorkflowStep exists
  and action = ActionEnum -> Cancel)'
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- timestamp
slot_usage:
  timestamp:
    name: timestamp
    description: The set of timestamp(s) associated with the event as a collection
      of [dateTime, qualifier].
    range: EventTimestamp
    required: true
    multivalued: true
attributes:
  businessEvent:
    name: businessEvent
    description: Life cycle event for the step.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: BusinessEvent
  counterpartyPositionBusinessEvent:
    name: counterpartyPositionBusinessEvent
    description: Documents the life cycle event for a position.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: CounterpartyPositionBusinessEvent
  proposedEvent:
    name: proposedEvent
    description: The proposed event for a workflow step.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: EventInstruction
  rejected:
    name: rejected
    description: Flags this step as rejected.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: boolean
  approval:
    name: approval
    description: Optional party approvals for the current workflow step. A workflow
      step can have any number of parties associated to it, thus this object is represented
      as a list. All parties that are expected to provide approval should have an
      item in this list that references them.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: WorkflowStepApproval
    multivalued: true
  previousWorkflowStep:
    name: previousWorkflowStep
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: Optional previous workflow step that provides lineage to workflow
      steps that precedes it.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: WorkflowStep
  nextEvent:
    name: nextEvent
    description: The intended next event can be specified, even if the instructions
      are not known yet.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: EventInstruction
  messageInformation:
    name: messageInformation
    description: Contains all information pertaining the FpML messaging header
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    domain_of:
    - AvailableInventory
    - WorkflowStep
    range: MessageInformation
  eventIdentifier:
    name: eventIdentifier
    description: The identifier(s) that uniquely identify a lifecycle event. The unbounded
      cardinality is meant to provide the ability to associate identifiers that are
      issued by distinct parties. As an example, each of the parties to the event
      may choose to associate their own identifiers to the event.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: Identifier
    required: true
    multivalued: true
  action:
    name: action
    description: Specifies whether the event is a new, a correction or a cancellation.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: ActionEnum
  party:
    name: party
    description: The specification of the event parties. This attribute is optional,
      as not applicable to certain events (e.g. most of the observations).
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    domain_of:
    - AssetBase
    - DebtRedemption
    - MarginCallBase
    - Trade
    - UmbrellaAgreementParty
    - UmbrellaAgreementSet
    - AggregationParameters
    - AvailableInventory
    - CounterpartyPosition
    - WorkflowStep
    - WorkflowStepApproval
    - AdditionalObligations
    - AdditionalRepresentationElection
    - CalculationAgentTerms
    - CalculationCurrencyElection
    - CollateralManagementAgreementElection
    - ControlAgreementElections
    - ControlAgreementNecEventElection
    - CreditSupportDocumentElection
    - CreditSupportProviderElection
    - CustodianElection
    - CustodianRiskElection
    - ElectiveAmountElection
    - FrenchLawAddendumElection
    - HoldingAndUsingPostedCollateralElection
    - LegacyExposureScopeElection
    - LegacyIndependentAmountParty
    - MinimumTransferAmountElection
    - NotificationTimeElection
    - PledgeeRepresentativeRider
    - PostingObligationsElection
    - RecalculationOfValueElection
    - RegimeTerms
    - SecuredPartyRightsEventElection
    - SecurityInterestForObligations
    - SecurityProviderRightsEventElection
    - SensitivityMethodologiesPartyElection
    - SinglePostingParty
    - SpecifiedOrAccessConditionPartyElection
    - SubstitutedRegimeElection
    - SubstitutionPartyElection
    - TerminationCurrencyElection
    - ThresholdElection
    - ValuationAgent
    - ValuationCalculationDateLocationElection
    - AdditionalTerminationEventElection
    - AutomaticEarlyTerminationElection
    - CreditEventUponMergerElection
    - PartyTerminationCurrencySelection
    - SpecifiedEntity
    - EventsOfDefaultElection
    - EligibleCollateralSpecification
    range: Party
    multivalued: true
  account:
    name: account
    description: Optional account information that could be associated to the event.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    domain_of:
    - Party
    - TransferContactInformation
    - WorkflowStep
    range: Account
    multivalued: true
  creditLimitInformation:
    name: creditLimitInformation
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: CreditLimitInformation
  workflowState:
    name: workflowState
    description: The event workflow information, i.e. the workflow status, the associated
      comment and the partyCustomisedWorkflow which purpose is to provide the ability
      to associate custom workflow information to the CDM.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    domain_of:
    - WorkflowStep
    range: WorkflowState
all_of:
- description: 'CounterpartyPositionBusinessEventOrBusinessEventOrProposedEventChoice:
    Choice rule to control that either positionBusinessEvent is present, businessEvent
    is present or proposedEvent is present, but not more than one at the same time.'
  exactly_one_of:
  - slot_conditions:
      counterpartyPositionBusinessEvent:
        name: counterpartyPositionBusinessEvent
        value_presence: PRESENT
  - slot_conditions:
      businessEvent:
        name: businessEvent
        value_presence: PRESENT
  - slot_conditions:
      proposedEvent:
        name: proposedEvent
        value_presence: PRESENT

Induced

Section titled “Induced”
name: WorkflowStep
annotations:
  rosetta_root_type:
    tag: rosetta_root_type
    value: 'true'
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A workflow step represents the state of a business event. The workflow
  step contains a reference to a previous WorkflowStep in order to preserve lineage.
  A workflow step is accepted if it contains a business event, proposed if proposedEvent
  is present and is rejected if the rejected flag is set.
comments:
- 'Rosetta condition WorkflowStepStatus is not stated in LinkML: (businessEvent exists
  and nextEvent -> instruction is absent and rejected is absent) or (nextEvent ->
  instruction exists and businessEvent is absent and rejected is absent) or (rejected
  exists and businessEvent is absent and nextEvent is absent) or (proposedEvent exists
  and nextEvent is absent and rejected is absent) or (previousWorkflowStep exists
  and action = ActionEnum -> Cancel)'
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  timestamp:
    name: timestamp
    description: The set of timestamp(s) associated with the event as a collection
      of [dateTime, qualifier].
    range: EventTimestamp
    required: true
    multivalued: true
attributes:
  businessEvent:
    name: businessEvent
    description: Life cycle event for the step.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: BusinessEvent
  counterpartyPositionBusinessEvent:
    name: counterpartyPositionBusinessEvent
    description: Documents the life cycle event for a position.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: CounterpartyPositionBusinessEvent
  proposedEvent:
    name: proposedEvent
    description: The proposed event for a workflow step.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: EventInstruction
  rejected:
    name: rejected
    description: Flags this step as rejected.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: boolean
  approval:
    name: approval
    description: Optional party approvals for the current workflow step. A workflow
      step can have any number of parties associated to it, thus this object is represented
      as a list. All parties that are expected to provide approval should have an
      item in this list that references them.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: WorkflowStepApproval
    multivalued: true
  previousWorkflowStep:
    name: previousWorkflowStep
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: Optional previous workflow step that provides lineage to workflow
      steps that precedes it.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: WorkflowStep
  nextEvent:
    name: nextEvent
    description: The intended next event can be specified, even if the instructions
      are not known yet.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: EventInstruction
  messageInformation:
    name: messageInformation
    description: Contains all information pertaining the FpML messaging header
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: WorkflowStep
    domain_of:
    - AvailableInventory
    - WorkflowStep
    range: MessageInformation
  eventIdentifier:
    name: eventIdentifier
    description: The identifier(s) that uniquely identify a lifecycle event. The unbounded
      cardinality is meant to provide the ability to associate identifiers that are
      issued by distinct parties. As an example, each of the parties to the event
      may choose to associate their own identifiers to the event.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: Identifier
    required: true
    multivalued: true
  action:
    name: action
    description: Specifies whether the event is a new, a correction or a cancellation.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: ActionEnum
  party:
    name: party
    description: The specification of the event parties. This attribute is optional,
      as not applicable to certain events (e.g. most of the observations).
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: WorkflowStep
    domain_of:
    - AssetBase
    - DebtRedemption
    - MarginCallBase
    - Trade
    - UmbrellaAgreementParty
    - UmbrellaAgreementSet
    - AggregationParameters
    - AvailableInventory
    - CounterpartyPosition
    - WorkflowStep
    - WorkflowStepApproval
    - AdditionalObligations
    - AdditionalRepresentationElection
    - CalculationAgentTerms
    - CalculationCurrencyElection
    - CollateralManagementAgreementElection
    - ControlAgreementElections
    - ControlAgreementNecEventElection
    - CreditSupportDocumentElection
    - CreditSupportProviderElection
    - CustodianElection
    - CustodianRiskElection
    - ElectiveAmountElection
    - FrenchLawAddendumElection
    - HoldingAndUsingPostedCollateralElection
    - LegacyExposureScopeElection
    - LegacyIndependentAmountParty
    - MinimumTransferAmountElection
    - NotificationTimeElection
    - PledgeeRepresentativeRider
    - PostingObligationsElection
    - RecalculationOfValueElection
    - RegimeTerms
    - SecuredPartyRightsEventElection
    - SecurityInterestForObligations
    - SecurityProviderRightsEventElection
    - SensitivityMethodologiesPartyElection
    - SinglePostingParty
    - SpecifiedOrAccessConditionPartyElection
    - SubstitutedRegimeElection
    - SubstitutionPartyElection
    - TerminationCurrencyElection
    - ThresholdElection
    - ValuationAgent
    - ValuationCalculationDateLocationElection
    - AdditionalTerminationEventElection
    - AutomaticEarlyTerminationElection
    - CreditEventUponMergerElection
    - PartyTerminationCurrencySelection
    - SpecifiedEntity
    - EventsOfDefaultElection
    - EligibleCollateralSpecification
    range: Party
    multivalued: true
  account:
    name: account
    description: Optional account information that could be associated to the event.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    owner: WorkflowStep
    domain_of:
    - Party
    - TransferContactInformation
    - WorkflowStep
    range: Account
    multivalued: true
  creditLimitInformation:
    name: creditLimitInformation
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: CreditLimitInformation
  workflowState:
    name: workflowState
    description: The event workflow information, i.e. the workflow status, the associated
      comment and the partyCustomisedWorkflow which purpose is to provide the ability
      to associate custom workflow information to the CDM.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_workflow
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - WorkflowStep
    range: WorkflowState
  timestamp:
    name: timestamp
    description: The set of timestamp(s) associated with the event as a collection
      of [dateTime, qualifier].
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: WorkflowStep
    domain_of:
    - Valuation
    - CompositionStep
    - WorkflowStep
    - WorkflowStepApproval
    range: EventTimestamp
    required: true
    multivalued: true
all_of:
- description: 'CounterpartyPositionBusinessEventOrBusinessEventOrProposedEventChoice:
    Choice rule to control that either positionBusinessEvent is present, businessEvent
    is present or proposedEvent is present, but not more than one at the same time.'
  exactly_one_of:
  - slot_conditions:
      counterpartyPositionBusinessEvent:
        name: counterpartyPositionBusinessEvent
        value_presence: PRESENT
  - slot_conditions:
      businessEvent:
        name: businessEvent
        value_presence: PRESENT
  - slot_conditions:
      proposedEvent:
        name: proposedEvent
        value_presence: PRESENT