1 Definition | 2 Functional Requirements | 3 Syntax | 4 Semantics |
1 Definition
The Action of a User requesting that an Export-Import Service:
1. Animate an MU-Added R-Item with
1.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
1.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 Model Rights to the MU-Animated R-Item.
If the request is accepted, the Export-Import Service responds MU-Animates the the Item providing actual Rights to the requesting User.
2 Functional Requirements
The MU-Animate Process Action includes:
In the request
– The R-Item to be MU-Animated.
– The U-Location where the R-Item is to be MU-Animated.
– A Stream or a Command used to MU-Animate the R-Item. A Command is an atomic element of a Stream.
– The Model Rights to the MM-Animated Item.
– A Transaction if requested by the Export-Import Service.
In the response
– The Rights per the Model Rights if request is successful.
3 Syntax
https://schemas.mpai.community/MMM4/V2.1/actions/MUAnimatePA.json
4 Semantics
Label | Description |
Header | MU-Animate Process Action Header |
– Standard-MUAnimatePA | The characters “MMM-3AP-V” |
– Version | Major version – 1 or 2 characters |
– Dot-separator | The character “.” |
– Subversion | Minor version – 1 or 2 characters |
MInstanceID | Identifier of M-Instance. |
MEnvironmentID | Identifier of M-Environment. |
UEnvironmentID | Identifier of U-Environment. |
MUAnimatePAData | Data included in the MU-Animate Process Action. |
– Time | Time of PA request emission and Time of PA request execution. |
– 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 Stream | Stream Item used to MU-Animate R-Item. |
– With ModelRights | Requested Rights to the MU-Animated R-Item. |
– With Transaction | Transaction made to Export-Import Service if requested. |
– RS-Complements | Complements in the PA-Response. |
– With Rights | Actual Rights based on Model Rights if PA Request is accepted. |
– 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. |
DescMetadata | Descriptive Metadata. |