Publicar um notebook como uma ferramenta da web

O ArcGIS Notebooks permite publicar notebooks como ferramentas da web. Administradores e autores do notebook com privilégios de Publicar ferramenta da web podem publicar notebooks de sua propriedade como ferramentas da web. Quando um notebook é publicado como uma ferramenta da web, um serviço de geoprocessamento assíncrono é criado no ArcGIS Notebook Server e registrado como uma ferramenta da web. Há um relacionamento de um para um entre o notebook e a ferramenta da web, o que significa que apenas uma ferramenta da web pode ser publicada por notebook, e o item da ferramenta da web recebe as mesmas permissões de compartilhamento do notebook principal. As ferramentas da web podem ser consumidas por qualquer aplicativo cliente que possa funcionar com serviços de geoprocessamento assíncrono RESTful.

A publicação de um notebook como uma ferramenta da Web é compatível com notebooks com runtime versão 6.0 ou posterior. Para verificar as informações do tempo de execução de um notebook, clique no botão Informações na barra de formatação superior do editor de notebook ou na guia Configurações da página Item do Notebook. Consulte Visualizar bibliotecas disponíveisPython para saber mais sobre os tempos de execução do notebook.

O editor de notebook permite configurar parâmetros de entrada e saída para um notebook. Os parâmetros de entrada correspondem às variáveis de entrada em um notebook que você deseja externalizar para a entrada do usuário quando o notebook é executado como uma ferramenta da web. Os parâmetros de saída representam as variáveis de saída em um notebook que você deseja retornar como saídas de ferramentas da web. Quando você registra uma ou mais variáveis de entrada ou saída e publica um notebook, os parâmetros se tornam disponíveis como parâmetros de entrada ou saída para a ferramenta da web correspondente.

Anotação:

Não é necessário definir parâmetros de entrada ou saída ao publicar um notebook como uma ferramenta da web. Por exemplo, notebooks que executam tarefas com entradas e saídas pré-definidas, como camadas de feição referenciadas por, itemId podem não exigir parâmetros de entrada ou saída.

Anotação:

Os seguintes tipos de dados são suportados como parâmetros de entrada ou saída: String, Longo, Duplo, Booleano, Conjunto de Feições, Conjunto de Registros, camada de dados Raster, Data e Unidade Linear. Para mais informações, consulte Tipos de dados dos serviços de geoprocessamento na documentação do REST API do ArcGIS Notebook Server . Para mais informações, consulte Tipos de dados dos serviços de geoprocessamento na documentação do REST API

Quando uma ferramenta da web é executada, o ArcGIS Notebook Server realiza uma execução automatizada do notebook na máquina de servidor do notebook, abrindo um novo contêiner e executando o notebook sem interação do usuário. Os usuários com privilégio de execução de ferramentas da web e com quem o notebook foi compartilhado podem acessar e executar a ferramenta da web. Além do privilégio de executar ferramentas da web necessário, nenhum dos outros privilégios são necessários para executar o notebook. Consulte o tópico Tipos de usuário, papéis e privilégios para saber mais sobre privilégios.

Anotação:

Ao criar um notebook para ser compartilhado como uma ferramenta da web, se o notebook fizer referência a um arquivo do diretório da sua área de trabalho como dados de entrada, esses arquivos não poderão ser acessados por outras pessoas com quem o notebook ou ferramenta da web é compartilhado. Se você tiver arquivos que precisam ser referenciados como dados de entrada no notebook, você poderá fazer referência ao arquivo por meio de um item de portal compartilhado no Portal for ArcGIS ou carregar e referenciar o arquivo de um diretório de dados personalizados registrado comArcGIS Notebook Server.

Por padrão, ArcGIS Notebook Server é configurado para executar no máximo 10 execuções simultâneas e não interativas de notebook por cada máquina do ArcGIS Notebook Server. Isso inclui execuções ativadas por ferramentas da web, tarefas agendadas, a API executeNotebook e ativadores de webhook. Os administradores podem aumentar esse limite, se necessário.

Anotação:

Se você não visualizar as opções Parâmetros ou Publicar no editor de notebook, você não tem o privilégio de Publicar ferramentas da web ou não é o proprietário do notebook. Se você estiver em um notebook recém-criado, as opções Parâmetros e Publicar não serão exibidas até que o notebook seja salvo.

Configurar parâmetros de entrada

Os parâmetros de entrada representam variáveis de entrada em um notebook que são externalizadas quando um notebook é executado como uma ferramenta da web. Usando o painel Parâmetros no editor de notebook, você pode configurar e adicionar parâmetros de entrada como variáveis ao seu notebook.

1. No editor de notebook, clique em Parâmetros.
2. Clique em Adicionar.
3. Selecione a entrada para Direção.
4. Insira um nome para Nome da variável.

   Anotação:

   Deve corresponder a um nome de variável que esteja no código do notebook ou já esteja configurado no notebook.

