Skip to content

Commit d50ee2b

Browse files
committed
Fix dead links in example readme
1 parent 15e6d2f commit d50ee2b

File tree

1 file changed

+21
-39
lines changed

1 file changed

+21
-39
lines changed

examples/README.md

+21-39
Original file line numberDiff line numberDiff line change
@@ -20,61 +20,57 @@ Example [TEXT_RESOURCE](TEXT_RESOURCE.ttl) is based on the [DATA1](DATA1.ttl) ex
2020

2121
## Example DATA2: Free download of raw, historical data
2222

23-
The resource example [DATA1](DATA1.ttl) illustrates an easy, non-interactive access to historical data provided by the participant [PART1](PART1.ttl). The monthly traffic statistics collected during a year since 2000 are exposed for download as individual files (“artifacts”) via the Trusted Connector [CONN2](CONN2.ttl). The file names (e.g., `E1_20000101.csv`) encode by convention the discriminating parameters, i.e. the highway (e.g., `E37`), year (e.g., `2018`), month (e.g., `01`). The reports comprise tabular data in CSV format. The data may be used free of charge, the policy requires a credits
23+
The resource example [DATA1](DATA1.ttl) illustrates an easy, non-interactive access to historical data provided by the participant [PARTICIPANT_1](PARTICIPANT_1.ttl). The monthly traffic statistics collected during a year since 2000 are exposed for download as individual files (“artifacts”) via the Trusted Connector [CONNECTOR_2](CONNECTOR_2.ttl). The file names (e.g., `E1_20000101.csv`) encode by convention the discriminating parameters, i.e. the highway (e.g., `E37`), year (e.g., `2018`), month (e.g., `01`). The reports comprise tabular data in CSV format. The data may be used free of charge, the policy requires a credits
2424
attribution though.
2525

2626
## Example DATA3: On-line data query
2727

28-
Example [DATA2](DATA2.ttl) introduces simple interactive features allowing the consumer to selectively retrieve content beyond the constraints of server-defined contents as in example [DATA1](DATA1.ttl) (e.g. statistics for a highway section across several years).
28+
Example [DATA3](DATA3.ttl) introduces simple interactive features allowing the consumer to selectively retrieve content beyond the constraints of server-defined contents as in example [DATA1](DATA1.ttl) (e.g. statistics for a highway section across several years).
2929

30-
## Example APP1: Data App for content integration (system adapter)
30+
## Example APP_RESOURCE: Data App for image anonymization
3131

