Publikowanie notatnika jako narzędzia internetowego

Aplikacja ArcGIS Notebooks umożliwia publikowanie notatników jako narzędzi internetowych. Administratorzy i autorzy notatników z uprawnieniami do publikowania narzędzi internetowych mogą publikować posiadane notatniki jako narzędzia internetowe. Gdy notatnik jest publikowany jako narzędzie internetowe, na komputerze serwera ArcGIS Notebook Server zostaje utworzona usługa asynchronicznego geoprzetwarzania, która jest rejestrowana jako narzędzie internetowe. Między notatnikiem a narzędziem internetowym istnieje relacja jeden do jednego, co oznacza, że można opublikować tylko jedno narzędzie internetowe na jeden notatnik i że element narzędzia internetowego ma przypisane takie same uprawnienia udostępniania jak nadrzędny notatnik. Narzędzia internetowe mogą być wykorzystywane przez dowolną aplikację kliencką, która pracuje z asynchronicznymi usługami geoprzetwarzania zgodnymi ze specyfikacją REST.

Publikowanie notatnika jako narzędzia internetowego jest obsługiwane dla notatników ze środowiska wykonawczego w wersji 6.0 lub wyższej. Aby sprawdzić informacje o środowisku wykonawczym notatnika, kliknij przycisk Informacje na górnej wstążce edytora notatników lub na karcie Ustawienia na stronie elementu notatnika. Aby dowiedzieć się więcej na temat środowisk wykonawczych notatników, przejdź do sekcji Wyświetlanie dostępnych bibliotek języka Python.

Edytor notatników pozwala skonfigurować parametry wejściowe i wynikowe dla notatnika. Parametry wejściowe odpowiadają zmiennym wejściowym w notatniku, które mają zostać uzewnętrznione dla danych wejściowych użytkownika, gdy notatnik jest uruchomiony jako narzędzie internetowe. Parametry wynikowe reprezentują zmienne wynikowe w notatniku, które mają zostać zwrócone jako dane wynikowe narzędzia internetowego. Po zarejestrowaniu co najmniej jednej zmiennej wejściowej lub wynikowej i opublikowaniu notatnika parametry stają się dostępne jako parametry wejściowe lub wynikowe dla odpowiedniego narzędzia internetowego.

Notatka:

Przy publikowaniu notatnika jako narzędzia internetowego nie jest wymagane zdefiniowanie parametrów wejściowych lub wynikowych. Na przykład notatniki, które wykonują zadania z predefiniowanymi danymi wejściowymi i wynikowymi, takimi jak warstwy obiektowe przywoływane za pomocą itemId, mogą nie wymagać parametrów wejściowych ani wynikowych.

Notatka:

Jako parametry wejściowe lub wynikowe są obsługiwane następujące typy danych: String (ciąg znakowy), Long, Double, Boolean (wartość logiczna), zestaw obiektów, zestaw rekordów, data i jednostka liniowa. Więcej informacji zawiera temat Typy danych usług geoprzetwarzania w dokumentacji REST API aplikacji ArcGIS Notebook Server.

Po uruchomieniu narzędzia internetowego oprogramowanie ArcGIS Notebook Server automatycznie uruchamia notatnik na komputerze serwera notatników, otwierając nowy kontener i uruchamiając notatnik bez interakcji z użytkownikiem. Użytkownicy z uprawnieniami do notatnika i użytkownicy, którym notatnik został udostępniony, mogą uzyskać dostęp do narzędzia internetowego i je uruchomić. Oprócz wymaganych uprawnień do notatnika wymagane są wszelkie inne uprawnienia potrzebne do uruchomienia notatnika. Zapoznaj się z tematem Typy użytkowników, role i uprawnienia, aby dowiedzieć się więcej o uprawnieniach.

Notatka:

W przypadku utworzenia notatnika do udostępnienia jako narzędzia internetowego, jeśli notatnik odwołuje się do pliku z katalogu obszaru roboczego jako do danych wejściowych, te pliki nie będą dostępne dla innych osób, którym udostępniono notatnik lub narzędzie internetowe. Jeśli masz pliki, które mają być przywoływane jako dane wejściowe w notatniku, możesz albo odwołać się do tego pliku poprzez udostępniony element portalu w oprogramowaniu Portal for ArcGIS, albo przesłać plik do niestandardowego katalogu danych zarejestrowanego w aplikacji ArcGIS Notebook Server i tam się do niego odwoływać.

