Dodawanie schematu źródła danych REST przy użyciu kreatora wykrywania schematów

Dla źródła danych REST można utworzyć schemat źródła danych. Tworzenie schematów upraszcza tworzenie treści szablonów dokumentów dla modułów o tej samej strukturze i takiej samej lub podobnej liście atrybutów.

O tym zadaniu

Podczas korzystania z kreatora Wykrywanie schematu w celu utworzenia schematów źródeł danych można wybrać jedną z dwóch opcji usług REST możliwości raportowania, które mogą być obsługiwane przez aplikację użytkownika - interfejs API REST 1.0 lub API REST 2.0. Należy skontaktować się z administratorem systemu, jeśli nie jest znana wersja interfejsu API REST obsługiwana przez aplikację.

Wykrywanie schematu (interfejs API REST 1.0)

Procedura

  1. W programie Document Studio kliknij opcję Dane > Wykrywanie schematu > Wykrywanie schematu REST.
  2. Podaj szczegóły połączenia:
    1. W polu Nazwa wprowadź nazwę źródła danych.
    2. W polu Opis wprowadź opis źródła danych.
    3. W polu Podstawowy adres URL określ podstawowy adres URL zasobu.
    4. Z listy Typ uwierzytelniania wybierz odpowiedni typ. W przypadku braku wyboru typu zostanie przetestowany każdy typ aż do momentu znalezienia poprawnego typu. Określenie typu pozwala na wyeliminowanie tego procesu.
    5. Jeśli zasób znajduje się na zabezpieczonym serwerze, podaj nazwę użytkownika w polu Użytkownik.
    6. Jeśli zasób znajduje się na zabezpieczonym serwerze, podaj hasło w polu Hasło.
  3. Kliknij przycisk Dalej.
  4. W zależności od tego, czy źródło danych korzysta z usług danych, zostanie wyświetlone jedno z następujących okien:

    Jeśli źródło danych nie korzysta z usług danych, zostanie wyświetlone okno Tworzenie zasobu.

    1. W polu Nazwa wprowadź nazwę nowego zasobu.
    2. W polu Opis wprowadź opis nowego zasobu.
    3. W polu Ścieżka względna wprowadź ścieżkę względną dla nowego zasobu.
    Jeśli źródło danych REST jest dostępne za pośrednictwem adapterów usług danych raportowania, zostanie wyświetlone okno Znajdowanie za pomocą usługi danych.
    1. Wybierz element w drzewie schematów XML.
    2. Wybierz z listy atrybutów wartość href.
    3. Kliknij przycisk Dalej. Zostanie wyświetlony adres URL wybranego zasobu.
  5. Wybierz adres URL i kliknij przycisk Zakończ lub użyj adresu URL do znalezienia zasobu potomnego. Aby znaleźć zasób potomny:
    1. Wybierz adres URL zasobu i kliknij przycisk Dalej.
    2. Wybierz element na panelu schematów XML.
    3. Z listy atrybutów wybierz atrybut href.
  6. W przypadku znalezienia zasobu potomnego kliknij przycisk Zakończ. Praca kreatora zostanie zakończona i adres URL zostanie wyświetlony w oknie konfiguracji. Wprowadź nazwę użytkownika i hasło w oknie konfiguracji, jeśli zasób znajduje się na zabezpieczonym serwerze.

Wykrywanie schematu (interfejs API REST 2.0)

O tym zadaniu

