Overview of the current status of all active UDPs

Overview of the current status of all active UDPs

Content

Status

Status

Draft

Requestor

Leipzig

Category

Feature

Start

?

Description

As a user, I would like to be able to check the current status of all active UDPs on one page in order to have a quicker overview. In particular, I would like to see the status of the COUNTER_SUSHI API services when it they are used.

Use case

Many users would like a tabular overview of whether there are any problems with the configuration of the harvesters at the providers. It is intended to offer an alternative to the search function, which only filters the provider list.

Concept 

eUsage > List of usage data providers providers

When you open the eUsage app, the overview of usage data providers is displayed. There is an button Actions at the top right. If you click on the button, options are displayed. An option Show the current statuses is added here.

UDP_Management_Actions.png

When I select this option, a window opens that takes up the entire space on the right. This behavior is similar to the window of the harvester logs overview.

New Overview: Show the current statuses

  • As described, a window opens that takes up the entire space on the right. This behavior is similar to the window of the harvester logs overview.

  • The title Current statuses is displayed at the top of the page.

  • The number of records is displayed below the title of the window. The counter is 0 at the beginning.

  • A table should be displayed on the page and is empty at the beginning.

  • As a user, I would like to be able to press a button Check statuses on this page that triggers a test of the current status of all UDPs. The results are then displayed in the table.

The table should contain the following data.

Column

Description

Column

Description

Provider name

Contains the name of the UDP that the user has assigned in the record.

Harvesting status

Active or Inactive. The status shows whether the reports from the usage data provider are included in the automated, triggered harvesting process.

Service type

If the SUSHI protocol is used to harvest statistics, the protocol currently being used by the harvester should be displayed here.

Service URL

Displays the entered service URL from the UDP record.

Harvested by URL

Shows the complete URL that the harvester uses to retrieve the data.

Result

The result of the test:

  • Active

  • Inactive

  • Cannot connect

  • Harvester is not used

  • Status check not supported

The description follows below the sketch for the table.

  • The number of data records is displayed under the title of the window. It is the number of entries in the table.

  • The results are displayed for as long as the session is active.

  • There will be a feature later that will make this result list exportable.

overview_current_statuses_results.png

Result description

Result

Description

Result

Description

Active

If the value for Service_Active is true in the response from the server, then Active is displayed.

Inactive

If the value for Service_Active is false in the response from the server, then Inactive is displayed.

Cannot connect

If no connection to the server can be established or the URL is incorrect, Cannot connect is displayed

Harvester is not used

If the harvester status is Inactive for a UDP, then Harvester is not used is displayed.

Status check not supported

This check is not available for older versions of Counter. If an older version is used, Status check not supported should be displayed.

Further information

Jira Issues

https://folio-org.atlassian.net/browse/UXPROD-5184

https://folio-org.atlassian.net/browse/DOCS-515