Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "BaSyx / Documentation / Components / Registry / Features / Tagged Directory"
(Created page with "== User Story & Use Case == ''As AAS Components user'' ''I want to tag AAS & Submodel descriptors'' ''so that I can search for combinations of tags without the need of explo...") |
|||
Line 16: | Line 16: | ||
== Feature Configuration == | == Feature Configuration == | ||
− | The TaggedDirectory is disabled by default. It can be | + | The TaggedDirectory is disabled by default. It can be enabled in the registry.properties: |
registry.taggedDirectory=Enabled | registry.taggedDirectory=Enabled | ||
− |
Latest revision as of 02:52, 29 November 2022
User Story & Use Case
As AAS Components user
I want to tag AAS & Submodel descriptors
so that I can search for combinations of tags without the need of exploring the complete AAS & Submodel structure
The tagged directory enables users to perform a discovery of existing AAS & Submodels based on customizable tags. For example, all AAS representing products can be tagged with product.
Feature Overview
This feature enables users to tag AAS Descriptors & AAS Submodels with customizable tags. Tags are arbitrary strings like product, OPC UA or CNC mill. Both AAS Descriptors and Submodel Descriptors can be retrieved by specifying a set of tags. If multiple tags are specified, only descriptors matching all tags are returned.
The TaggedDirectory feature extends the existing HTTP/REST API of the Registry with additional endpoints for working with tags.
Feature Configuration
The TaggedDirectory is disabled by default. It can be enabled in the registry.properties:
registry.taggedDirectory=Enabled