Definition
Functional Requirements
Syntax
Semantics
Conformance Testing
Performance Assessment
Definition
AUC-AUS (PGM-UCS) is the Data Type that A‑User Control and the Private Storage of the Module exchange, through the Controller. It has two modes: the Request (RQ), sent by A‑User Control, and the Response (RS), sent by Private Storage. The Request establishes, for an A‑User session, the storage scopes, the retention and life cycle policy and the access rights that Private Storage enforces on the operations of the AIMs. The Response reports the outcome of the life cycle command, the operations served, the enforcement of the access rights and of the retention, and the integrity and capacity of the storage. Every Request is answered by a Response.
Functional Requirements
- Header and Mode: The Data shall have Header “PGM-UCS-V1.0” and Mode equal to RQ for a Request and to RS for a Response; the properties that belong to the other mode shall not be present.
- Identification: The Data shall carry the identifiers of the M‑Instance, of the U‑Environment and of the session, and a unique identifier and a time (AUCAUSID, AUCAUSTime).
- Correlation: A Response shall carry the identifier (RequestID) of the Request that it answers.
- Life cycle: A Request may state the storage life cycle command (Open, Close, Archive the session content to the historical scope, Delete) and the retention policy of each scope.
- Scopes: A Request may state which storage scopes (session, historical) are active or available for the session.
- Access rights: A Request may state the read and write authorisations that Private Storage enforces on the operations of the AIMs, in particular whether reads of the historical scope and writes to the active scope are permitted. Reads of the session scope are implicit and need no authorisation.
- Reporting: A Response shall report the life cycle command executed and its result, the read, write and rejected operations served in the reporting window, how the access rights and the retention were enforced, and the integrity and capacity of the storage.
- Metadata: The Data shall include DataXMData and may include DescrMetadata.
Syntax
https://schemas.mpai.community/PGM1/V1.0/data/AUCAUS.json
Semantics
Table 1 gives the properties common to the two modes, Table 2 those of the Request and Table 3 those of the Response.
Table 1 – Properties common to the Request and the Response of AUC-AUS
| Label | Description |
| Header | Header of the Data Type, with the version. (required) |
| Mode | RQ for a Request (A-User Control to Private Storage), RS for a Response (Private Storage to A-User Control). One of: RQ, RS. (required) |
| MInstance | Identifier of the M-Instance. (required) |
| UEnvironment | Identifier of the U-Environment. (required) |
| SessionID | Identifier of the A-User session whose storage the Data governs or reports. (required) |
| AUCAUSID | Identifier of this Request or Response. (required) |
| AUCAUSTime | Time at which the Request or the Response was produced. (required) |
| DataXMData | Data Exchange Metadata of MPAI-PTF. |
| DescrMetadata | Descriptive metadata (plain text, at most 2048 characters). |
Table 2 – Properties of the Request (Mode RQ)
| Label | Description |
| Lifecycle | The storage life cycle command and the retention policy. |
| – Command | Open, Close, Archive or Delete. |
| – RetentionPolicy | The retention policy of the SessionScope and of the HistoricalScope. |
| StorageScopes | The scopes active or available for the session. |
| – SessionScope | enabled or disabled. |
| – HistoricalScope | enabled or disabled. |
| AccessRights | The access rights that Private Storage enforces. |
| – HistoricalReadAuthorisation | granted or denied: whether the AIMs may read the historical scope. |
| – WriteAuthorisation | granted or denied: whether writes to the active scope are permitted. |
Table 3 – Properties of the Response (Mode RS)
| Label | Description |
| RequestID | Identifier of the Request this Response answers. |
| LifecycleOutcome | The life cycle command executed (Command) and its Result: success, failure or partial. |
| OperationOutcomes | The operations served in the reporting window: ReadCount, WriteCount and RejectedCount (operations rejected for lack of authorisation). |
| Enforcement | How the rights were enforced: HistoricalReadEnforced and WriteEnforced (granted or denied) and RetentionApplied (true or false). |
| StorageState | Integrity (ok, degraded or error) and CapacityStatus (normal, limited or full) of the storage. |
Conformance Testing
Data conforms with AUC-AUS if it validates against the schema of Section 3 and, if the Mode is RQ, contains the properties required for a Request and none of those of a Response, and vice versa. If a schema contains references to other schemas, conformance of data for the primary schema implies that any data referencing a secondary schema shall also validate against the relevant schema.
Performance Assessment
Not part of this specification.
