Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(terminology): extended and updated terminology #1653

Closed
wants to merge 6 commits into from
Closed

docs(terminology): extended and updated terminology #1653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6924781
docs: Added all terms out of the spi topic area into the terminology
janpmeyer Jul 6, 2022
4f1e3ca
docs: Added all terms out of the discussion area on GitHub into the t…
janpmeyer Jul 6, 2022
a7ce2e2
docs: add information to the entries
janpmeyer Jul 8, 2022
0eabb6f
docs: improved writing style and changed text for connector and typem…
janpmeyer Jul 12, 2022
cda989b
docs: update changelog
janpmeyer Jul 12, 2022
7c5ceca
docs: updated and deleted entries in cause of suggestion in the pull …
janpmeyer Jul 12, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ in the detailed section referring to by linking pull requests or issues.
* Bump `failsafe` library to version 3.2.4 (#1559)
* Harmonize logics of `HttpDataSource` and `HttpDataSink` (#1475)
* Log correct type in contract-definition API (#1584)
* Extended and updated terminology.md (##1306)

#### Removed

Expand Down
71 changes: 39 additions & 32 deletions docs/overview/terminology.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,41 @@
# Terminology

| Name | Description |
|:--- |:--- |
| **Artifact** |
| **Asset** | **Assets**<p>* have one content type<p>* can be a finite as a (set of) file(s) or non finite as a service, stream</br>* are the _unit of sharing_<p>* can point to one or more (physical) asset elements
| **Asset Element** |
| **Asset Index** | **Asset Index**<p>* manages assets<p>* provided by an extension<p>* may support external catalogs<p>* can be queried
| **Broker** | see **IDS Broker**
| **Connector** |
| **Connector Directory** |
| **Contract** |
| **Contract Agreement** | **Contract Agreement**<p>* points to a **Contract Offer**<p>* results from a **Contract Negotiation Process**<p>* has a start date and may have a expiry date and a cancellation date
| **Contract Negotiation** | * MVP: only possible to accept already offered contracts. Counter offers are rejected automatically.
| **Contract Offer** | **Contract Offer**<p>* set of obligations and permissions<p>* generated on the fly on provider side (see **Contract Offer Framework**)<p>* are immutable<p>* persisted in **Contract Negotiation Process** once the negotiation has started<p>
| **Contract Offer Framework** | **Contract Offer Framework**<p>* generates **Contract Offer Templates**<p>* provided by **Extensions**<p>* may be implemented in custom extensions to created contract offers based on existing systems
| **Contract Offer Template** | Blueprint of a **Contract Offer**
| **Consumer** |
| **Data** |
| **Dataspace** |
| **EDC Extension** |
| **Element** | see **Asset Element**
| **Extension** | see **EDC Extension**
| **Framework** | see **Contract Offer Framework**
| **Identity Provider** |
| **IDS Broker** | IDS version of the **Connector Directory**
| **Offer** | see **Contract Offer**
| **Offer Framework** | see **Contract Offer Framework**
| **Policy** | logical collection of rules
| **Provider** |
| **Resource** |
| **Resource Manifest** |
| **Rule** | **Rules**<p>* bound to a **Contract Offer**, **Contract Agreement** or **Contract Offer Framework**<p>* exist independent from an **Asset**
| **Transfer Process** | **Transfer Process**<p>* based on a **Contract Agreement**
| Name | Description |
|:----------------------------|:--- |
| **Artifact** | The instance of code which can be modulized used by the EDC
| **Asset** | An **asset** describes **data** that can add value to a **dataspace** and contains the **dataAddress**
| **Asset Index** | **Asset Index**<p>* manages assets<p>* provided by an extension<p>* may support external catalogs<p>* can be queried
| **Broker** | see **IDS Broker**
| **Catalog** | The **catalog** is a standalone component of a **dataspace** that stores all meta-information of all **assets** of all **connectors** within a **dataspace** and makes it available to requesting **connectors**.
| **Connector** | **Connector** is the central instance for a participant to join a **dataspace**. The **connector** is the gateway from the user to the **dataspace**.
| **Contract** | **Contract** is the finalized meta-information for a data transfer after a **contract negotiation** including the **policies** who have to be followed
| **Contract Managment** | Includes all parts of **contract offer**, **contract agreement** and **contract negotiation**
| **Contract Agreement** | **Contract Agreement**<p>* points to a **Contract Offer**<p>* results from a **Contract Negotiation Process**<p>* has a start date and may have a expiry date and a cancellation date
| **Contract Negotiation** | * MVP: only possible to accept already offered contracts. Counter offers are rejected automatically.
| **Contract Offer** | **Contract offer**<p>* set of obligations and permissions<p>* generated on the fly on provider side (see **Contract Offer Framework**)<p>* are immutable<p>* persisted in **contract negotiation process** once the negotiation has started<p>
| **Consumer** | see **data consumer**
| **Consumer Pull** | Data transfer is initilazied by the Consumer
| **Data** | **Data** is the representation of information (in particular information about business objects) that can be used for further processing in the field of information technology
| **Data Consumer** | **Data consumer** are receiver of data in a data transfer
| **Data Provider** | **Data providers** produce data and are the source for data in a data transfer
| **DataFlow** | Transfer of **data** from **data producer** to **data consumer**.
| **Dataspace** | A **dataspace** is a space where different participants exchange **data** to get an benifit of this
| **EDC Extension** | A module piece of the EDC which can be customized used for the EDC
| **Event** | An **event** is a action which is be observed in the EDC and published by the **Event Framework**
| **Event Framework** | **The event framework** is a way to react to actions in the EDC and can also be extended
| **Event Router** | **Event router** is the central part of the **event framework**, which collects all published **events**
| **Extension** | see **EDC Extension**
| **Federated Catalog** | The **Federated Catalog** is a decentralized approach implemented directly within the **connectors** to make all meta-information of all **assets** within a **dataspace** available to the **connectors**
| **Health** | Infrastructure status of the EDC
| **Identity Provider** | Management of the correct identification of all participants in the **dataspace**.
| **Offer** | see **contract offer**
| **Policy** | logical collection of rules
| **PolicyDefinition** | **PolicyDefinition** links a policy to 1 ..n assets via logical operations
| **PolicyEngine** | Enforcing of **policies** in the EDC
| **Provider** | The participant in an dataspace who is producing and publish sth. See **Data Provider**
| **Resource** | Infrastructure component for data transmission
| **Resource Manifest** | Collection of **resources**
| **Rule** | **Rules**<p>* bound to a **contract offer**, **contract agreement** or **contract offer framework**<p>* exist independent from an **asset**
| **Transfer Process** | **Transfer process**<p>* based on a **contract agreement**
| **UsageControl** | **Usage Control** is the part of the EDC that is responsible for ensuring that the **policies** for the **data** specified in the **contract** are adhered to.
| **Vault** | Providing secrets