5. Insira um nome para Nome de exibição do parâmetro de ferramenta da web.
6. No menu suspenso Tipo de dados, selecione um tipo de dados para o parâmetro de entrada.
7. Insira um valor para Valor padrão do parâmetro de entrada. Consulte Tipos de dados dos serviços de geoprocessamento para obter a sintaxe dos valores padrão para os tipos de dados suportados.
8. Para Descrição, insira uma descrição para o parâmetro de entrada.
9. Clique em Salvar para salvar o parâmetro de entrada.
10. Para adicionar mais parâmetros de entrada, repita as etapas 1 a 9.
11. Após adicionar todos os seus parâmetros de entrada, selecione uma célula em seu notebook para os parâmetros a serem inseridos e clique em Inserir como variáveis.
12. Clique em Salvar para salvar o notebook.

Configurar parâmetros de saída

Você pode configurar a saída de um notebook publicado como ferramenta da web, configurando os parâmetros de saída do painel Parâmetros no editor de notebook.

1. No editor de notebook, clique em Parâmetros.
2. Clique em Adicionar.
3. Selecione a saída do parâmetro Direção.
4. Insira um nome para Nome da variável.

   Anotação:

   Deve corresponder a um nome de variável que esteja no código do notebook ou já esteja configurado no notebook.

5. Insira um nome para Nome de exibição do parâmetro de ferramenta da web.
6. No menu suspenso Tipo de dados, selecione um tipo de dados para o parâmetro de saída.
7. Insira um valor para Valor padrão para o parâmetro de saída. Consulte Tipos de dados dos serviços de geoprocessamento para obter a sintaxe dos valores padrão para os tipos de dados suportados.
8. Para Descrição, digite uma descrição do parâmetro de saída.
9. Clique em Salvar para salvar o parâmetro de saída.
10. Selecione uma célula em seu notebook. Clique no botão Adicionar para adicionar o snippet de código do Python para escrever a saída de ferramenta da web.

    É recomendado selecionar uma célula próxima à parte inferior do notebook, abaixo das células onde as saídas são criadas.

11. Inspecione o snippet de código adicionado para garantir que os nomes das variáveis de saída correspondam à saída definida no notebook e faça quaisquer ajustes adicionais no snippet de código.
12. Repita as etapas 1 a 11 para quaisquer parâmetros de saída adicionais.
13. Clique em Salvar para salvar o notebook.

Publicar uma ferramenta da web

Você pode publicar um notebook como uma ferramenta da web a partir do painel Publicar no editor de notebooks.

1. Salve seu notebook para garantir que a cópia mais recente do notebook seja publicada.
2. Execute manualmente as células do notebook de forma interativa para garantir que não haja erros.

Anotação:

Ignore as células que contenham snippet de código para os parâmetros de saída, pois eles não são executados no modo interativo.
3. Clique em Publicar na barra de formatação do editor de notebook.
4. Insira um título e uma descrição para a ferramenta da web nos campos Título e Descrição no painel Publicar.
5. Verifique todos os parâmetros de entrada e saída.
6. Clique em Publicar para publicar o notebook como uma ferramenta da web.
7. Após a ferramenta da web ser publicada com sucesso, clique em Visualizar detalhes para visualizar a página de detalhes do item para a ferramenta da web.
8. Clique em Compartilhar para abrir a janela Compartilhar.
   1. Selecione Organização para compartilhar a ferramenta da web com todos os usuários da sua organização.
   2. Clique em Editar compartilhamento do grupo para compartilhar a ferramenta web com grupos específicos.
   3. Selecione os grupos com os quais deseja compartilhar.
   4. Clique em OK.
   5. Clique em Salvar.

Compartilhe uma ferramenta da web

Para compartilhar ou atualizar as configurações de compartilhamento de uma ferramenta web de notebook existente com sua organização ou grupos específicos em sua organização, siga as etapas abaixo.

Anotação:

Os usuários com os quais a ferramenta da web é compartilhada devem ter o privilégio Executar ferramentas da web e quaisquer privilégios adicionais necessários para executar o notebook para poder executar a ferramenta da web compartilhada.

Anotação:

Introduzido na versão 11.2, agora você pode compartilhar uma ferramenta web de notebook em um nível diferente daquele em que o notebook foi publicado. Por exemplo, uma ferramenta web de notebook pode ser compartilhada com a organização mesmo quando o notebook em si não está compartilhado com a organização. Para garantir que uma ferramenta web publicada em uma versão anterior possa utilizar esta mudança, substitua a ferramenta da web.

1. Verifique se você está conectado ao Portal for ArcGIS e tem o privilégios suficiente para compartilhar conteúdo com sua organização.
2. Clique em Conteúdo.
3. Marque a caixa ao lado do título da ferramenta web que você deseja compartilhar.
4. Clique em Compartilhar.
   1. Selecione Organização para compartilhar a ferramenta da web com todos os usuários da sua organização.
   2. Clique em Editar compartilhamento do grupo para compartilhar a ferramenta web com grupos específicos.
   3. Selecione os grupos com os quais deseja compartilhar.
   4. Clique em OK.
   5. Clique em Salvar.

Substituir uma ferramenta da web

