Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
dc95f4a
feat: change introduction text of LocalAttribute
britsta Oct 29, 2025
b8d6b67
feat: add sections for new Attribute types
britsta Oct 29, 2025
3377f3e
feat: define OwnIdentityAttribute
britsta Oct 29, 2025
4d9af39
feat: define PeerIdentityAttribute
britsta Oct 29, 2025
a2a3977
fix: missing point in createdAt description
britsta Oct 29, 2025
b2a9bf4
feat: add sections for new AttributeDeletionInfos
britsta Oct 29, 2025
073bcb3
feat: add properties of EmittedAttributeDeletionInfo
britsta Oct 29, 2025
41d1250
feat: add properties of ReceivedAttributeDeletionInfo
britsta Oct 29, 2025
b3fd603
refactor: move description to new AttributeDeletionInfos
britsta Oct 29, 2025
3b52663
feat: add properties of AttributeForwardingDetails
britsta Oct 29, 2025
ab588ec
feat: remove LocalAttributeDeletionInfo
britsta Oct 29, 2025
5122f28
refactor: copy common LocalAttribute properties to new Attribute types
britsta Oct 29, 2025
14d62e2
feat: add draft for new LocalAttribute concept in v7 migration guide
britsta Oct 29, 2025
3c4e05e
feat: define OwnRelationshipAttribute
britsta Oct 29, 2025
9462df9
feat: remove parentId property
britsta Oct 29, 2025
5142c92
feat: define PeerRelationshipAttribute
britsta Oct 29, 2025
f3cf631
feat: define ThirdPartyRelationshipAttribute
britsta Oct 29, 2025
10bec0f
feat: remove LocalAttributeShareInfo
britsta Oct 29, 2025
6c7193d
feat: remove sharedAttributeCopyCreated event
britsta Oct 30, 2025
2b75bfb
feat: introduce new NotificationItems
britsta Oct 30, 2025
28b97de
feat: use new NotificationItems in use cases and scenarios
britsta Oct 30, 2025
0e7db83
feat: improve AttributeForwardingDetails description
britsta Oct 30, 2025
81bd5dd
feat: improve description of deletionInfo property
britsta Oct 30, 2025
19a8078
feat: remove own shared and peer shared from data model
britsta Oct 30, 2025
150d3fb
feat: use new deletionStatuses in use cases and scenarios
britsta Oct 30, 2025
b5d2eb9
feat: mention NotificationItem changes in v7 migration guide
britsta Oct 30, 2025
a338072
feat: improve v7 migration guide for changed data structures
britsta Oct 31, 2025
68cc808
feat: move LocalAttribute description to its subtypes
britsta Oct 31, 2025
76c5463
feat: improve descriptions of LocalAttribute subtypes
britsta Oct 31, 2025
5e0cf41
refactor: changed wording in v7 migration guide
britsta Oct 31, 2025
1150e65
feat: improve descriptions of AttributeDeletionInfos
britsta Oct 31, 2025
85f6208
refactor: make descriptions more consistent
britsta Oct 31, 2025
68e3285
refactor: changed wording
britsta Oct 31, 2025
26c8d75
feat: improve descriptions of NotificationItems
britsta Oct 31, 2025
bbef73f
refactor: changed wording
britsta Nov 3, 2025
62c4524
refactor: changed order
britsta Nov 3, 2025
64ec98f
refactor: changed current time stamp wording
britsta Nov 3, 2025
ca7fd7e
feat: handle ToBeDeletedByRecipient properly
britsta Nov 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _docs_integrate/attribute-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ Depending on what IdentityAttribute value type is used, the associated IdentityA

#### Simple IdentityAttributes

