diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md index 3d836f23c..7f41f37b2 100644 --- a/_docs_integrate/data-model-overview.md +++ b/_docs_integrate/data-model-overview.md @@ -497,15 +497,16 @@ For more information you should check out the section [AuthenticationRequestItem For more information you should check out the section [ConsentRequestItem of the Request and Response introduction]({% link _docs_integrate/request-and-response-introduction.md %}#consentrequestitem). Furthermore, all details on how to use the ConsentRequestItem and examples of use cases for it can be found in the [Request one-time consent of peer]({% link _docs_integrate/request-one-time-consent-of-peer.md %}) guide. -| Name | Type | Description | -| --------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| @type | `"ConsentRequestItem"` | Specifies the type of the RequestItem for internal processing. | -| consent | `string` | The textual consent the user needs to give. This is different to the description of the RequestItem, as the consent would be the actual statement the user agrees to, the description only provides a help text. | -| link | `string` \| `undefined` | A valid URL linking to a website which contains more information, like the EULA or privacy terms. | -| linkDisplayText | `string` \| `undefined` | If a link is specified, a display text, which is displayed in the App instead of the link's URL, can be specified for this link. | -| description | `string` \| `undefined` | An optional, human readable description for the RequestItem. | -| metadata | `object` \| `undefined` | The metadata property can be used to provide arbitrary JSON content by the sender of the Request. The metadata is not processed by enmeshed. It is a great way to use your own process descriptors at the time of sending the Request which helps you identify the correct internal process at the time of receiving the Response. | -| mustBeAccepted | `boolean` | The mandatory `mustBeAccepted` property is used to differentiate between required and optional RequestItems within the Request.
{::nomarkdown}{:/} | +| Name | Type | Description | +| ------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| @type | `"ConsentRequestItem"` | Specifies the type of the RequestItem for internal processing. | +| consent | `string` | The textual consent the user needs to give. This is different to the description of the RequestItem, as the consent would be the actual statement the user agrees to, the description only provides a help text. | +| link | `string` \| `undefined` | A valid URL linking to a website which contains more information, like the EULA or privacy terms. | +| linkDisplayText | `string` \| `undefined` | If a link is specified, a display text, which is displayed in the App instead of the link's URL, can be specified for this link. | +| requiresInteraction | `boolean` \| `undefined` | If set to `true`, an explicit action to grant the consent is required, ensuring that it is given intentionally. In case of the enmeshed App, this results in the checkbox associated with the ConsentRequestItem not being preselected and requiring the App user to explicitly tick it. This may be necessary for legal reasons, for example, when the consent involves the processing of sensitive data. | +| description | `string` \| `undefined` | An optional, human readable description for the RequestItem. | +| metadata | `object` \| `undefined` | The metadata property can be used to provide arbitrary JSON content by the sender of the Request. The metadata is not processed by enmeshed. It is a great way to use your own process descriptors at the time of sending the Request which helps you identify the correct internal process at the time of receiving the Response. | +| mustBeAccepted | `boolean` | The mandatory `mustBeAccepted` property is used to differentiate between required and optional RequestItems within the Request.
{::nomarkdown}{:/} | #### CreateAttributeRequestItem diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index ff8852c66..d31da25f8 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -53,6 +53,7 @@ The step-by-step instructions can be consulted to start the migration to version - The `title` property of the [AuthenticationRequestItem]({% link _docs_integrate/data-model-overview.md %}#authenticationrequestitem) is now mandatory to always convey the subject of authentication. - The `requireManualDecision` property of all [RequestItems]({% link _docs_integrate/data-model-overview.md %}#requestitems) has been removed. [Requests]({% link _docs_integrate/data-model-overview.md %}#request) containing at least one [AuthenticationRequestItem]({% link _docs_integrate/data-model-overview.md %}#authenticationrequestitem) or [ConsentRequestItem]({% link _docs_integrate/data-model-overview.md %}#consentrequestitem) within their `items` property are no longer eligible for automatic acceptance or rejection by the [Decider Module]({% link _docs_explore/61-runtime.md %}#decider-module), yet proper configuration still enables automatic processing of Requests containing other RequestItems. + Furthermore, the `requiresInteraction` property was added to the ConsentRequestItem to keep the ability to require an explicit action to grant consent, even though the `requireManualDecision` property was removed. - The properties `validFrom` and `validTo` have been removed from the [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute), the [RelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute), the [IdentityAttributeQuery]({% link _docs_integrate/data-model-overview.md %}#identityattributequery), the [RelationshipAttributeQuery]({% link _docs_integrate/data-model-overview.md %}#relationshipattributequery) and the [ThirdPartyRelationshipAttributeQuery]({% link _docs_integrate/data-model-overview.md %}#thirdpartyrelationshipattributequery). Specifying validity periods for [Attributes]({% link _docs_integrate/data-model-overview.md %}#attributes) is no longer supported as they were not enforced during Attribute processing so far. - The `template` property of the [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) was replaced by the `templateId` property in order to reduce data duplication by storing only the `id` of the [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) rather than the RelationshipTemplate itself within the Relationship. diff --git a/_docs_integrate/request-and-response-introduction.md b/_docs_integrate/request-and-response-introduction.md index b18909f81..ad8ce4c54 100644 --- a/_docs_integrate/request-and-response-introduction.md +++ b/_docs_integrate/request-and-response-introduction.md @@ -305,8 +305,9 @@ In our example Request, this is the case for the [AuthenticationRequestItem]({% If you do not agree to accept a RequestItem whose value of its `mustBeAccepted` property is set to `true`, you are forced to reject the Request as a whole. Some RequestItems exhibit particular characteristics. -For the [ConsentRequestItem]({% link _docs_integrate/data-model-overview.md %}#consentrequestitem), for example, a `link` to an external website with more information on the `consent` issue originating from the Sender can optionally be specified. -Specifying a `link` causes an icon to appear to the right of the ConsentRequestItem. +For the [ConsentRequestItem]({% link _docs_integrate/data-model-overview.md %}#consentrequestitem), for example, setting the optional property `requiresInteraction` to `true` means that the checkbox in the App associated with it is not preselected and must be explicitly ticked, even if `mustBeAccepted` is set to `true`. +Furthermore, a `link` to an external website with more information on the `consent` issue originating from the Sender can optionally be specified for the ConsentRequestItem. +This causes an icon to appear to the right of it. Clicking on this icon redirects to the corresponding website. The ConsentRequestItem from our example Request provides a `link`. For this reason, the mentioned icon can be found in the screenshot of the App. @@ -329,7 +330,7 @@ If a RequestItem is accepted, an [AcceptResponseItem]({% link _docs_integrate/da Depending on the kind of RequestItem, it might be a specific AcceptResponseItem, extending the base AcceptResponseItem to answer to RequestItems demanding additional information. For example, a ReadAttributeRequestItem is accepted using a [ReadAttributeAcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#readattributeacceptresponseitem), additionally transmitting information about the respective Attribute. -
+
If a RequestItem is rejected, however, a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) is created. Lastly, in case the enmeshed Runtime detects a problem, an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) is generated. diff --git a/_docs_integrate/request-one-time-consent-of-peer.md b/_docs_integrate/request-one-time-consent-of-peer.md index f0771c7b3..e13dbe461 100644 --- a/_docs_integrate/request-one-time-consent-of-peer.md +++ b/_docs_integrate/request-one-time-consent-of-peer.md @@ -67,6 +67,7 @@ To create the Request, the Sender must proceed as described in the [Create outgo In this example, the value of the `mustBeAccepted` property of the ConsentRequestItem is set to `true`. Please note that the `<...>` notation is used as a placeholder for the actual data as usual and that the `link` property of the [ConsentRequestItem]({% link _docs_integrate/data-model-overview.md %}#consentrequestitem) is optional and can therefore also be omitted. In addition to the `link`, a `linkDisplayText` could optionally be specified, which would be displayed in the App instead of the URL of the `link`. +Furthermore, the `requiresInteraction` property could be used to ensure that the checkbox in the App associated with the ConsentRequestItem is definitely not preselected. ```jsonc {