<- Go to ToC ProcessActions->

1 Definition 2 Functional Requirements 3 Syntax 4 Semantics

1 Definition

The Action of a User requesting an Export-Import Service to:
1. Render an Item MM-Embedded at an M-Location with a Spatial Attitude as an R-Item at a U-Location with a Spatial Attitude.
2. Additionally render the Scene of the M-Location that includes the Item, if the M-Location field is present.
3. Grant Rights to the U-Location based on Model Rights.

If the request is  accepted, the Export-Import Service places the R-Item at the requested U-Location providing  actual Rights to the requesting User.

2 Functional Requirements

The MU-Actuate Process Action includes:

In the request

– The Item to be MU-Actuated.

– The M-Location where the Item is MM-Embedded.

– The Spatial Attitude of the Item.

– The U-Location where the R-Item is to be MU-Actuated.

– The R-Item Type (one of of the three Types of R-Item) used to render the Item.

– The Spatial Attitude of the R-Item to be MU-Actuated at the U-Location.

– The Model Rights to the MU-Actuated Item.

– A Transaction if requested by the Export-Import Service.

In the response

– The MU-Actuated R-Item and its ID (if any is provided).

– The Rights to the MU-Actuated R-Item per the Model Rights if request is successful.

3 Syntax

https://schemas.mpai.community/MMM4/V2.1/data/MUActuate.json

4 Semantics

Label Description
Header MM-Embed Process Action Header
– Standard-MUActuatePA The characters “MMM-UCP-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.
MUActuatePAData Data included in the MU-Actuate Process Action.
– Time Time of PA request emission and Time of PA request execution.
– RQ-Complements Complements in the PA Request.
  – Nil ItemID Item to be MU-Actuated.
  – From MLocation M-Location where Item to be MU-Actuated is MM-Embedded.
  – At ULocation The U-Location where the Item is MU-Actuated.
  – With Spatial Attitude The Spatial Attitude of the Item
  – With RItemType The Type of R-Item used to MU-Actuate the Item.
  – With SpatialAttitude The Spatial Attitude of the Item MU-Actuated as an R-Item.
  – With ModelRights Rights that are requested to the Modified Item.
  – With Transaction Transaction made to Import-Export Service if requested.
– RS-Complements Complements in the PA Response.
  – Nil RItem R-Item produced by the MU-Actuate Process Action.
  – With Rights Actual Rights based on Model Rights if PA Request is accepted.
  – With PAStatus Possible Error Messages.
    – Ack If PA Request could be performed
    – Err If Error was found
      – Clash MM-Embedded Item clashes with an existing object,
      – FaultyPA Faulty PA Request.
      – IncID Incorrect ID.
      – MLocOOR M-Location out of range.
      – ULocOOR U-Location out of range.
      – InsRights Insufficient Rights.
      – InsValue Insufficient Value in Wallet.
 DescMetadata Descriptive Metadata.

<- Go to ToC ProcessActions->