Domyślnie serwer ArcGIS Notebook Server jest skonfigurowany do uruchamiania maksymalnie 10 współbieżnych, nieinteraktywnych uruchomień notatników na każdym komputerze z serwerem ArcGIS Notebook Server. Wliczane są uruchomienia wyzwalane przez narzędzia internetowe, zaplanowane zadania, interfejs API executeNotebook oraz wyzwalacze elementów webhook. W razie konieczności administratorzy mogą zwiększyć ten limit.

Notatka:

Jeśli w edytorze notatników nie widzisz opcji Parametry lub Publikuj, to albo nie masz uprawnienia do publikowania narzędzi internetowych, albo nie jesteś właścicielem notatnika. W nowo utworzonym notatniku opcje Parametry i Publikuj nie są wyświetlane, dopóki notatnik nie zostanie zapisany.

Konfigurowanie parametrów wejściowych

Parametry wejściowe reprezentują zmienne wejściowe w notatniku, które są obsługiwane na zewnątrz, gdy notatnik jest uruchamiany jako narzędzie internetowe. Na panelu Parametry w edytorze notatników można skonfigurować i dodać parametry wejściowe jako zmienne do notatnika.

1. W edytorze notatników kliknij opcję Parametry.
2. Kliknij przycisk Dodaj.
3. Wybierz dane wejściowe dla wartości Kierunek.
4. Wprowadź nazwę w polu Nazwa zmiennej.

   Notatka:

   Ta wartość musi być zgodna z nazwą zmiennej znajdującej się w kodzie notatnika lub skonfigurowanej już w notatniku.

5. Wprowadź nazwę w polu Nazwa wyświetlana dla parametru narzędzia internetowego.
6. W menu rozwijanym Typ danych wybierz typ danych parametru wejściowego.
7. Wprowadź wartość w polu Default value dla parametru wejściowego. Składnię wartości domyślnych obsługiwanych typów danych zawiera temat Typy danych usług geoprzetwarzania.
8. W polu Description wprowadź opis parametru wejściowego.
9. Kliknij przycisk Zapisz, aby zapisać parametr wejściowy.
10. Aby dodać dodatkowe parametry wejściowe, powtórz czynności od 1 do 9.
11. Po dodaniu wszystkich parametrów wejściowych wybierz komórkę w notatniku, do której będą wstawione parametry i kliknij opcję Wstaw jako zmienne.
12. Kliknij przycisk Zapisz, aby zapisać notatnik.

Konfigurowanie parametrów wynikowych

Dane wynikowe notatnika opublikowanego jako narzędzie internetowe można skonfigurować, konfigurując parametry wynikowe na panelu Parametry w edytorze notatników.

1. W edytorze notatników kliknij opcję Parametry.
2. Kliknij przycisk Dodaj.
3. Wybierz dane wynikowe parametru Direction.
4. Wprowadź nazwę w polu Variable name.

   Notatka:

   Ta wartość musi być zgodna z nazwą zmiennej znajdującej się w kodzie notatnika lub skonfigurowanej już w notatniku.

5. Wprowadź nazwę w polu Display name dla parametru narzędzia internetowego.
6. W menu rozwijanym Data type wybierz typ danych parametru wynikowego.
7. Wprowadź wartość w polu Default value dla parametru wynikowego. Składnię wartości domyślnych obsługiwanych typów danych zawiera temat Typy danych usług geoprzetwarzania.
8. W polu Description wpisz opis parametru wynikowego.
9. Kliknij przycisk Zapisz, aby zapisać parametr wynikowy.
10. Wybierz komórkę w notatniku. Kliknij przycisk Dodaj, aby dodać fragment kodu w języku Python do zapisania danych wynikowych dla narzędzia internetowego.

    Zalecane jest wybranie komórki u dołu notatnika, poniżej komórek, w których są tworzone dane wynikowe.

