Integrate provider list from COUNTER Registry
Content
- 1 Description
- 2 API endpoints
- 3 Further information
- 3.1 Jira Issues
- 3.2 Links
Status
Discussion status | open - To be discussed |
Requestor | Leipzig |
Category | Feature |
FOLIO Release | Umbrellaleaf |
The user story is currently being created and discussed
Description
There is a COUNTER registy in which provider data is stored. See: https://registry.countermetrics.org/
As a user, I would like to be able to select a provider from a selection list in eUsage when creating or editing a record of a usage data provider (UDP) so that I can have its configuration data transferred to the form fields that are stored in the COUNTER registry. If a provider is selected from this integrated selection list, the corresponding configuration data of the provider is transferred to the input fields. The transferred data can still be edited if required.
Use case
When entering data manually into form fields, typing errors can occur. This feature is designed to help prevent such errors. It should also make the process of creating or editing easier.
Concept
Application eUsage
When creating or editing a UDP data record in the eUsage user interface, you can choose between profiles for providers in a selection list. These are a kind of templates.
The options of the selection list are the platform names of the providers as stored in the counter registry.
The profiles are loaded from the Counter registry via API during runtime. If necessary, the data will be stored at a later point in time within eUsage if it is not practical to retrieve the data during the runtime.
eUsage > UDP > Create / Edit mode
Label of the selection list: Counter registry profile. Would you prefer a different label?
Options: platform names of the providers as stored in the counter registry.
Filter function: There should be a filter function so that the user can quickly find the desired profile.
If a provider is selected from the selection list, the corresponding configuration data of the provider is transferred to the input fields. At the same time, certain selections are set automatically.
Provider name = Platform name from the Counter registry
Provider status = Active
Harvesting status = Active
Harvest statistics via = Counter / Sushi
Service type
Default value is changed to Counter 5.1
Service URL = Service url from the Counter registry for Counter 5.1 . As soon as the user changes the service type to Counter 5.0, the setting also changes accordingly. It should be the same base URL, but this should be explicitly taken over from the Counter registry.
The transferred data can still be edited if required.
Application Settings (optional)
OPTIONAL
If necessary, the data will be stored at a later point in time within eUsage if it is not practical to retrieve the data during the runtime.
Additional menu item
eUsage settings with an additional menu item Sources for the provider list in the section General
Functions within the new “Sources for the provider list” menu item
Creating entries
Creating entries with predefined sources (hardcoded) via the button + New
Fields for creating a entry
Name
Status (Default setting is Active)
Service
Hardcoded, because the end points can be different and the program must interpret the response correctly. There is currently no standard. If a standard exists, you could have the endpoints created yourself.
Must be discussed
Update interval
Start date
Start time
Periodic interval
Informations and possible actions in the overview of created entries
Name
Service
Status
Last update
Actions
Edit entry
Delete entry
API endpoints
https://registry.countermetrics.org/api/v1/
https://registry.countermetrics.org/api/v1/platform/
Please note:
sushi_servicesis an object (array) that contains the keyscounter_releaseandurlfor each Counter release. Theurlkey refers to an additional data record in which the service URL of the provider is stored.