A substituição de uma ferramenta da web atualizará uma ferramenta da web para usar a captura instantânea mais recente desse notebook. Você pode substituir uma ferramenta da web do notebook no painel Publicar no editor do notebook.

1. Se um parâmetro de entrada ou saída existente precisar ser atualizado, siga as etapas na seção Editar um parâmetro de entrada ou saída existente deste tópico.
2. Se você estiver adicionando novos parâmetros de entrada ou saída, siga as etapas nas seções Configurar parâmetros de entrada ou Configurar parâmetros de saída deste tópico.
3. Clique em Salvar para garantir que a cópia mais recente do notebook seja publicada.
4. Execute manualmente cada célula no notebook para garantir que não existam erros.

   Anotação:

   Não execute células que contenham os trechos de código para os parâmetros de saída, pois elas não serão executadas no modo interativo.

5. Clique em Publicar.
6. Clique em Substituir para substituir a ferramenta da web.

Excluir uma ferramenta da web

Você pode excluir um serviço de geoprocessamento publicado de um notebook, excluindo o item de ferramenta da web.

1. Na barra de formatação superior do editor de notebook, clique em Publicar.
2. Clique em Visualizar detalhes para visualizar o item da página de detalhes para a ferramenta da web.
3. Clique em Configurações.
4. Clique em Excluir item e confirme que deseja remover o item de ferramenta da web e o serviço de geoprocessamento publicado no ArcGIS Notebook Server.

Editar um parâmetro de entrada ou saída existente

Você pode fazer alterações em um parâmetro de entrada ou saída existente no painel Parâmetros no editor de notebook.

Anotação:

Se um notebook já foi publicado como uma ferramenta da web, você deverá ativar o botão de alternância Habilitar edição no painel Parâmetros antes de fazer alterações em seus parâmetros. Seja cauteloso ao fazer alterações em seus parâmetros após o notebook ser publicado como uma ferramenta da web, pois essas alterações podem interromper qualquer aplicativo da web que use a ferramenta da web.

1. Na barra de formatação superior do editor de notebook, clique em Parâmetros.
2. Clique no botão de opções ao lado do parâmetro e clique emEditar.
3. Atualize o parâmetro e clique em Salvar.
   1. Se um parâmetro de entrada foi atualizado, limpe ou remova manualmente a célula existente com as variáveis de entrada e repita a etapa para inserir os parâmetros de entrada como variáveis no notebook.
   2. Se um parâmetro de saída foi atualizado, limpe manualmente o snippet de código correspondente à variável de saída e repita as etapas para adicionar o snippet de código para o parâmetro de saída ao notebook.
4. Clique em Salvar para salvar o notebook.

Excluir um parâmetro de entrada ou saída existente

Você pode excluir parâmetros de entrada ou saída existentes do painel Parâmetros.

1. Na barra de formatação superior do editor de notebook, clique em Parâmetros.
2. Clique no botão de opções ao lado do parâmetro e clique em Excluir.
3. Clique em excluir para remover o parâmetro permanentemente.
4. Limpe ou remova manualmente a variável de entrada ou snippet de código de saída no notebook.
5. Clique em Salvar para salvar o notebook.

Utilizar a extensão de mapa

Ao executar uma ferramenta da web no Map Viewer Classic, a extensão do mapa é passada para o notebook como uma variável de Python denominada context, junto com outros parâmetros de entrada, conforme mostrado abaixo.

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]]"
        },
    }
}

Você pode usar o valor da variável context para definir a extensão dos fluxos de trabalho de análise espacial em seu notebook. Para testar seus fluxos de trabalho de análise espacial com uma extensão do mapa antes de publicar o notebook como uma ferramenta da web, declare a variável context com um valor padrão.

Quando estiver pronto para publicar, insira os parâmetros de entrada como variáveis após a célula onde você declara a variável context.

Solucionar problemas de execução de uma ferramenta da web

Após publicar um notebook como uma ferramenta da web, você poderá validar se a ferramenta da web será executada com sucesso executando a tarefa a partir do diretório de serviços do ArcGIS Notebook Server.

1. Em um navegador da web, abra o diretório de serviços https://notebookserver.domain.com/webadaptorcontext/rest/services do ArcGIS Notebook Server.
2. Entre como o proprietário de ferramenta da web.
3. Identifique o serviço e navegue até a página de tarefas.
4. Clique em Enviar trabalho.
5. Insira quaisquer parâmetros de entrada e clique em Enviar trabalho.
6. Opcionalmente, clique no link Verificar Detalhes do Trabalho Novamente para verificar o status do trabalho.

   Se a ferramenta da web for concluída com sucesso, serão fornecidos links para as saídas. Uma visualização em HTML da execução do notebook é fornecida como saída por padrão, tanto para execuções com sucesso quanto para falhas.

7. Baixe e visualize a visualização em HTML do notebook para verificar se houve algum problema com a execução de ferramenta da web.
8. Se a ferramenta da web falhar, confirme se o notebook foi executado com sucesso no editor de notebook.