Obsługa skryptów zadań administracyjnych za pomocą modułu PortalPy

PortalPy to moduł języka Python 2.7, którego można użyć do obsługi skryptów typowych zadań administracyjnych we własnym portalu. Skrypty w języku Python wykorzystujące moduł PortalPy można wykonywać za pośrednictwem dowolnego komputera mającego dostęp do portalu, pod warunkiem, że komputer ten jest skonfigurowany do obsługi języka Python w wersji 2.7.

Ten temat jest wprowadzeniem do modułu PortalPy, zawierającym podstawowe informacje oraz kilka próbek kodu i instrukcje umożliwiające rozpoczęcie pracy. Korzystanie z modułu PortalPy wymaga umiejętności obsługi skryptów w języku Python, jednocześnie jest najbardziej elastycznym sposobem automatyzacji zarządzania portalem. Za pomocą modułu PortalPy można zautomatyzować wszystkie procedury wykonywania zadań oferowane m.in. przez narzędzia wiersza poleceń, przykładowe skrypty w języku Python.

Moduł PortalPy jest instalowany wraz z oprogramowaniem i umiejscowiony w katalogu narzędzi. Na przykład <Portal for ArcGIS installation directory>\tools\portalpy. Moduł ten jest również dostępny w publicznym repozytorium w serwisie GitHub. Można w nim znaleźć aktualną wersję modułu PortalPy oraz dodatkowe zasoby udostępnione przez społeczność użytkowników. Aby uzyskać dostęp do repozytorium, utwórz konto w serwisie GitHub lub zaloguj się za pomocą istniejącego konta w tym serwisie.

Konfiguracja modułu PortalPy na komputerze

Aby obsługiwać skrypty administracyjne za pomocą modułu PortalPy, konieczne jest przeprowadzenie na komputerze konfiguracji modułu PortalPy. Może to być dowolny komputer mający dostęp do portalu. Aby rozpocząć pracę, zapoznaj się z poniższymi instrukcjami.

1. Na komputerze z zainstalowanym oprogramowaniem Portal for ArcGIS przejdź do katalogu <Portal for ArcGIS installation directory>\tools i skopiuj cały folder portalpy do katalogu lokalnego na swoim komputerze. Na przykład C:\portalpy. Jeśli komputer, na którym chcesz uruchomić moduł PortalPy, jest komputerem z zainstalowanym oprogramowaniem Portal for ArcGIS, możesz pominąć ten etap.
2. Na komputerze hostującym moduł PortalPy skonfiguruj zmienną środowiskową o nazwie PYTHONPATH. Określ ścieżkę do katalogu, w którym jest zapisany plik portalpy.py. Na przykład C:\portalpy. Jeżeli potrzebujesz pomocy w wykonaniu tej operacji, zapoznaj się z dokumentacją systemu Windows.
3. Utwórz plik o nazwie test.py i umieść go w tym samym katalogu, w którym jest zapisany plik portalpy.py. Na przykład C:\portalpy.
4. Skopiuj poniższy kod do tego pliku i zaktualizuj adres URL, aby był zgodny z adresem URL portalu.

   #!/usr/bin/python
   import portalpy
   url = "https://portal.domain.com/arcgis"
   portal = portalpy.Portal(url)
   print portal.get_version()

   Notatka:

   Jeśli portal został skonfigurowany do używania uwierzytelniania w warstwie sieci, dostęp do portalu można uzyskać poprzez port 7443 przy korzystaniu z modułu PortalPy, jak pokazano na poniższym przykładzie:

   #!/usr/bin/python import portalpy url = "https://portal.domain.com:7443/arcgis"
   portal = portalpy.Portal(url)
   print portal.get_version()

5. Zapisz i zamknij plik.
6. Uruchom plik test.py z poziomu wiersza poleceń lub środowiska IDLE dla języka Python. Skrypt powoduje wyświetlenie numeru wersji, na przykład 3.2.

Komputer jest teraz skonfigurowany do korzystania z modułu PortalPy.

Dokumentacja dla modułu PortalPy

Opis klas i metod, których obsługę oferuje moduł PortalPy, można znaleźć w temacie Moduł PortalPy. Temat zawiera przykłady użycia, które pomogą w zrozumieniu, jak za pomocą modułu PortalPy można programować przy użyciu interfejsu ArcGIS REST API.

Przykładowe skrypty

Typowe zadania administracyjne, których skrypty można obsługiwać za pomocą modułu PortalPy obejmują m.in.:

Przykład: tworzenie listy użytkowników należących do grupy

portal = PortalPy.Portal(portalUrl, user, password) resp = portal.get_group_members('67e1761068b7453693a0c68c92a62e2e') for user in resp['users']:
   print user

Przykład: tworzenie grupy

portal= PortalPy.Portal(portalUrl, user, password)
group_id = portalAdmin.create_group('my group', 'test tag', 'a group to share travel maps')

Przykład: usuwanie użytkownika i przypisywanie jego zasobów innemu użytkownikowi

portal= PortalPy.Portal(portalUrl, user, password)
portal.delete_user('amy.user', True, 'bob.user')