32-
The photographs taken by a surveillance camera are injected into the mobile Connector environment [CONN1](CONN1.ttl) by means of the Data App [APP1](APP1.ttl) serving as a technology adapter. It implements a camera driver that accesses the raw digital content and exposes still images in various representations via a defined interface.
33-
34-
## Example APP2: Data App for image anonymization
35-
36-
The image content provided by [APP1](APP1.ttl) have to be anonymized prior to being forwarded to a Data Consumer. The Data App [APP2](APP2.ttl) accepts images of standard traffic scenarios in various file formats (e.g. PNG, JPG) recorded in compliance with the international norm [IEC 62676-4:2014](https://webstore.iec.ch/publication/7353). It is trained to locate particular personal information (e.g., the license plate of a car) and to apply image
37-
processing techniques to irreversibly obfuscate this information. The Data App is likewise deployed within the Mobile Connector [CONN1](CONN1.ttl), i.e. at the source of image recording, in order to prevent the disclosure of unprocessed content.
32+
The Data App [APP_RESOURCE](APP_RESOURCE.ttl) accepts images of standard traffic scenarios in various file formats (e.g. PNG, JPG) recorded in compliance with the international norm [IEC 62676-4:2014](https://webstore.iec.ch/publication/7353). It is trained to locate particular personal information (e.g., the license plate of a car) and to apply image
33+
processing techniques to irreversibly obfuscate this information. The Data App is likewise deployed within the Mobile Connector [CONNECTOR_1](CONNECTOR_1.ttl), i.e. at the source of image recording, in order to prevent the disclosure of unprocessed content.
3834

3935
# Infrastructure components
4036

41-
## Example CONN1: Mobile, base connector
37+
## Example CONNECTOR_1: Mobile, base connector
4238

43-
Connectors are the central building blocks, the edge nodes of the IDS network. The example Connector [CONN1](CONN1.ttl) is deployed on a mobile sensor platform located close to a traffic hot spot. It hosts a data processing pipeline where image data received form APP1 is fed into APP2.
39+
Connectors are the central building blocks, the edge nodes of the IDS network. The example Connector [CONNECTOR_1](CONNECTOR_1.ttl) is deployed on a mobile sensor platform located close to a traffic hot spot.
4440

45-
## Example CONN2: Trusted connector
41+
## Example CONNECTOR_2: Trusted connector
4642

47-
The Trusted Connector [CONN2](CONN2.ttl) represents a hardened version of the Connector runtime, a certified platform for data integration, processing and publishing maintained by the participant [PART1](PART1.ttl) as part of its data provisioning infrastructure.
43+
The Trusted Connector [CONNECTOR_2](CONNECTOR_2.ttl) represents a hardened version of the Connector runtime, a certified platform for data integration, processing and publishing maintained by the participant [PARTICIPANT_1](PARTICIPANT_1.ttl) as part of its data provisioning infrastructure.
4844

4945

5046
## Example TRUSTED_CONNECTOR: Trusted connector
5147

52-
The TRUSTED_CONNECTOR [TRUSTED_CONNECTOR](TRUSTED_CONNECTOR.ttl) is based on the [CONN2](CONN2.ttl) example with additional comments.
48+
The TRUSTED_CONNECTOR [TRUSTED_CONNECTOR](TRUSTED_CONNECTOR.ttl) is based on the [CONNECTOR_2](CONNECTOR_2.ttl) example with additional comments.
5349

5450

55-
## Example BROKER1: Logistics broker
51+
## Example BROKER: Logistics broker
5652

57-
Because of the vast amount of resources a dedicated Broker for the "logistics domain" is operated by the service provider [PART2](PART2.ttl). Next to a customer-oriented GUI the data registry exposes a series of service interfaces (APIs) for lif-cycle management (publication,updated, removal) and search of content offerings.
53+
Because of the vast amount of resources a dedicated Broker for the "logistics domain" is operated by the service provider [PARTICIPANT_2](PARTICIPANT_2.ttl). Next to a customer-oriented GUI the data registry exposes a series of service interfaces (APIs) for lif-cycle management (publication,updated, removal) and search of content offerings.
5854

59-
## Example APPSTORE1: General purpose AppStore
55+
## Example APPSTORE: General purpose AppStore
6056

61-
The example AppStore [APPSTORE1](APPSTORE1.ttl) maintains metadata and software resources across IDS communities and providers. The software company PART2 advertises and distributes
62-
its Data Apps (e.g. APP2) via that registry.
57+
The example AppStore [APPSTORE](APPSTORE.ttl) maintains metadata and software resources across IDS communities and providers. The software company PARTICIPANT_2 advertises and distributes
58+
its Data Apps (e.g. APP_RESOURCE) via that registry.
6359

6460
# Participants
6561

66-
## Example PART1: European traffic data provider)
62+
## Example PARTICIPANT_1: European traffic data provider)
6763

68-
The hypothetical "Highway monitoring and statistics agency" acts as a data provider [PART1](PART1.ttl). It maintains a large-scale infrastructure for monitoring, analysis and prediction of highway utilization statistics in European context. The agency has deployed a range of mobile connectors (e.g. CONN1) for distributed collection and publication of geotagged, regional sensor data, likewise a secure connector (CONN2) for sharing valuable statistics
64+
The hypothetical "Highway monitoring and statistics agency" acts as a data provider [PARTICIPANT_1](PARTICIPANT_1.ttl). It maintains a large-scale infrastructure for monitoring, analysis and prediction of highway utilization statistics in European context. The agency has deployed a range of mobile connectors (e.g. CONNECTOR_1) for distributed collection and publication of geotagged, regional sensor data, likewise a secure connector (CONNECTOR_2) for sharing valuable statistics
6965
reports and predictions.
7066

7167

72-
## Example PART2: Software development and service provision
68+
## Example PARTICIPANT_2: Software development and service provision
7369

74-
The participant App4Traffic GmbH ([PART2](PART2.ttl)) provides a wide range of software development, consultancy and data hosting services and thus implements multiple roles within the IDS ecosystem. Based in Switzerland (Musterstraße 2, Zürich) the SME develops and distributes IDS Data Apps (e.g. APP1) and serves
75-
customers like PART3 with advanced analytics services based upon data from PART1.
70+
The participant App4Traffic GmbH ([PARTICIPANT_2](PARTICIPANT_2.ttl)) provides a wide range of software development, consultancy and data hosting services and thus implements multiple roles within the IDS ecosystem. Based in Switzerland (Musterstraße 2, Zürich) the SME develops and distributes IDS Data Apps and serves
71+
customers like PARTICIPANT_3 with advanced analytics services based upon data from PARTICIPANT_1.
7672

77-
## Example PART3: Global logistics company
73+
## Example PARTICIPANT_3: Global logistics company
7874

7975
The international "Supercargo Logistics" company provides services around the globe with subsidiaries in a number of countries, among others Supercargo GmbH - headquarters - (Musterstraße 5, Köln, Deutschland), Supercargo OOO (Yлица пример 120, Москва), and Supercargo Ltd. (Sample Road 15c, Hongkong).
8076
Their businesses are thus subject to international, national and optionally some custom regulations (legal areas). The organization complies with the ISIC classification rev. 4 and has ISIC code 4923 (freight transport via road). The company retrieves live traffic monitoring data, in order to supply its drivers with up-to-date traffic information, efficient routing and timely hazard warnings.
@@ -83,17 +79,3 @@ Their businesses are thus subject to international, national and optionally some
8379

8480
In the following examples of business interactions among participants are given. The realization of the core IDS value propositions (secure data transfer between standardized components while ensuring data sovereignty) is supported by interactions (e.g. data transfer) annotated with metadata (instances of the `Message` class in the header part). Metadata descriptions of content being exchanged are mandatory. Therefore, the IDS infomodel introduces a concise set of message types specifying metadata fields that must/should/can be given in order to
8581
facilitate the business interactions.
86-
87-
## Example INTER1: Connector registration at Broker (stable)
88-
89-
The example [INTER1](INTER1.ttl) showcases the publication of Resources as part of the overall "self-description" of a Connector.
90-
Connector CONN2 registers at the Broker INFRA1 by dispatching a dedicated message to the generic Message-API of the Broker (`ConnectorAvailable`). Next to the mandatory fields, the message header identifies the consumer connector (Broker). The message payload comprises the complete "self-description"
91-
document of the registering Connector, i.e., the content of [CONN2](CONN2.ttl) in JSON(-LD) format (default).
92-
93-
## Example INTER2: Broker search and identification of content offerings (stable)
94-
95-
Later on the Connector CONN2 may issue queries on the Broker to learn about Resources available ([INTER2](INTER2.ttl)). For this purpose it dispatches a dedicated request message (`BrokerQuery`), indicating the target scope of the query ("all", or only "active", i.e. live connectors) and the query language
96-
type. The respective query string is supplied as the literal payload. In case of a SPARQL this might be a DESCRIBE_QUERY, e.g. ```DESCRIBE ?content WHERE { ?content a ids:Content }``` retrieving information about any content available. Upon request completion, a Result message is sent back to the issuing connector CONN2. The Result message is fairly minimal containing only the mandatory fields and a correlation attibute referring to the previously sent request. The resultant payload is an RDF graph serialized as a default or client-selected Representation.
97-
98-
## Example INTER3: Contract negotiation of the selected contents
99-
Example [INTER3](INTER3.ttl) illustrates the message exchange in order to negotiate a usage contract.

0 commit comments

Comments
 (0)