A simple IdentityAttribute is an IdentityAttribute with an [IdentityAttribute value type]({% link _docs_integrate/attribute-values.md %}#identity-attributes) for which none of its properties correspond to another IdentityAttribute value type. In most cases, the IdentityAttribute value type then only has a single property, which often also has the name `value`. This property stores the actual value of the IdentityAttribute. From a technical point of view, it can be stated that the `id` of a [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) whose `content` is given by a simple IdentityAttribute cannot be the `parentId` of another LocalAttribute. In other words, it could be said that simple IdentityAttributes are not composite of other IdentityAttributes. Examples of simple IdentityAttributes are IdentityAttributes with IdentityAttribute value type [DisplayName]({% link _docs_integrate/attribute-values.md %}#displayname) or [EMailAddress]({% link _docs_integrate/attribute-values.md %}#emailaddress).
A simple IdentityAttribute is an IdentityAttribute with an [IdentityAttribute value type]({% link _docs_integrate/attribute-values.md %}#identity-attributes) for which none of its properties correspond to another IdentityAttribute value type. In most cases, the IdentityAttribute value type then only has a single property, which often also has the name `value`. This property stores the actual value of the IdentityAttribute. In other words, it could be said that simple IdentityAttributes are not composite of other IdentityAttributes. Examples of simple IdentityAttributes are IdentityAttributes with IdentityAttribute value type [DisplayName]({% link _docs_integrate/attribute-values.md %}#displayname) or [EMailAddress]({% link _docs_integrate/attribute-values.md %}#emailaddress).

#### Complex IdentityAttributes

A complex IdentityAttribute is an IdentityAttribute with an [IdentityAttribute value type]({% link _docs_integrate/attribute-values.md %}#identity-attributes) for which at least one property corresponds to another IdentityAttribute value type. An IdentityAttribute value type that contains such a property can be recognized by whether another IdentityAttribute value type is mentioned in its table in the [documentation]({% link _docs_integrate/attribute-values.md %}#identity-attributes) with regard to the validation of the property. Examples of complex IdentityAttributes are IdentityAttributes with IdentityAttribute value type [BirthDate]({% link _docs_integrate/attribute-values.md %}#birthdate) or [StreetAddress]({% link _docs_integrate/attribute-values.md %}#streetaddress). When [creating a complex IdentityAttribute for yourself]({% link _docs_integrate/create-attributes-for-yourself.md %}#example-of-creating-a-complex-identityattribute), there is an important detail to note in contrast to the [creation of a simple IdentityAttribute for yourself]({% link _docs_integrate/create-attributes-for-yourself.md %}#example-of-creating-a-simple-identityattribute). Creating an IdentityAttribute for yourself always leads to the creation of a [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) whose `shareInfo` property is undefined and whose `content` is given by the IdentityAttribute owned by yourself. Such a LocalAttribute is also referred to as a RepositoryAttribute. If a RepositoryAttribute is created that contains a complex IdentityAttribute within its `content` property, additional RepositoryAttributes are automatically created for each property of its IdentityAttribute value type that corresponds to another IdentityAttribute value type. These RepositoryAttributes are also referred to as children of the RepositoryAttribute belonging to the complex IdentityAttribute. The `id` of their parent is contained within their `parentId` property. The creation of these RepositoryAttributes makes it possible to share individual components of a complex IdentityAttribute. For example, if an IdentityAttribute of type [BirthDate]({% link _docs_integrate/attribute-values.md %}#birthdate) has been created, it is possible to share only the `year` of birth with peers, instead of the full date of birth. The corresponding IdentityAttribute of type [BirthYear]({% link _docs_integrate/attribute-values.md %}#birthyear) does not have to be created manually, but is created automatically after the IdentityAttribute of type [BirthDate]({% link _docs_integrate/attribute-values.md %}#birthdate) has been created.
A complex IdentityAttribute is an IdentityAttribute with an [IdentityAttribute value type]({% link _docs_integrate/attribute-values.md %}#identity-attributes) for which at least one property corresponds to another IdentityAttribute value type. An IdentityAttribute value type that contains such a property can be recognized by whether another IdentityAttribute value type is mentioned in its table in the [documentation]({% link _docs_integrate/attribute-values.md %}#identity-attributes) with regard to the validation of the property. Examples of complex IdentityAttributes are IdentityAttributes with IdentityAttribute value type [BirthDate]({% link _docs_integrate/attribute-values.md %}#birthdate) or [StreetAddress]({% link _docs_integrate/attribute-values.md %}#streetaddress). When [creating a complex IdentityAttribute for yourself]({% link _docs_integrate/create-attributes-for-yourself.md %}#example-of-creating-a-complex-identityattribute), there is an important detail to note in contrast to the [creation of a simple IdentityAttribute for yourself]({% link _docs_integrate/create-attributes-for-yourself.md %}#example-of-creating-a-simple-identityattribute). Creating an IdentityAttribute for yourself always leads to the creation of a [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) whose `shareInfo` property is undefined and whose `content` is given by the IdentityAttribute owned by yourself. Such a LocalAttribute is also referred to as a RepositoryAttribute. If a RepositoryAttribute is created that contains a complex IdentityAttribute within its `content` property, additional RepositoryAttributes are automatically created for each property of its IdentityAttribute value type that corresponds to another IdentityAttribute value type. These RepositoryAttributes are also referred to as children of the RepositoryAttribute belonging to the complex IdentityAttribute. The creation of these RepositoryAttributes makes it possible to share individual components of a complex IdentityAttribute. For example, if an IdentityAttribute of type [BirthDate]({% link _docs_integrate/attribute-values.md %}#birthdate) has been created, it is possible to share only the `year` of birth with peers, instead of the full date of birth. The corresponding IdentityAttribute of type [BirthYear]({% link _docs_integrate/attribute-values.md %}#birthyear) does not have to be created manually, but is created automatically after the IdentityAttribute of type [BirthDate]({% link _docs_integrate/attribute-values.md %}#birthdate) has been created.

Please note that when creating a [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) that contains a complex IdentityAttribute in its `content` property, additional LocalAttributes are only created automatically if the LocalAttribute is a RepositoryAttribute. However, if the LocalAttribute is an own shared IdentityAttribute or a peer shared IdentityAttribute, no additional LocalAttributes are created. More details on the terminology related to [LocalAttributes and IdentityAttributes]({% link _docs_integrate/attribute-introduction.md %}#localattributes-and-identityattributes) can be found in the next section.
{: .notice--info}
Expand Down
1 change: 0 additions & 1 deletion _docs_integrate/connector-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ required_by:
| consumption.<br>outgoingRequestFromRelationshipCreation<br>CreatedAndCompleted | [LocalRequest]({% link _docs_integrate/data-model-overview.md %}#localrequest) | ... a `consumption.`<br>`outgoingRequest`<br>`CreatedAndCompleted` event is fired and it was fired due to an incoming pending Relationship. This convenience event is useful to act on incoming pending Relationships. |
| consumption.outgoingRequestStatusChanged | [RequestStatusChangedEventData](#requeststatuschangedeventdata) | ... the status of an outgoing Request has changed. |
| consumption.relationshipTemplateProcessed | [RelationshipTemplateProcessedEventData](#relationshiptemplateprocessedeventdata) | ... a RelationshipTemplate was processed by Modules like the `RequestModule` or `DeciderModule`. |
| consumption.sharedAttributeCopyCreated | [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) | ... an Attribute is copied for sharing with another Identity. |
| transport.fileOwnershipClaimed | [File]({% link _docs_integrate/data-model-overview.md %}#file) | ... the ownership of the File was claimed by another Identity. This happens when they accept a corresponding [TransferFileOwnershipRequestItem]({% link _docs_integrate/data-model-overview.md %}#transferfileownershiprequestitem). |
| transport.fileOwnershipLocked | [File]({% link _docs_integrate/data-model-overview.md %}#file) | ... the ownership of the File is locked and can only be claimed once the [`ownershipToken` is regenerated]({% link _docs_use-cases/use-case-transport-regenerate-file-ownership-token.md %}). |
| transport.identityDeletionProcessStatusChanged | [IdentityDeletionProcess]({% link _docs_integrate/data-model-overview.md %}#identitydeletionprocess) | ... a new IdentityDeletionProcess has been created or the status of an existing IdentityDeletionProcess has changed. |
Expand Down
4 changes: 2 additions & 2 deletions _docs_integrate/create-attributes-for-peer.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ If the Recipient does not want to create any of the Attributes offered by the Se

If the Recipient agrees to the creation of one of the Attributes offered by the Sender, it can accept the associated CreateAttributeRequestItem contained in the Request for creating Attributes.
The [AcceptRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#acceptrequestitemparameters) must be used for that.
The acceptance of a CreateAttributeRequestItem leads to the creation of a corresponding [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) with a [LocalAttributeShareInfo]({% link _docs_integrate/data-model-overview.md %}#localattributeshareinfo) contained within its `shareInfo` property.
The acceptance of a CreateAttributeRequestItem leads to the creation of a corresponding [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute).
The `content` of the LocalAttribute is the underlying `attribute` of the CreateAttributeRequestItem.
Depending on whether an IdentityAttribute or a RelationshipAttribute is created and the ownership, it is referred to as either an [own shared IdentityAttribute]({% link _docs_integrate/attribute-introduction.md %}#own-shared-and-peer-shared-identityattributes), an [own shared RelationshipAttribute]({% link _docs_integrate/attribute-introduction.md %}#own-shared-and-peer-shared-relationshipattributes) or a [peer shared RelationshipAttribute]({% link _docs_integrate/attribute-introduction.md %}#own-shared-and-peer-shared-relationshipattributes).
Based on the created LocalAttribute, an appropriate AcceptResponseItem of type [CreateAttributeAcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#createattributeacceptresponseitem) is generated, which incorporates the `id` of the LocalAttribute in its `attributeId` property.
Expand Down Expand Up @@ -253,7 +253,7 @@ To view the Response to the Request, proceed as described in the [Query outgoing

The Integrator of the Sender can now get the Response of the Recipient from the `response.content` property of the result.
In the `items` property of the [Response]({% link _docs_integrate/data-model-overview.md %}#response) is a [CreateAttributeAcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#createattributeacceptresponseitem) for each accepted and a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) for each rejected CreateAttributeRequestItem included.
Note that each accepted CreateAttributeRequestItem leads to the creation of an appropriate LocalAttribute with a LocalAttributeShareInfo of the Sender.
Note that each accepted CreateAttributeRequestItem leads to the creation of an appropriate LocalAttribute of the Sender.
The `content` of the [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) is the underlying `attribute` of the [CreateAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#createattributerequestitem).
Depending on whether an IdentityAttribute or a RelationshipAttribute has been created and the ownership, it is referred to as either a [peer shared IdentityAttribute]({% link _docs_integrate/attribute-introduction.md %}#own-shared-and-peer-shared-identityattributes), an [own shared RelationshipAttribute]({% link _docs_integrate/attribute-introduction.md %}#own-shared-and-peer-shared-relationshipattributes) or a [peer shared RelationshipAttribute]({% link _docs_integrate/attribute-introduction.md %}#own-shared-and-peer-shared-relationshipattributes).

Expand Down
Loading