<- Go to ProcessActions  ->

1 Definition 2 Functional Requirements 3 Syntax 4 Semantics

1 Definition

The Action of a User requesting that an Export Service either:

  1. Render an Item MM-Added at an M-Location with a Spatial Attitude as an R-Item at a U-Location with a Spatial Attitude or
  2. Render an M-Location, and
  3. Grant Rights to the U-Location based on requested Rights.

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

2 Functional Requirements

  1. User sends “MU-Actuate PA Request including Item and Point of View or Location (in the M-Instance), and Point of View (in the Universe), R-Item Type, and Rights (Status=Model)” to MU-Actuate Service.
    1. If MU-Actuate Service is a free service, goto MU-Actuate.
    2. If MU-Actuate Service is a pay service:
      1. User sends “MU-Actuate PA Request including Service Pricing Model (Status=Model)” to MU-Actuate Service.
      2. MU-Actuate Service sends “MU-Actuate PA Response”:
        1. If “MU-Actuate PA Response includes Status=Err”, goto End
        2. If “MU-Actuate PA Response includes Status=Ack and Service Pricing Model with Transaction (both Status=Model)”, User
          1. Transacts “Value included in Transaction”.
          2. Sends “MU-Actuate PA Request including Service Pricing Model (Status=Model) with Transaction (Status=Final)” to MU-Actuate Service.
  2. MU-Actuate: Export Service:
    1. MU-Actuates “Item”.
    2. Sends “MU-Actuate PA Response” including:
      1. “Rights (Status=Final) to the R-Item” resulting from the execution of the MU-Actuate Process Action.
      2. “Service Pricing Model (Status=Final)”, if MU-Actuate 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/MUActuatePA.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/MUActuatePA.json

4 Semantics

Label Description
Header MU-Actuate Process Action Header, Standard “MMM-3CP-Vx.y”
MInstanceID Identifier of M-Instance.
UEnvironmentID Identifier of U-Environment.
MUActuatePAID Identifier of this PA Instance.
MUActuatePATime Creation time of this PA Instance.
MUActuatePAData 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.
  – oneOf One of
    – Nil ItemID Item to be MU-Actuated.
    – Nil MLocation M-Location where Item to be MU-Actuated is MM-Embedded.
  – At ULocation The U-Location where the Item is MU-Actuated.
  – 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 Rights Requested Rights R-Item resulting from the MU-Actuated Process Action.
  – With SPM Service Pricing Model, if MU-Actuate is a pay service.
– RS-Complements Complements in the PA Response.
  – Nil RItem R-Item produced by the MU-Actuate Process Action.
  – With Rights Rights based on requested 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.
DataXMData Identity, provenance, authorised usage, source, type, governance context, security, legality, and annotation of exchanged data.
 DescMetadata Descriptive Metadata.

<- Go to ProcessActions  ->