| 1 Definition | 2 Protocol | 3 Syntax | 4 Semantics |
1 Definition
The Action of a Process requesting that a Locate Service:
- Animate an MM-Animated Item with a Stream or Command Item – an atomic element of a Stream.
- Grant Rights based on Model Rights to the MM-Animated Item.
If the request is accepted, the Locate Service responds with actual Rights to the MM-Animated Item.
2 Protocol
- User sends “MM-Animate PA Request including Item, Point of View, Location, and Rights (Status=Model)” to MM-Animate Service.
- If MM-Animate Service is a free service, Goto MM-Animate
- If MM-Animate Service is a pay service:
- User sends “MM-Animate PA Request with Service Pricing Model (Status=Model)” to MM-Animate Service.
- MM-Animate Service sends “MM-Animate PA Response”:
- If “MM-Animate PA Response includes Status=Err”, goto End
- If “MM-Animate PA Response includes Status=Ack and Service Pricing Model with Transaction (both Status=Model)”, User:
- Transacts “Value included in Transaction”.
- Sends “MM-Animate PA Request including Service Pricing Model (Status=Model) with Transaction (both Status=Final)” to MM-Animate Service.
- MM-Animate: MM-Animate Service
- MM-Animates “Item”.
- Sends “MM-Animate PA Response” including:
- “Rights (Status=Final)” to the MM-Animated Item.
- “Service Pricing Model (Status=Final)”, if MM-Animate Service is pay.
- End.
The protocol described using Workflow Description Language (WDL) is available at this link:
https://schemas.mpai.community/MMM4/V2.2/wdl/MMAnimatePA.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/MMAnimatePA.json
4 Semantics
| Label | Description |
| Header | MM-Animate Process Action Header – Standard “MMM-2AP-Vx.y” |
| MInstanceID | Identifier of M-Instance. |
| UEnvironmentID | Identifier of U-Environment. |
| MMAnimatePAID | Identifier of this PA Instance. |
| MMAnimatePATime | Creation time of this PA Instance. |
| MMAnimatePAData | Data included in this PA Instance. |
| – Time | Time of PA Request emission and execution or PA Response emission. |
| – RQ-Complements | Complements in MM-Animate Request. |
| – Nil ItemID | Item to be MM-Animated. |
| – At Point of View | Point 0f View where the Item is MM-Added. |
| – At MLocationID | M-Location where the Item is MM-Animated and is subsequently animated. |
| – With Stream | Stream Item used to MM-Animate Item. |
| – With Rights | Requested Rights to the MM-Animated Item. |
| – With SPM | Service Pricing Model, if MM-Animate is a pay service. |
| – RS-Complements | Complements in MM-Animate Response. |
| – With Rights | Actual Rights based on Model Rights if PA Request is accepted. |
| – With SPM | Service Pricing Model, if MM-Animate is a pay service. |
| – With PAStatus | Possible Error Messages. |
| – Ack | If PA Request could be performed |
| – Err | If Error was found |
| – Clash | Clashes with other Items. |
| – FaultyPA | Faulty PA Request. |
| – IncID | Incorrect ID. |
| – InsRights | Insufficient Rights. |
| – InsValue | Insufficient Value in Wallet. |
| – LocOOR | No such Location. |
| DataXMData | Identity, provenance, authorised usage, source, type, governance context, security, legality, and annotation of exchanged data. |
| DescMetadata | Descriptive Metadata. |