JCR - Journals API

Rejestracja

Kroki do wykonania w celu uzyskania dostępu:

Jeżeli klient ma już zarejestrowaną aplikację (bo korzysta już np. z API Starter) to może pominąć kroki 1-2 i przejść do aktywacji Web of Science Journals API - krok 3.

1. Pierwszym etapem jest rejestracja w portalu dewelopera Clarivate https://developer.clarivate.com/, przy wykorzystaniu adresu służbowego (nakierowuje on na instytucję zgłoszoną do licencji krajowych)

2. Na etapie rejestracji aplikacji należy

stworzyć Application ID
stworzyć Application Name
podać krótki opis wykorzystania API (celem w Omedze jest zbieranie danych o cytowaniach publikacji)
w polu Client Type należy wskazać Public Clients: Single Page Applications
pole This application will use OAuth2.0 Flows powinno pozostać odznaczone

3. Po zarejestrowaniu aplikacji należy zasubskrybować Web of Science Journals API, czyli przejść do zakładki “APIs” i z listy wybrać Web of Science Journals API, a następnie na wyświetlonej stronie w obszarze “Applications” kliknąć “Subscribe”.

4. Po pomyślnie zakończonej rejestracji klucz dostępu powinien przyjść w oddzielnej wiadomości mailowej.

W przypadku jakichkolwiek trudności należy kontaktować się drogą mailową z działam wsparcia Clarivate na adres WoSG.support@clarivate.com. Mail należy wysłać również do wiadomości przedstawiciela Clarivate p. Marcina Kapczyńskiego (marcin.kapczynski@clarivate.com), co przyspieszy weryfikację i potwierdzenie, że dostęp dla instytucji został wykupiony zgodnie z umową między jednostką a Clarivate.

Instalacja

Chęć instalacji integratora należy zgłosić przez Jirę. Sages instaluje aktualną wersję integratora. Należy pamiętać o kompatybilności wersji integratora i Omegi.

Konfiguracja

Dane dostępowe

Dane dostępowe (token) należy wprowadzić do modułu konfiguracji z systemami zewnętrznymi Funkcje Administracyjne → Integracja z systemami zewnętrznymi - konfiguracja:

Jeżeli moduł Integracja z systemami zewnętrznymi - konfiguracja nie jest dostępny, należy aktywować przełącznik model.systemconfiguration

Dane wprowadzamy do już istniejącego rekordu lub tworzymy nowy.

Pole Token (JCR) musi być uzupełnione, pozostałe pola mogą pozostać puste. Zapisujemy zmiany w rekordzie.

Dane słownikowe i algorytm punktacji

Integrator wykorzystuje słowniki systemowe:

Identyfikator WoS,
Impact Factor WoS,

słowniki niesystemowe:

Kwartyl JIF,
Wartość kwartyla JIF,
Mediana JIF,
Wartość mediana JIF,

oraz algorytm punktacji:

IFWoS (reguły indicatorrules.drl lub implementacja bezpośrednio w javie),
Kwartyl IF (regułyjifindicatorrules.drl lub implementacja bezpośrednio w javie),
Mediana IF (brak .drl - implementacja bezpośrednio w javie).

Należy upewnić się że:

wszystkie dane słownikowe i algorytm punktacji są dostępne w systemie

publications.indicators.JIFQuartile - JIF kwartyl
publications.indicators.JIFMedian - JIF median

Automatyczna aktualizacja wskaźników

Zadania cykliczne są wgrywane wraz z instalacją integratora.

Możliwa jest automatyczna, cykliczna aktualizacja wybranych czasopism przy pomocy zadań cyklicznych:

update_jcr_indicators

Starsza wersja skryptu - zalecamy korzystać z dwóch pozostałych.

Skrypt aktualizuje statystyki czasopism, których identyfikatory (Omegowe id) są umieszczone w pliku CSV. Po uprzednim przygotowaniu pliku csv , skrypt najpierw wykonuje proces dopasowywania i zapisu Identyfikatora WoS do rekordu czasopism, następnie po dopasowaniu zostaje rozpoczęty import wskaźników do czasopism.

