| 1 Definition | 2 Protocol | 3 Syntax | 4 Semantics |
1 Definition
The Action of a User requesting that Rights Manage Service:
- Modify the Rights of a Process or an Item.
- Grant to the User the Rights to further Rights Change the modified Rights to the Process or Item, based on User’s request.
If the requests are accepted, the User will receive Right to either
- The Items based on Licence (Status=Final)
- The Rights-Managed Process.
2 Protocol
- Process sends “Rights Change PA Request including ID of Process or Item and the Rights to be Changed (removed or added) with the Rights (Status=Model) to further Right Change them” to Rights Change Service.
- Rights Change Service MM-Sends a Message including Rights Change PA Request to:
- The Process if the entity to be Rights Changed is a Process.
- To the Processes holding “Rights to the Item” if the entity to be Rights Changed is an Item.
- If Rights Change PA Response is
- Negative from the Process or from at least one Process holding “Rights to the Item” got End.
- Positive from the Process or all the Processes
- If Rights Change Service is a free service, goto Rights Change.
- If Rights Change Service is a pay service:
- User sends “Rights Change PA Request including Service Pricing Model (Status=Model)” to Rights Change Service.
- Rights Change Service sends “Rights Change PA Response”:
- If “Rights Change PA Response includes Status=Err”, goto End.
- If “Rights Change PA Response includes Status=Ack and Service Pricing Model with Transaction (both Status=Model)”, User:
- Transacts “Value included in Transaction”.
- Sends “Rights Change PA Request including Service Pricing Model (Status=Model) with Transaction (Status=Final)” to Rights Change Service.
- Rights Change: Rights Change Service
- Adds and/or removes “Rights to Process or Item””.
- Identifies new “Process or Item”.
- If “Item”, creates “Licence”.
- Sends “Rights Change PA Response” including one of
- “ID of Rights-Changed Service or Item”.
- “Licence” if Rights-Changed entity is Item.
- “Service Pricing Model”, if Rights Change is a pay service.
- End
The protocol described using Workflow Description Language (WDL) is available at this link:
https://schemas.mpai.community/MMM4/V2.2/wdl/RightsChangePA.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.1/actions/RightsChangePA.json
4 Semantics
| Label | Description |
| Header | Rights Change Process Action Header – Standard “MMM-RCP-Vx.y” |
| MInstanceID | Identifier of M-Instance. |
| UEnvironmentID | Identifier of U-Environment. |
| MMSendPAID | Identifier of this PA Instance. |
| MMSendPATime | Creation time of this PA Instance. |
| MMSendPAData | Data included in this PA Instance. |
| – Time | Time of PA Request emission and execution or PA Response emission. |
| – RQ-Complements | Complements in the PA Request. |
| – oneOf | |
| – Nil ProcessID |
Process whose Rights are requested to be Changed. |
| – oneOf | – One of |
| – Nil ItemID | – Item whose Rights are requested to be Changed. |
| – Nil MLocationID | -M-Location wrapping the Item. |
| – With NewRights | New requested Rights to be added to or removed from Process or Item. |
| – With FutureRights | Requesting Process’s requested Rights to further change Rights Changed Process or Item. |
| – With SPM | Service Pricing Model, if Rights Change is a pay service. |
| – RS-Complements | Complements in the PA Response. |
| – With Rights | Actual Rights based on Model Rights if PA Request is accepted. |
| – With SPM | Service Pricing Model, if Rights Change is a pay service. |
| – With PAStatus | Possible Error Messages. |
| – Ack | If PA Request could be performed. |
| – Err | If PA Request could not be performed. |
| – FaultyPA | Faulty PA Request. |
| – IncID | Incorrect ID. |
| – InsRights | Insufficient Rights. |
| – InsValue | Insufficient Value in Wallet. |
| – MLocOOR | No such M-Location. |
| DataXMData | Identity, provenance, authorised usage, source, type, governance context, security, legality, and annotation of exchanged data. |
| DescMetadata | Descriptive Metadata. |