-
Notifications
You must be signed in to change notification settings - Fork 3
Setting FCS Resources
Eliza Margaretha Illig edited this page Jun 4, 2025
·
2 revisions
Resources and virtual corpora (VC) provided for CLARIN Federated Content Search (FCS) must be listed in a resources.json file. The file must be located at the data folder. By default, Kustvakt uses the resources.json file at /src/main/resources/data.
| Property | Required | Description | Example |
|---|---|---|---|
| id | yes | The resource or VC identifier must contain at least 3 characters. It will be stored in the query database table and is used as a reference to a VC, for instance when searching on a specific VC. | WPD17 |
| pid | yes | Ideally the persistent identifier link of a resource stored in a repository. It is required to describe a resource or a match in FCS. | http://hdl.handle.net/10932/00-03B6-558F-4E10-6201-1 |
| de_title | no | The resource or VC name in German. | Deutsche Wikipedia Artikel 2017 |
| en_title | yes | The resource or VC name in English. | German Wikipedia Articles 2017 |
| en_description | no | The description of the resource or VC in English. | A collection of articles of German Wikipedia from July 1st, 2017. |
| layers | yes | The annotation layers available for the resource or VC in KorAP. | ["corenlp/p","marmot/m","marmot/p", "opennlp/p","tt/l","tt/p"] |
| corpus_query | yes | The resource or VC definition by metadata filtering. | corpusSigle=WPD17 |
| required_access | no | The permission level required to access a resource or VC. Kustvakt can determine the required access using the corpus_query. |
FREE, PUB, or ALL |
| institution | no | The name of the institution that has built or owns the resource. | IDS Mannheim |
[{
"id": "WPD17",
"pid": "http://hdl.handle.net/10932/00-03B6-558F-4E10-6201-1",
"de_title" : "Deutsche Wikipedia Artikel 2017",
"en_title" : "German Wikipedia Articles 2017",
"en_description" : "A collection of articles of German Wikipedia from July 1st, 2017.",
"layers": [
"corenlp/p",
"marmot/m",
"marmot/p",
"opennlp/p",
"tt/l",
"tt/p"
],
"corpus_query":"corpusSigle=WPD17",
"required_access" : "FREE",
"institution" : "IDS Mannheim"
},
{
"id": "Romane",
"pid": "Romane",
"en_title": "Roman",
"layers": [
"corenlp/p",
"marmot/m",
"marmot/p",
"opennlp/p",
"tt/l",
"tt/p"
],
"corpus_query": "textType = /.*[Rr]oman/",
}
]
- Setting LDAP
- Setting initial super client
- Setting a custom environment
- Setting resources for CLARIN FCS
- Disabling query rewrites
- Named virtual corpora
- Importing Kustvakt to Eclipse
- Installing Lombok
- Setting annotation processors
- Setting a test environment
- HTTP Basic Authentication
- OAuth2 authorization scopes
- OAuth2 authorization request
- OAuth2 token request
- OAuth2 token revocation
- OAuth2 client registration
- OAuth2 client info
- OAuth2 client deregistration
- OAuth2 client secret reset
- Plugin registration
- Plugin list (marketplace)
- Plugin installation
- Plugin uninstallation
- Installed plugin list
- VC creation and update
- VC deletion
- VC list
- VC info
- VC KoralQuery
- VC statistics
- VC statistics with KoralQuery