5 – A Provider adds, updates, or withdraws a data-, application-, or infrastructure resource on the Dataspace’s Catalogue
Description
To help understand the content of this document, readers should familiarize themselves with the key definitions and actors and the business process introduction containing the diagram legend.
This Business Process describes the publication and updating of resources on the dataspace's catalogue. Providers supply Resource Descriptions which may include access policies, usage policies and Usage Contract templates. Resource Descriptions can refer to data, applications, or infrastructure. These descriptions are validated for the correctness of syntaxes, semantics, and compliance with quality standards defined by the Governance Authority. Providers receive feedback on these validations. Once validated, the descriptions are published to the catalogue, making resources discoverable and accessible by other dataspace Participants.
When updating a resource, it is important to consider that Resource Descriptions are immutable because they have unique signatures assigned at the time of creation. This immutability ensures the integrity and consistency of the resource, preventing unauthorised changes. As a result, updating a resource involves deprecating the old version and uploading a new version with a new immutable signature.
The following actors are involved in the current process: Governance Authority and Provider.
Prerequisites business process:
The following prerequisites must be met to enable the process to occur:
- Provider Onboarded: Before the Provider can add any resources to a dataspace, they should have successfully completed the onboarding business process (Business Process – 3A).
- End User Authenticated & Authorised: The End User is authenticated and has the appropriate role and permissions to perform the steps in the process (Business Process – 3B).
- Schemas Provided: The Governance Authority has defined and made available schemas for the different types of resources descriptions. These schemas may refer to vocabularies also available in the dataspace. Moreover, the Governance Authority has defined quality rules that will add further restrictions on acceptable Resource Descriptions so that their quality is guaranteed.
- Resources registered at data space connector: The data space connector is the component to control and ensure data exchange via the dataspace protocol (DSP). Hence the resource must be registered as asset first to define the contract negotiation id needed for the resource descriptions to start contract negotiation.
Business Process Diagram & Steps
This chapter presents a diagram visualising the business process, labelled with specific steps. Each step is further detailed in the accompanying 'Step Description'.
Step Description:
Below there is a detailed description of the steps involved in this business process. Each step outlines the specific actions and decisions required to successfully complete the process:
- Select publish, update or withdrawal of a resource: The Provider decides whether to publish a new resource, update an existing resource in the dataspace catalogue, or withdraw an existing resource in the dataspace catalogue. This step initiates the process and sets the context for the subsequent actions.
- Create Resource Description: The Provider fetches schemas which describe the mandatory and recommended fields provided by the data Governance Authority. Based on the schema retrieved, the Provider can create the description of the resource.
- Provide additional resource specific information: To fully describe data, application, and infrastructure resources, additional resource-specific information is required. The specific details within the resource schema may vary depending on the resource type. For example:
- Data Resources may require: Data Provenance, Format under which the data is distributed, Schema of the dataset, Related datasets, Target users, Data Quality, Encryption, and Anonymisation/Pseudonymisation.
- Application Resources may require: Application package, Application link, Format under which the application is distributed, Target users, Requirements on the runtime environment, and URL or file of the documentation on how to use the application.
- Infrastructure Resources may require: Resource Type, Region and availability zone. Size and capacity, Operating system and image, Network configuration, Security settings, Instance type, Storage type, Backup and redundancy, Scalability options, Monitoring and logging, Tags and metadata, and External URL.
- Additionally, Providers may choose to assign further information, such as access policies, usage policies, Usage Contract template details, and more, to these resources.
- Validate syntax: The Resource Description is validated on the correctness of the included syntaxes (e.g., specific format and structure rules) on the Provider side.
- Passed Validation?: If the syntax is successfully validated, then the process continues to step 8. If syntax does not pass validation, then the process returns to step 6.
- Remediate issues: After the Provider receives the error report, the Provider can correct the errors, and reverts to step 2 for the 'Create Resource Description' process and step 14 for the 'Modify Resource Description' process.
- Sign & submit Resource Description: The description is digitally signed by the Provider and sent to the Governance Authority for validation.
- Validate semantics: The Resource Description is semantically validated against the relevant vocabularies and constraints defined in the schema by the Governance Authority.
- Passed Validation?: If semantics is successfully validated, then the process continues to step 10. If sematics does not pass validation, then the process returns to step 6.
- Validate quality rules: The Resource Description is validated against the quality rules (and compliance-specific rules for the applications) defined by the Governance Authority.
- Passed Validation?: If the quality is successfully validated, then the process continues to step 12 in case a resource is newly published, and to step 16 when a resource is updated. If the quality does not pass validation, then the process goes to step 6.
- Publish the resource description: Once all validations are successfully completed, the Resource Description of the resource is published on the dataspace catalogue, making it discoverable to other Participants (Business Process – 06).
- Retrieve the current Resource Description and prefilled template: The Provider requests the current Resource Description and the current Resource Description Schema from the registry.
- Modify Resource Description: Based on the schema retrieved, the Provider can modify the Resource Description. The Provider will always use the latest version of the schema even if it is different from the schema of the original Resource Description.
- Modify additional resource specific information: The Provider can modify various types of information that is provided in the description, which are described in step 3.
Deprecate previous version of resource description: The Governance Authority automatically deprecates the current Resource Description after the new Resource Description is fully validated.
- Publish the updated resource description: The updated Resource Description of the resource is published on the dataspace catalogue, making it discoverable to other Participants (Business Process – 06).
- Request to revoke the published resource: The Provider signals the Governance Authority to revoke the published resource from the catalogue.
- Withdraw resource description: The Governance Authority withdraws the resource description from the Dataspace's Catalogue.
- Inform Consumers of the resource about the update/revocation: In the event a resource is updated or revoked, Consumers with an active contract are notified by the Governance Authority.
| L0 - Business Process | Status: Proposed |
Associated L1s - High Level Requirements
5.1 - Application sharing - Handling the execution
Simpl shall support application sharing.5.2 - Application sharing - Instructions sharing
Simpl shall make the application usage instructions available.5.3 - Application sharing - Validation
Simpl shall manage the validation logic related to uploading an app to the catalog.5.4 - Enable and enforce usage policies - Assignment of a policy
Simpl shall provide a mechanism to define new usage policies in ...5.5 - Enable and enforce usage policies - Definition of a policy
Simpl shall provide a mechanism to define new usage ...5.6 - Onboarding new dataset - Providing self-description
The Data Provider shall provide the characteristics ...5.7 - Removing the self-description of a Dataset
Simpl shall, at any moment, give the Data Provider the possibility ...5.8 - Subscription to a data/application/infrastructure - Provider
A data/application/infrastructure Consumer can at any moment stop...5.9 - Validation of metadata onboarding - syntax, semantic and quality
Simpl shall verify the syntax, semantic and quality rules when onboarding ...5.10 - Assign Contract Template
Simpl shall support providers to assign a contract template to ...5.11 - Access policy
Simpl shall provide a UI and API through which ...
Moderator note: Comments are from the previous discussion platform.
Submitted by Marleen Valkenburg on Thu, 04/04/2024 - 11:41
The current description of this L0 is high-over, where I think it could use some information on how Data, Application and Infrastructure are defined and the role. Looking forward to the respective L1 and L2 requirements to get more details.
Please log in or sign up to comment.