<- Go to ProcessActions  ->

1 Definition 2 Protocol 3 Syntax 4 Semantics

1 Definition

The Action of a User requesting that an Export Service:

  1. Animate an MU-Added R-Item with
    1. A Stream Item equivalent to the one that is used to animate the Item of which the R-Item is an Analogue Twin, or
    2. Specific commands applied to an Item in the M-Instance that should be reflected to the R-Item that is its Analogue Twin.
  2. Grant Rights based on requested Rights to the MU-Animated R-Item.

If the request is  accepted, the Export Service MU-Animates the the Item providing  the requested Rights.

2 Protocol

  1. User sends “MU-Animate PA Request including R-Item, Point of View, U-Location, Rights (Status=Model)” to MU-Animate Service.
    1. If MU-Animate Service is a free service, goto MU-Animate.
    2. If MU-Animate Service is a pay service:
      1. User sends “MU-Animate PA Request including Service Pricing Model (Status=Model)” to MU-Animate Service.
      2. MU-Animate Service sends “MU-Animate PA Response”:
        1. If “MU-Animate PA Response includes Status=Err”, goto End
        2. If MU-Animate PA Response includes Status=Ack and Service Pricing Model with Transaction (both Status=Model)”, User:
          1. Transacts “Value included in Transaction”.
          2. Sends “MU-Animate PA Request including Service Pricing Model (Status=Model) with Transaction (Status=Final)” to MU-Animate Service.
  2. MU-Animate: MU-Animate Service
    1. MU-Animates “R-Item”.
    2. Sends MU-Animate PA Response” including
      1. “Rights (Status=Final) to MU-Animated R-Item”.
      2. “Service Pricing Model (Status=Final)”, if MU-Animate Service is a pay service.
  3. End.

The protocol described using Workflow Description Language (WDL) is available at this link:

https://schemas.mpai.community/MMM4/V2.2/wdl/MUAnimatePA.wdl

3 Syntax

The structure of the input and output messages, using JavaScript Object Notation (JSON)  is available at this link:

https://schemas.mpai.community/MMM4/V2.2/actions/MUAnimatePA.json

4 Semantics

Label Description
Header MU-Animate Process Action Header – Standard “MMM-3AP-Vx.y”
MInstanceID Identifier of M-Instance.
UEnvironmentID Identifier of U-Environment.
MUAnimatePAID Identifier of this PA Instance.
MUAnimatePATime Creation time of this PA Instance.
MUAnimatePAData Data included in this PA Instance.
– Time Time of PA Request emission and Time of PA Request execution, or PA Response emission.
– RQ-Complements Complements in the PA Request.
  – Nil RItem R-Item to be MU-Animated.
  – At ULocationID U-Location where the R-Item is to be MU-Animated.
  – With Point of View Initial Point of View of R-Item.
  – With Stream Stream Item used to MU-Animate R-Item.
  – With Rights Requested Rights to the MU-Animated R-Item.
  – With SPM Service Pricing Model, if MU-Animate is a pay service.
– RS-Complements Complements in the PA-Response.
  – With Rights Actual Rights based on Model Rights if PA Request is accepted.
  – With SPM Service Pricing Model, if MU-Animate is a pay service.
  – With PAStatus Status of PA Request.
    – Ack If PA Request could be performed
    – Err If Error was found
      – Clash MU-Animated Item clashes with an existing R-Item,
      – FaultyPA Faulty PA Request.
      – IncID Incorrect ID.
      – ULocOOR M-Location out of range.
      – InsRights Insufficient Rights.
      – InsValue Insufficient Value in Wallet.
DataXMData Identity, provenance, authorised usage, source, type, governance context, security, legality, and annotation of exchanged data.
 DescMetadata Descriptive Metadata.

<- Go to ProcessActions  ->