11. Sprawdź dodany fragment kodu pod kątem zgodności nazw zmiennych wynikowych z danymi wynikowymi zdefiniowanymi w notatniku i wprowadź ewentualne dodatkowe korekty w tym fragmencie kodu.
12. Powtórz czynności od 1 do 11 dla każdego dodatkowego parametru wynikowego.
13. Kliknij przycisk Zapisz, aby zapisać notatnik.

Publikowanie narzędzia internetowego

Notatnik można opublikować jako narzędzie internetowe na panelu Publikowanie w edytorze notatników.

1. Zapisz notatnik, aby została opublikowana najnowsza kopia notatnika.
2. Uruchom ręcznie interaktywnie komórki notatnika, aby upewnić się, że nie występują żadne błędy.

Notatka:

Pomiń komórki zawierające fragmenty kodu dla parametrów wynikowych, ponieważ one nie są uruchamiane w trybie interaktywnym.
3. Na wstążce edytora notatników kliknij opcję Publikuj.
4. Wprowadź tytuł i opis narzędzia internetowego w polach Title i Description na panelu Publikowanie.
5. Zweryfikuj parametry wejściowe i wynikowe.
6. Kliknij opcję Publikuj, aby opublikować notatnik jako narzędzie internetowe.
7. Po pomyślnym opublikowaniu narzędzia internetowego kliknij opcję Wyświetl szczegóły, aby wyświetlić stronę szczegółów elementu dla narzędzia internetowego.

Zastąp narzędzie internetowe

Zastąpienie narzędzia internetowego spowoduje zaktualizowanie narzędzia internetowego pod kątem korzystania z najnowszej migawki tego notatnika. Możesz zastąpić narzędzie internetowe notatnika w okienku Publikuj w edytorze notatnika.

1. Jeśli istniejący parametr wejściowy lub wyjściowy wymaga aktualizacji, wykonaj czynności opisane w sekcji Edytowanie istniejącego parametru wejściowego lub wyjściowego w tym temacie.
2. Jeśli dodajesz nowe parametry wejściowe lub wyjściowe, wykonaj czynności opisane w sekcjach Konfigurowanie parametrów wejściowych lub Konfigurowanie parametrów wyjściowych w tym temacie.
3. Kliknij przycisk Zapisz, aby zapewnić opublikowanie najnowszej kopii notatnika.
4. Ręcznie uruchom każdą komórkę w notatniku, aby upewnić się, że nie występują żadne błędy.

   Notatka:

   Nie uruchamiaj komórek zawierających fragmenty kodu dla parametrów wyjściowych, ponieważ nie będą one działać w trybie interaktywnym.

5. Kliknij przycisk Publikuj.
6. Kliknij przycisk Zastąp, aby zastąpić narzędzie internetowe.

Usuwanie narzędzia internetowego

Usługę geoprzetwarzania opublikowaną na podstawie notatnika można usunąć, usuwając element narzędzia internetowego.

1. Na górnej wstążce edytora notatników kliknij opcję Publikuj.
2. Kliknij opcję Wyświetl szczegóły, aby wyświetlić stronę szczegółów elementu narzędzia internetowego.
3. Kliknij opcję Ustawienia.
4. Kliknij opcję Usuń element i potwierdź, że chcesz usunąć element narzędzia internetowego i usługę geoprzetwarzania opublikowaną w aplikacji ArcGIS Notebook Server.

Edycja istniejącego parametru wejściowego lub wynikowego

Na panelu Parametry w edytorze notatników można wprowadzić zmiany w istniejącym parametrze wejściowym lub wynikowym.

Notatka:

Jeśli notatnik został już opublikowany jako narzędzie internetowe, przed wprowadzeniem zmian w parametrach należy kliknąć przełącznik Włącz edycję na panelu Parametry. Należy zachować ostrożność podczas wprowadzania zmian w parametrach po opublikowaniu notatnika jako narzędzia internetowego, ponieważ te zmiany mogą popsuć działanie aplikacji internetowych korzystających z tego narzędzia internetowego.