Uwaga: Produkt Rational Publishing Engine obsługuje tylko skróconą wersję metody RDF. Dostawcy muszą akceptować i uznawać żądania application/xml. Należy zapoznać się z informacjami na stronie Open Services for Lifecycle Collaboration Core Specification Version 2.0 (Specyfikacja modułu podstawowego usług Open Services for Lifecycle Collaboration 2.0).
Produkt Rational Publishing Engine obsługuje tylko dostawców usług OSLC 2 zgodnych ze specyfikacją usług REST możliwości raportowania w wersji 2.
  • Usługa OSLC musi mieć możliwości zapytania zdefiniowane w zasobie usługi dla wszystkich zasobów przeznaczonych do raportowania.
  • Każda możliwość zapytania dla raportowania musi mieć następujące właściwości:
    • Właściwość oslc:queryBase wskazującą zasób mający listę zasobów przeznaczonych do raportowania. Zasoby na tej liście muszą być identyfikowane jako elementy oslc:ismemberproperty w zasobie kształtu zasobu listy.
    • Właściwość oslc:resourceshape do opisu zasobu listy.

Procedura

  1. Kliknij opcję Dane > Wykrywanie schematu > Wykrywanie schematu REST 2.
  2. Podaj szczegóły połączenia:
    1. W polu Podstawowy adres URL określ podstawowy adres URL zasobu.
      Użytkownik musi znać adres URL dostawcy usług, który ma zostać zaakceptowany. Ten adres URL jest odpowiednikiem adresu URL aplikacji usług danych raportowania dla źródła danych usług REST możliwości raportowania. Produkt Rational Publishing Engine pobiera dane ze źródła danych jako listę zapytań. Te zasoby są przechowywane przez usługę, z której dane mogą być zbierane i interpretowane. Usługa udostępnia również usługę zapytania, która ułatwia filtrowanie danych zgodnie z ustawionym warunkiem oraz precyzowanie podzbiorów danych. Te zapytania są przeznaczone dla typu zasobu i umożliwiają dostęp do zasobu określonego typu. Usługa ID2 możliwości raportowania może udostępniać wiele typów zasobów, takich jak produkt lub żądanie zmiany użytkownika. Usługa zapytania ułatwia użytkownikowi efektywne pobieranie danych lub podzbioru danych, ale nie jest obowiązkowa. Usługa zapytania istnieje dla wszystkich zasobów. Każdy produkt może zdefiniować swoje zasoby oraz zapytania, które mają do nich dostęp.
    2. Z listy Typ uwierzytelniania wybierz odpowiedni typ.
    3. Jeśli zasób znajduje się na zabezpieczonym serwerze, podaj nazwę użytkownika w polu Użytkownik.
    4. Jeśli zasób znajduje się na zabezpieczonym serwerze, podaj hasło w polu Hasło.
  3. Kliknij przycisk Dalej.
  4. Wybierz usługę REST 2 oraz odpowiednie dla niej zapytanie, a następnie kliknij przycisk Dalej. Zostaną wyświetlone właściwości wybranych usług.
  5. Wybierz wymagane właściwości z listy i kliknij opcję Testuj klauzulę oslc.select. W oknie Potwierdzenie wyniku wyświetlane są wybrane usługi. Należy sprawdzić, czy usługi są poprawne. Po kliknięciu opcji Popraw status pola Testuj klauzulę oslc.select zostanie zmieniony na prawda. Kliknij przycisk Dalej.

    Pole Testuj klauzulę oslc.properties nie jest często używane.

  6. Wprowadź tylko filtr lub klauzulę sortowania zapytania, taką jak cq:Product{cq:Product="Rational Publishing Engine"} w polu Zapytanie zawiera klauzulę oslc.where i Zapytanie zawiera klauzulę oslc.orderBy.
  7. Kliknij opcję Testuj klauzulę oslc.where i opcję Testuj klauzulę oslc.orderBy, aby sprawdzić połączenie. Produkt Rational Publishing Engine utworzy pełne zapytanie przy użyciu zdefiniowanych opcji.
  8. Kliknij przycisk Dalej. Zostanie wyświetlone podsumowanie zapytania. Kliknij przycisk Zakończ. Praca kreatora zostanie zakończona, a w oknie Konfiguracja zostanie wyświetlony adres URL. Jeśli zasób znajduje się na zabezpieczonym serwerze, w oknie Konfiguracja można podać nazwę użytkownika i hasło.

Opinia