W zadaniu cyklicznym można nadpisać domyślnie zdefiniowane wartości parametrów:

Po zakończaniu działa skryptu można przejrzeć log z jego działania:

Import WoS JCR identifiers

Wykonuje proces dopasowywania i zapis Identyfikator WoS do czasopisma. Scheduler na wstępie odfiltrowuje journalseries i aktualizuje tylko te rekordy, które nie mają Identyfikatora WoS oraz mają uzupełnione pole issn, eissn, otherissn.

Import WoS JCR indicators

Wykonuje import wskaźników na podstawie Identyfikatora WoS czasopisma. Scheduler na wstępie odfiltrowuje journalseries i aktualizuje tylko te rekordów, które mają Identyfikator WoS.

W zadaniu cyklicznym można nadpisać domyślnie zdefiniowane wartości parametrów:

Zakres lat, których ma dotyczyć aktualizacja, konfigurujemy edytując parametry:

yearFrom - rok początkowy dla wskaźników,
yearTo - rok końcowy dla wskaźników,
przykładowe wartości: 2023, currentYear-2, previousYear

Domyślnie zadanie cykliczne aktualizuje dane wskaźników z roku poprzedniego. Jest to określone w skrypcie wartościami previousYear powyższych zmiennych.

Ręczna aktualizacja wskaźników

API JCR ma narzucone ograniczenia - zwraca max 5 zapytań na sekundę.

Przycisk pozwalający przejść na panel integracji pojawi się po prawidłowej instalacji i konfiguracji integratora w rozwijanej liście na podglądzie listy czasopism:

Przycisk widoczny jest dla użytkowników z uprawnieniami:

admin
superdataentry + journalseries
dataentry + journalseries

Z panelu dla wybranych wcześniej czasopism można wykonać:

import identyfikatorów WoS JCR,
import statystyk z WoS JCR.

Import identyfikatorów WoS JCR

Import identyfikatorów WoS JCR jest obsługiwany na pierwszej zakładce w panelu integracji dla wcześniej wybranych czasopism z listy głównej:

Czasopisma są dopasowywane na podstawie pól issn, eissn i otherIssn. Próba importu identyfikatorów dla czasopisma nastąpi tylko wtedy gdy jedno z ww. pól nie będzie puste oraz w rekordzie nie będzie już zapisanego identyfikatora WoS JCR.

Przykładowo dla czasopisma z numerami:

Integrator zbuduje zapytanie i w przypadku prawidłowego dopasowania integrator otrzyma 1 lub więcej identyfikatorów z WoS (więcej np. gdy czasopismo zmieniło nazwę, ale ISSN pozostał ten sam) i zapisze pierwszy z nich w polu extid o typie Identyfikator WoS:

W przypadku braku słownika Identyfikator WoS identyfikator nie zostanie zapisany. Należy zaimportować słownik do Omegi - patrz Konfiguracja → Dane słownikowe.

Po skończonym imporcie pojawi się tabela z podsumowaniem:

Dostępne statusy:

UPDATE - system zaktualizował czasopismo o identyfikator WoS,
NOT_FOUND - system wykonał zapytanie do WoS JCR API, jednak nie dopasowano żadnego czasopisma więc identyfikator WoS nie został zapisany,
SKIP - system pominął dany rekord ze względu na to że pola issn, eissn, otherIssn są puste, lub czasopismo ma już wpisany identyfikator WoS,
ERROR - błąd systemu.

Import statystyk z WoS JCR

Importu statystyk z WoS JCR jest obsługiwany na drugiej zakładce w panelu integracji dla wcześniej wybranych czasopism z listy głównej:

Import wykonywany jest tylko dla czasopism posiadających Identyfikator WoS. W pierwszej kolejności pobierane są szczegółowe dane czasopisma, następnie wykonywane są zapytania dla poszczególnych lat. Na tej podstawie w systemie zapisywane są wskaźniki w podziale na poszczególne lata: