Class: MessageInformation

name: MessageInformation
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_WorkflowStep","description":"Function to create a workflow
      step with a business event and associated details about the message, identifiers,
      event timestamps, parties and accounts involved in the step. The function should
      be used when there is already a fully formed business event with the action
      set to signify that the step is new, or a correction/cancellation of a previous
      step. The action is constrained so that when a previous workflow step is specified,
      the valid actions are as follows; New -> New, New -> Correct, New -> Cancel,
      Correct -> 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":"businessEvent","type":"BusinessEvent","cardinality":"0..1"}],"output":{"name":"workflowStep","type":"WorkflowStep","cardinality":"1..1"}},{"name":"Create_AcceptedWorkflowStep","description":"Represents
      the acceptance of a proposed instruction that results in a workflow step containing
      a business event, message details, identifiers, event timestamps, parties and
      accounts. The previous workflow step input must exist to provide workflow lineage.
      The instruction from the previous workflow step should be used with a [creation
      BusinessEvent] function to create the input business event passed into this
      function e.g. PartyChangeInstruction from the previous step is used with Create_PartyChange
      to produce the business event which should used as an input to this step.","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":"proposedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"},{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"acceptedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"}},{"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"}},{"name":"Create_RejectedWorkflowStep","description":"Represents
      the rejection of a proposed instruction that results in a workflow step containing
      the rejection flag, message details, identifiers, event timestamps, parties
      and accounts involved in the step. The previous workflow step input must exist
      to provide workflow lineage. This function will be further developed to provide
      the reasons for rejection.","inputs":[{"name":"messageInformation","type":"MessageInformation","cardinality":"0..1"},{"name":"timestamp","type":"EventTimestamp","cardinality":"1..*"},{"name":"eventIdentifier","type":"Identifier","cardinality":"1..*"},{"name":"proposedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"}],"output":{"name":"rejectedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"}}]'
description: This class corresponds to the components of the FpML MessageHeader.model.
comments:
- 'Rosetta func: Create_WorkflowStep — Function to create a workflow step with a business
  event and associated details about the message, identifiers, event timestamps, parties
  and accounts involved in the step. The function should be used when there is already
  a fully formed business event with the action set to signify that the step is new,
  or a correction/cancellation of a previous step. The action is constrained so that
  when a previous workflow step is specified, the valid actions are as follows; New
  -> New, New -> Correct, New -> Cancel, Correct -> Correct and Correct -> Cancel.
  When a previous workflow is not specified, the action must be New.'
- 'Rosetta func: Create_AcceptedWorkflowStep — Represents the acceptance of a proposed
  instruction that results in a workflow step containing a business event, message
  details, identifiers, event timestamps, parties and accounts. The previous workflow
  step input must exist to provide workflow lineage. The instruction from the previous
  workflow step should be used with a [creation BusinessEvent] function to create
  the input business event passed into this function e.g. PartyChangeInstruction from
  the previous step is used with Create_PartyChange to produce the business event
  which should used as an input to this step.'
- '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.'
- 'Rosetta func: Create_RejectedWorkflowStep — Represents the rejection of a proposed
  instruction that results in a workflow step containing the rejection flag, message
  details, identifiers, event timestamps, parties and accounts involved in the step.
  The previous workflow step input must exist to provide workflow lineage. This function
  will be further developed to provide the reasons for rejection.'
in_subset:
- cdm_event_workflow
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- messageId
- sentBy
- sentTo
- copyTo

name: MessageInformation
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_WorkflowStep","description":"Function to create a workflow
      step with a business event and associated details about the message, identifiers,
      event timestamps, parties and accounts involved in the step. The function should
      be used when there is already a fully formed business event with the action
      set to signify that the step is new, or a correction/cancellation of a previous
      step. The action is constrained so that when a previous workflow step is specified,
      the valid actions are as follows; New -> New, New -> Correct, New -> Cancel,
      Correct -> 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":"businessEvent","type":"BusinessEvent","cardinality":"0..1"}],"output":{"name":"workflowStep","type":"WorkflowStep","cardinality":"1..1"}},{"name":"Create_AcceptedWorkflowStep","description":"Represents
      the acceptance of a proposed instruction that results in a workflow step containing
      a business event, message details, identifiers, event timestamps, parties and
      accounts. The previous workflow step input must exist to provide workflow lineage.
      The instruction from the previous workflow step should be used with a [creation
      BusinessEvent] function to create the input business event passed into this
      function e.g. PartyChangeInstruction from the previous step is used with Create_PartyChange
      to produce the business event which should used as an input to this step.","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":"proposedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"},{"name":"businessEvent","type":"BusinessEvent","cardinality":"1..1"}],"output":{"name":"acceptedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"}},{"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"}},{"name":"Create_RejectedWorkflowStep","description":"Represents
      the rejection of a proposed instruction that results in a workflow step containing
      the rejection flag, message details, identifiers, event timestamps, parties
      and accounts involved in the step. The previous workflow step input must exist
      to provide workflow lineage. This function will be further developed to provide
      the reasons for rejection.","inputs":[{"name":"messageInformation","type":"MessageInformation","cardinality":"0..1"},{"name":"timestamp","type":"EventTimestamp","cardinality":"1..*"},{"name":"eventIdentifier","type":"Identifier","cardinality":"1..*"},{"name":"proposedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"}],"output":{"name":"rejectedWorkflowStep","type":"WorkflowStep","cardinality":"1..1"}}]'
description: This class corresponds to the components of the FpML MessageHeader.model.
comments:
- 'Rosetta func: Create_WorkflowStep — Function to create a workflow step with a business
  event and associated details about the message, identifiers, event timestamps, parties
  and accounts involved in the step. The function should be used when there is already
  a fully formed business event with the action set to signify that the step is new,
  or a correction/cancellation of a previous step. The action is constrained so that
  when a previous workflow step is specified, the valid actions are as follows; New
  -> New, New -> Correct, New -> Cancel, Correct -> Correct and Correct -> Cancel.
  When a previous workflow is not specified, the action must be New.'
- 'Rosetta func: Create_AcceptedWorkflowStep — Represents the acceptance of a proposed
  instruction that results in a workflow step containing a business event, message
  details, identifiers, event timestamps, parties and accounts. The previous workflow
  step input must exist to provide workflow lineage. The instruction from the previous
  workflow step should be used with a [creation BusinessEvent] function to create
  the input business event passed into this function e.g. PartyChangeInstruction from
  the previous step is used with Create_PartyChange to produce the business event
  which should used as an input to this step.'
- '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.'
- 'Rosetta func: Create_RejectedWorkflowStep — Represents the rejection of a proposed
  instruction that results in a workflow step containing the rejection flag, message
  details, identifiers, event timestamps, parties and accounts involved in the step.
  The previous workflow step input must exist to provide workflow lineage. This function
  will be further developed to provide the reasons for rejection.'
in_subset:
- cdm_event_workflow
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  messageId:
    name: messageId
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: A unique identifier assigned to the message.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: MessageInformation
    domain_of:
    - MessageInformation
    range: string
    required: true
  sentBy:
    name: sentBy
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: The identifier for the originator of a message instance.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: MessageInformation
    domain_of:
    - MessageInformation
    range: string
  sentTo:
    name: sentTo
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: The identifier(s) for the recipient(s) of a message instance.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: MessageInformation
    domain_of:
    - MessageInformation
    range: string
    multivalued: true
  copyTo:
    name: copyTo
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: A unique identifier (within the specified coding scheme) giving the
      details of some party to whom a copy of this message will be sent for reference.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: MessageInformation
    domain_of:
    - MessageInformation
    range: string
    multivalued: true