Tarefas de script administrativas com PortalPy

O PortalPy é um módulo do Python 2.7 que você pode utilizar para criar scripts de tarefas administrativas comuns com seu próprio portal. Os scripts do Python que alavancam o PortalPy podem ser executados de qualquer máquina com acesso ao seu portal desde que sua máquina esteja configurada para executar o Python 2.7 (exigido).

Este tópico fornece uma introdução básica ao módulo do PortalPy, inclui várias amostras e instruções para você começar. A utilização do PortalPy exige habilidades para criar scripts do Python, mas fornece uma maneira mais flexível para verdadeiramente automatizar a administração do seu portal. Com o PortalPy, você pode automatizar todos os fluxos de trabalho oferecidos pelos utilitários da linha de comando, scripts de amostra do Python e muito mais.

O módulo de PortalPy é instalado com o software e localizado no diretório de ferramentas. Por exemplo, <Portal for ArcGIS installation directory>/tools/portalpy. O módulo também está disponível por um repositório GitHub público. Este recurso contém o módulo de PortalPy mais atual, como também, o conteúdo adicional contribuído pela comunidade de usuários. Para acessar este repositório, crie uma conta de GitHub ou entre com sua conta de GitHub existente.

Configurando o módulo do PortalPy na sua máquina

Para criar um script de tarefas administrativas com PortalPy, você precisará instalar o módulo do PortalPy na sua máquina. Isto pode ser qualquer máquina que tem acesso ao seu portal. Para iniciar, consulte as etapas abaixo.

1. Na máquina instalada com o Portal for ArcGIS, procure no <Portal for ArcGIS installation directory>/tools e copie a pasta inteira portalpy para um diretório local na sua máquina. Por exemplo, /home/admin/portalpy. Se a máquina que deseja executar o módulo do PortalPy for a máquina instalada com o Portal for ArcGIS, você pode pular esta etapa.
2. Na máquina hospedando o módulo do PortalPy, configure uma variável de ambiente denominada PYTHONPATH. Especifique o caminho do diretório onde está o portalpy.py. Por exemplo, export PYTHONPATH=$PYTHONPATH:/home/admin/portalpy.
3. Crie um arquivo denominado test.py e coloque no mesmo diretório onde está o portalpy.py. Por exemplo, /home/admin/portalpy.
4. Copie o seguinte código no arquivo e atualize a URL para corresponder à URL do seu portal.

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

   Anotação:

   Se você configurou seu portal para utilizar autenticação em série da web, você pode acessar seu portal pela porta 7443 ao utilizar PortalPy como é mostrado no exemplo abaixo:

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

5. Salve e feche o arquivo.
6. Execute test.py. O script imprime um número de versão como 3.2.

Sua máquina está agora configurada para utilizar o módulo do PortalPy.

Documentação de módulo do PortalPy

Para revisar as classes e métodos incluídos com PortalPy, consulte módulo do PortalPy. O tópico contém amostras de uso que podem ajudá-lo com informações sobre como programar com ArcGIS REST API utilizando o módulo do PortalPy.

Scripts de exemplo

As tarefas administrativas comuns que você pode criar scripts utilizando o PortalPy incluem o seguinte:

Exemplo: Listar usuários em um grupo

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

Exemplo: Criar um grupo

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

Exemplo: Excluir um usuário e reatribuir o conteúdo do usuário para outro usuário

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