Instalar e configurar o site do ArcGIS Survey123

Resumo

Às vezes, as organizações precisam trabalhar em ambientes completamente desconectados nos quais não têm acesso externo à Internet. Outras organizações podem estar conectadas, mas são necessárias para hospedar o site ArcGIS Survey123 e/ou a REST API do Survey123 em sua própria infraestrutura.

A REST API do Survey123 é utilizada para utilizar suas configurações de pesquisa e convertê-las nos formulários para uso nos aplicativos do Survey123 (aplicativo de campo / formulário da web), como arquivos .xlsx criados conectados ou configurações criadas pelo site. O site, por outro lado, fornece a funcionalidade para criar e gerenciar as pesquisas e visualizar e analisar os dados coletados. Ambos os componentes são separados, mas trabalham juntos para fornecer a funcionalidade que é vista no site do ArcGIS Survey123 (https://survey123.arcgis.com).

O que está incluído

Uma instalação local de REST API do Survey123 e do site, que permite criar e publicar pesquisas do Survey123 Connect ou do site em sua própria infraestrutura. Isso fornece a maior parte da funcionalidade completa do site do ArcGIS Survey123, com a notável exceção de que a API de relatórios ainda não pode ser hospedada localmente.

O que é exigido

É necessário fazer o download do arquivo do instalador do site My Esri. As etapas de instalação abaixo são apenas para instalações do Windows. Também são necessárias credenciais de administrador do portal do ArcGIS Enterprise, bem como acesso de administrador para o servidor web. O instalador do site Survey123 pode ser implementado na mesma máquina que a instância do Portal ou em um servidor web independente. Embora o site do Survey123 instalado tenha sido testado com sucesso com o portal ArcGIS Enterprise versões 10.5.1 e posteriores, cada versão suporta oficialmente as versões do ArcGIS Enterprise que estão na fase de 'Disponibilidade Geral' do Ciclo de Vida do Produto no momento do lançamento.

Portas usadas internamente (26080, 26443, 28080, 28443)

As portas 26080, 26443, 28080 e 28443 são usadas pelo site Survey123 instalado para serviços internos. Você não precisa abrir essas portas para acesso de outras máquinas. No entanto, você deve estar ciente que o site Survey123 instalado está usando-as caso você execute outros aplicativos que requerem as mesmas portas. Ao contrário de alguns componentes do ArcGIS Enterprise, o site Survey123 instalado não pode ser incrementado automaticamente para uma porta diferente se as portas acima não estiverem abertas.

Procedimento

Instalação

Baixe o site da web do ArcGIS Survey123 via My Esri.

Windows
Descompacte o arquivo baixado na máquina desejada e execute o Setup.exe. Aceite o contrato básico, escolha o local de instalação e clique em Instalar. O processo pode levar até aproximadamente 30 minutos. Quando terminar, clique em Concluir para sair da instalação.

Linux:

Caution:
The archive files contained here must be extracted on a Unix machine. If done from a Windows machine, they lose the permissions necessary to run the setup properly and some filename casing may be changed.

1. Extraia o conteúdo do arquivo .tar.gz na máquina em que deseja instalar o site Survey123 usando o comando gunzip [filename].tar.gz seguido por tar xf [filename].tar no Terminal.
2. Após extraído, execute ./Setup no Terminal, aceite o contrato básico, escolha o local de instalação e clique em Instalar. O processo pode levar cerca de 5 a 10 minutos. Quando terminar, clique em Concluir para sair da instalação.

Pós-instalação
As etapas para configurar o site do Survey123 instalado variam dependendo do ambiente do ArcGIS Enterprise. Consulte a seção relevante abaixo.

Note:
A security warning may be encountered by your browser. Accept this and continue to the website, this is addressed by configuring a certificate during post installation. 

Note:
Make a backup of the config.json file (default location is C:\Program Files\ArcGIS\Survey123website) before running the post installation. If the installation is incorrectly configured, this file can be used to restore and start again (or make manual edits to the existing config.json).

Verifique se o seu Portal está limitando os domínios que podem se conectar via Cross-Origin Resource Sharing (CORS) ao ArcGIS REST API:

1. Entre no ArcGIS Enterprise como administrador, vá até o grupo Organização> Configurações > Segurança > Permitir origens. Por padrão, todos os domínios são permitidos, ou seja, não há URLs na lista aqui. Se você já estiver limitando os domínios, adicione a URL do host do Survey123 à lista.
2. Clique em Adicionar e adicione a URL do host do site Survey123. Por exemplo:
   • https://<survey123website.domain>:5443
3. Clique em Adicionar domínio. Isso permite que o domínio do aplicativo da web Survey123 se conecte via (CORS) ao ArcGIS REST API.

ArcGIS Enterprise com autenticação embutida
Execute a pós-instalação abrindo https://localhost:5443/share/post-install.html na máquina de instalação.

A pós-instalação é apresentada como um assistente de pesquisa para editar o arquivo config.json. A pós-instalação é apresentada como um assistente de pesquisa para editar o arquivo config.json.

• URL padrão do ArcGIS Portal (https://domain.com/portalwebadaptor) para configurar o site da web do Survey123 com ArcGIS Enterprise.A instalação aponta para ArcGIS Online (arcgis.com) por padrão.
• Credenciais do ArcGIS Portal Admin (necessárias para definir o URI de redirecionamento para entrada no Portal)
• ArcGIS JavaScript API (necessário somente para versões anteriores à 3.19 em ambientes desconectados). Por padrão, ele usará Javascript API instalada com o Portal.
• Portas HTTPs a serem usadas (por padrão, ele usará 5080 e 5443)
• Certificados SSL (Requer o formato de certificado .pem ou .pfx usado pelo web adaptor do Portal)
• URL de host do site Survey123 Geralmente será https://localhost:5443 ou https://FULLYQUALIFIEDDOMAINNAME:5443 (esta é a URL http ou https para a máquina que hospeda seu site Survey123 – lembre-se de incluir o número da porta). Isso é adicionado como um redirectURI ao seu Portal para permitir o login.
• Configurações para ambientes desconectados. Selecionando Sim para a pergunta "Você está instalando o site Survey123 em um ambiente desconectado sem acesso à Internet?" define as propriedades da Organização Survey123 que evitam que o Survey123 Connect faça chamadas pela Internet (para coisas como vídeos tutoriais, Twitter e Geonet).

Confirmar as configurações e clicar em Enviar atualiza o arquivo config.json, também

• Importa os arquivos de certificado para a pasta ~ArcGIS\Survey123website\server\cert\
• Anexa a URL do host do site Survey123 como uma URL de redirecionamento ao AppID survey123hub
• Atualiza as Propriedades da Organização Survey123 (basemapsGroupQuery, showCommunityContent e showTutorialContent)

Abra o arquivo config.json em um editor de texto para visualizar as configurações atualizadas.

ArcGIS Enterprise com autenticação Windows (WA)

• Se o site Survey123 não estiver instalado na mesma URL de host do ArcGIS Enterprise, consulte a seção Executar pós-instalação manualmente abaixo.
• Se o site Survey123 estiver instalado na mesma URL de host do ArcGIS Enterprise, para permitir que as credenciais de login do ArcGIS Enterprise (IWA) sejam usadas a partir do navegador, vá para a seguinte URL para pós-instalação:

https://<survey123website.domain >:5443/share/post-install.html

Isto permite que as credenciais de registro do ArcGIS Enterprise (IWA) sejam utilizadas a partir do navegador.

A pós-instalação configura tudo listado acima, mas requer que um administrador do ArcGIS Enterprise adicione manualmente a URL de host do site Survey123, https://<survey123website.domain >:5443, como um redirectURI ao Portal para permitir o registro:

1. Entre na interface REST de administrador do portal, por exemplo:
   • https://portal_webadaptorhost.domain /portal_webadaptorname/portaladmin
2. Vá até Segurança > OAuth > Obter Informações do Aplicativo e insira o ID do Aplicativo survey123hub e clique em Obter Informações do Aplicativo.
3. Copie o conteúdo da resposta.
4. Volte ao OAuth e, desta vez, vá até Atualizar Informações do Aplicativo.
5. Cole a resposta copiada na caixa de entrada, certificando-se de adicionar a URL que você usará para acessar seu site Survey123 à lista de URLs de redirecionamento e clique em Atualizar Aplicativo. Isso pode incluir o ponto de acesso do proxy reverso se você pretende configurar um, por exemplo:
   • https://survey123website.domain /survey123
6. Repita a Etapa 2 para confirmar que seu redirectURI adicional foi adicionado com sucesso à lista.

Executar a pós-instalação manualmente

1. Copie seus arquivos de certificado (.pfx ou .pem) para a pasta cert de sua instalação, por exemplo:
   • ~\ArcGIS\Survey123website\server\cert\
   • Se estiver usando um arquivo .pfx, você precisará criptografar a senha fazendo uma solicitação à API REST do Survey123 instalada. A resposta pode ser copiada para o arquivo config.json (veja abaixo).
     • Isso é feito anexando sua senha .pfx a URL da API usando o parâmetro encrypt?text=, por exemplo:
     • https://<survey123website.domain>:5443/api/encrypt?text=<your_pfx_password>
   • A resposta será no formato: {"result":"a6c2812bed063dd9be"}, basta copiar o resultado, ou seja, a6c2812bed063dd9be, para uso posterior no arquivo config.json.
2. Um administrador do ArcGIS Enterprise precisa adicionar manualmente a URL do host do site Survey123, por exemplo:
   • https://<survey123website.domain >:5443 - Este é o redirectURI para o seu Portal.  Consulte as etapas 1 a 5 na seção anterior.
3. Abra o config.json em um editor de texto. Ele pode ser encontrado na pasta raiz do site Survey123, por exemplo: ~\ArcGIS\Survey123website
   • Atualize os seguintes parâmetros de acordo com seus requisitos:
     • portalUrl: URL do ArcGIS Enterprise, for example: https://portal_webadaptorhost.domain.com/portal_webadaptorname
     • arcgisJsAPi3Url: URL do ArcGIS JavaScript v3.x API, por exemplo: https://portal_webadaptorhost.domain.com/portal_webadaptorname/jsapi/jsapi/init.js (*Necessário apenas para versões anteriores a 3.19)
     • arcgisJsApiUrl: URL do ArcGIS JavaScript v4.x API, por exemplo: https://portal_webadaptorhost.domain.com/portal_webadaptorname/jsapi/jsapi4/init.js (*Necessário apenas para versões anteriores a 3.19)
     • httpPort: Porta HTTP do site Survey123 (o padrão é 5080)
     • https.port: Porta HTTPS do site Survey123 (o padrão é 5443)
     • https.cert: caminho para seu site Survey123 HTTPS Base64 Certificado de servidor ASCII (.pem) ("./sserver/cert/cert.pem" é o padrão).
     • https.key: caminho para o seu Survey123 website HTTPS Base64 Ascii chave de certificado do servidor (.pem) ("./server/cert/key.pem" é o padrão).
     • https.pfx: caminho para o arquivo de certificado binário HTTPS do site Survey123 (.pfx), por exemplo: "./server/cert/your_certificate.pfx"
     • https.passphrase: senha criptografada para o certificado binário HTTPS do site Survey123. Use o resultado de https://<survey123website.domain>:5443/api/encrypt?text=<your_pfx_password> como explicado acima para obter a senha criptografada.
4. Salve o arquivo config.json.
5. Reinicie o serviço Windows do site ArcGIS Survey123 e o serviço survey123 no Linux para que as alterações entrem em vigor.

Adicionar site Survey123 no Iniciador de Aplicativos do Portal Enterprise

1. Copie a URL do site Survey123.
2. Navegue até Portal Página Inicial > Conteúdo.
3. Escolha Adicionar/Criar Item e escolha Aplicativo.
4. Em Tipo de aplicativo , escolha Aplicativo da Web.
5. Cole a URL da Etapa 1.
6. Preencha os detalhes do aplicativo. Consulte: Gerenciar aplicativos no inicializador de aplicativos
7. Após o site Survey123 ser adicionado ao Conteúdo do Portal, navegue até a página de detalhes do item.
8. Copie a URL, por exemplo: https://DOMAIN.COM/PORTALWEBADAPTOR/home/item.html?id=123456789abcdefghi
9. Navegue até Página Inicial do Portal > Configurações > Segurança > Aplicativo.
10. Escolha adicionar o aplicativo e cole a URL da etapa 8.
11. Edite os detalhes necessários e prossiga para adicionar o site Survey123 como aplicativos registrados/aprovados.
12. Após a conclusão deste processo, o site Survey123 deverá aparecer no Portal App Launcher.