1. Na górnej wstążce edytora notatników kliknij opcję Parametry.
2. Kliknij przycisk opcji znajdujący się obok parametru i kliknij opcję Edytuj.
3. Zaktualizuj parametr i kliknij przycisk Zapisz.
   1. Jeśli został zaktualizowany parametr wejściowy, wyczyść lub usuń ręcznie istniejącą komórkę ze zmiennymi wejściowymi i powtórz czynność wstawiania do notatnika parametrów wejściowych jako zmiennych.
   2. Jeśli został zaktualizowany parametr wynikowy, wyczyść ręcznie fragment kodu odpowiadający zmiennej wynikowej i powtórz czynności dodania do notatnika fragmentu kodu dla parametru wynikowego.
4. Kliknij przycisk Zapisz, aby zapisać notatnik.

Usuwanie istniejącego parametru wejściowego lub wynikowego

Na panelu Parametry można usunąć istniejące parametry wejściowe lub wynikowe.

1. Na górnej wstążce edytora notatników kliknij opcję Parametry.
2. Kliknij przycisk opcji znajdujący się obok parametru i kliknij opcję Usuń.
3. Kliknij opcję Usuń, aby trwale usunąć parametr.
4. Ręcznie wyczyść lub usuń zmienną wejściową lub wynikowy fragment kodu w notatniku.
5. Kliknij przycisk Zapisz, aby zapisać notatnik.

Użyj zasięgu mapy

Gdy narzędzie internetowe jest uruchamiane w przeglądarce Map Viewer Classic, zasięg mapy jest przekazywany do notatnika w postaci zmiennej języka Python o nazwie context razem z innymi parametrami wejściowymi, jak pokazano poniżej.

context = {
    "extent": {
        "ymin": -25203428.462408017,
        "xmin": -46101923.491795965,
        "ymax": 25203428.462407943,
        "xmax": 46101923.491795965,
        "spatialReference": {
            "wkt": "PROJCS[\"WGS_1984_Web_Mercator_Auxiliary_Sphere\",GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Mercator_Auxiliary_Sphere\"],PARAMETER[\"False_Easting\",0.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",0],PARAMETER[\"Standard_Parallel_1\",0.0],PARAMETER[\"Auxiliary_Sphere_Type\",0.0],UNIT[\"Meter\",1.0]]"
        },
    }
}

Za pomocą zmiennej context można skonfigurować zasięg procedur wykonywania zadań analizy przestrzennej w notatniku. Aby przetestować procedury wykonywania zadań analizy przestrzennej z zasięgiem mapy przed opublikowaniem notatnika jako narzędzia internetowego, zadeklaruj wartość domyślną zmiennej context.

Gdy wszystko będzie gotowe do opublikowania, wstaw parametry wejściowe jako zmienne po komórce, w której deklarujesz zmienną context.

Rozwiązywanie problemów z narzędziem internetowym

Po opublikowaniu notatnika jako narzędzia internetowego możesz sprawdzić, czy narzędzie internetowe działa pomyślnie, uruchamiając zadanie z katalogu usług ArcGIS Notebook Server.

1. W przeglądarce internetowej otwórz katalog usług aplikacji ArcGIS Notebook Server https://notebookserver.domain.com/webadaptorcontext/rest/services.
2. Zaloguj się jako właściciel narzędzia internetowego.
3. Znajdź usługę i przejdź do strony zadań.
4. Kliknij opcję Prześlij zadanie.
5. Wprowadź parametry wejściowe i kliknij opcję Prześlij zadanie.
6. Opcjonalnie kliknij łącze Sprawdź ponownie szczegóły zadania, aby sprawdzić status zadania.

   Jeśli narzędzie internetowe działa prawidłowo, zostaną udostępnione łącza do danych wynikowych. Domyślnie jako dane wynikowe jest udostępniany podgląd HTML uruchomienia notatnika, zarówno dla uruchomienia pomyślnego, jak i zakończonego niepowodzeniem.

7. Pobierz i wyświetl podgląd HTML notatnika, aby sprawdzić, czy nie wystąpiły problemy z uruchomieniem narzędzia internetowego.
8. Jeśli działanie narzędzia internetowego zakończy się niepowodzeniem, sprawdź w edytorze notatników, czy notatnik jest uruchamiany poprawnie.