<- Go to ProcessActions  ->

1 Definition 2 Protocol 3 Syntax 4 Semantics

1 Definition

The Action of a User requesting an Export Service to:

  1. Place an R-Item at a U-Location with a Spatial Attitude.
  2. Grant Rights to the MU-Added R-Item based on requested Rights.

If the request is accepted, the Export-Import Service places the R-Item and grants the requested Rights to the R-Item.

2 Protocol

  1. User sends “MU-Add PA Request including R-Item, Point of View, Rights (Status=Model)” to MU-Add Service.
    1. If MU-Add Service is a free service, goto MU-Add.
    2. If MU-Add Service s a pay service:
      1. User sends “MU-Add PA Request including Service Pricing Model (Status=Model)” to MU-Add Service.
      2. MU-Add Service sends “MU-Add PA Response”:
        1. If “MU-Add PA Response includes Status=Err”, goto End
        2. If “MU-Add PA Response includes Status=Ack and Service Pricing Model with Transaction (both Status=Model)”, User:
          1. Transacts “Value included in Transaction”.
          2. Sends “MU-Add PA Request including Service Pricing Model (Status=Model) with Transaction (Status=Final)” to MU-Add Service.
  2. MU-Add: MU-Add Service
    1. MU-Adds “R-Item”.
    2. Sends “MU-Add PA Response” including:
      1. “Rights (Status=Final)”
      2. “Service Pricing Model (Status=Final)”, if MU-Add 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/MUAddPA.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/MUAddPA.json

4 Semantics

Label Description
Header MU-Add Process Action Header – Standard “MMM-3DP-V”
MInstanceID Identifier of M-Instance.
UEnvironmentID Identifier of U-Environment.
MUAddPAID Identifier of this PA Instance.
MUAddPATime Creation time of this PA Instance.
MUAddPAData 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 RItemID R-Item to be MU-Added.
  – At ULocationID U-Location where the Item is to be MU-Added.
  – With SpatialAttitude The Spatial Attitude of the Item to be MU-Added.
  – With Rights Requested Rights to the MU-Added Item.
  – With SPM Service Pricing Model, if MU-Add is a pay service.
– D-Complements Complements in the PA Response.
  – With Rights Rights based on Requested Rights, if PA Request is accepted.
  – With SPM Service Pricing Model, if MU-Add is a pay service.
  – With PAStatus Status of PA Request.
    – Ack If PA Request could be performed
    – Err If Error was found
      – Clash R-Item clashes with another R-Iten.
      – 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  ->