Configurando o Qlik Data Gateway - Direct Access

Este tópico descreve os pré-requisitos do Qlik Data Gateway - Direct Access, fornece instruções de instalação e descreve as limitações e considerações das quais você deve estar ciente ao trabalhar com o Qlik Data Gateway - Direct Access.

Melhores práticas ao usar o Qlik Data Gateway - Direct Access

Para uma experiência bem-sucedida ao usar o Qlik Data Gateway - Direct Access, é altamente recomendável seguir estas práticas recomendadas:

• Não use o mesmo Direct Access gateway para desenvolvimento, testes de aceitação do usuário e produção, pois isso aumentará o risco de sobrecarregar os recursos disponíveis e impactar a estabilidade do sistema. Do ponto de vista comercial, a combinação de recursos insuficientes e diminuição da estabilidade pode resultar em atrasos nas atualizações dos dados do aplicativo de produção.
• Para obter o desempenho ideal, instale o Direct Access gateway em um servidor que esteja o mais próximo possível da sua fonte de dados.

• O Direct Access gateway deve ser instalado em um Windows Server dedicado conforme estipulado nos requisitos de sistema abaixo. Não o instale no servidor de banco de dados real ou junto com outros produtos Qlik, incluindo, entre outros, o Qlik DataTransfer, o Qlik Sense Desktop e o Qlik Sense Enterprise.

Pré-requisitos do sistema

Esta seção descreve os requisitos de software, portas e hardware para uso do Qlik Data Gateway - Direct Access.

Pré-requisitos de software

• O gateway Direct Access deve ser instalado em uma máquina Windows Server atrás do seu firewall. O servidor deve ser capaz de acessar sua fonte de dados.

  Edições do Windows Server compatíveis:

  • 2016
  • 2019
  • 2022

• Três versões diferentes do .NET precisam ser instaladas. Instale somente as seguintes versões do .NET:

  • .NET 4.8: necessário para a instalação.

  • .NET 6.0.x Runtime (x64) e ASP.NET Core Runtime 6.0.x (x64) (última correção)

    Nota de notíciasA partir do Direct Access gateway 1.6.8, o .NET 6.0.x não será mais necessário.

  • .NET 8.0.x Runtime (x64) e ASP.NET Core Runtime 8.0.x (x64) (última correção)

  Nota informativaO Direct Access gateway 1.6.6 e 1.6.7 requer as versões 6.0.x e 8.0.x dos tempos de execução do .NET e do ASP.NET Core.

  Para obter instruções sobre como verificar a versão do .NET atualmente instalada, consulte https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed.

• Microsoft Visual C++ 2015-2022 Redistributable (x64). A configuração do Direct Access gateway solicitará que você instale o redistribuível se detectar que ele não está instalado no momento.

Pré-requisitos de software adicionais ao usar fontes de dados SAP

• Instale o SDK do SAP NetWeaver RFC na máquina do Qlik Data Gateway - Direct Access conforme descrito em Instalando o SDK do SAP NetWeaver RFC para o Qlik Data Gateway - Direct Access (somente em inglês).
• Instale o Microsoft Visual C++ 2013 Redistributable (x64) na máquina Qlik Data Gateway - Direct Access.

Portas e protocolos necessários

A seção a seguir lista as portas necessárias.

Portas de saída

A porta HTTPS/TCP-443 deve estar aberta para comunicação de saída com <tenant-id>.<region>.qlikcloud.com.

Portas internas

Veja abaixo uma lista de portas usadas para comunicação por processos internos de gateway de dados. Se alguma dessas portas estiver sendo usada por outro aplicativo, reconfigure o outro aplicativo ou desinstale-o.

Portas gerais

• 5050 (API REST do Connector Agent)
• 9027 (API REST do DCAAS)

Portas ODBC

• 3005 (API REST do ODBC Connector)
• 50060 (gRPC do ODBC Connector)

Portas SAP

• 3007 (API REST do conector SAP BW)
• 3008 (API REST do conector SAP SQL)
• 3009 (API REST do conector do SAP ODP)
• 50070 (conector SAP BW gRPC)
• 50080 (conector SAP SQL gRPC)
• 50090 (gRPC do conector do SAP ODP)

Protocolo WSS

Além do HTTPS, o gateway do Direct Access também usa o protocolo WSS (WebSocket Secure). Portanto, certifique-se de que seu firewall e servidor proxy (se você pretende usar um) estejam configurados para permitir conexões WSS de saída.

Hardware mínimo recomendado

• 8 núcleos

• 32 GB de memória

• 5 GB de armazenamento

Criptografia do sistema

O Qlik Cloud Government oferece suporte ao uso do Qlik Data Gateway - Direct Access somente quando o Windows está configurado para ser executado em um modo de operação aprovado pelo FIPS 140-2 (modo FIPS). Para ativar o modo FIPS, ative a política do Windows: Criptografia do sistema: Use algoritmos compatíveis com FIPS para criptografia, hash e assinatura. Para obter mais informações, consulte a etapa 3 do procedimento Usando o Windows em um modo de operação aprovado pelo FIPS 140-2.

Instalando o Qlik Data Gateway - Direct Access

A configuração do Direct Access gateway envolve procedimentos que precisam ser executados no centro de atividades de Administração e no servidor do Direct Access gateway.

Estágio um: baixe o Qlik Data Gateway - Direct Access

1. No centro de atividades de Administração, selecione Gateways de dados.

   Todos os gateways de dados existentes serão listados em uma tabela mostrando informações básicas sobre cada gateway.

2. Clique no botão Implementar da barra de ferramentas.

   O diálogo Implementar gateway de dados é aberto.

3. Selecione Data Gateway - Direct Access, aceite o Contrato do Cliente da Qlik e clique em Baixar. O arquivo de configuração do Direct Access gateway (qlik-data-gateway-direct-access.exe) será baixado em sua máquina.

Estágio dois: instale o Direct Access gateway em um servidor atrás do firewall, protegendo suas fontes de dados

Esta etapa envolve a instalação do Direct Access gateway. Você pode instalar o Direct Access gateway de forma interativa ou silenciosa.

Instalando o Direct Access gateway de forma interativa

1. Quando o download estiver concluído, copie o arquivo de instalação para uma máquina Windows Server atrás do firewall. Certifique-se de que a máquina possa se comunicar com suas fontes de dados.

2. Abra o arquivo para iniciar o Assistente de configuração. Continue clicando em Avançar até que a configuração esteja concluída.
   

   Nota informativa

   • O Direct Access gateway requer o Microsoft .NET 6.x e o .NET 8.x. Se a instalação detectar que uma versão anterior está instalada, você será solicitado a instalar essa versão necessária. Quando a instalação do .NET for concluída, você precisará reiniciar a máquina Direct Access gateway e executar a instalação do Direct Access gateway novamente.

   • A configuração solicitará que você instale o pacote redistribuível do Microsoft Visual C++ 2015-2022 (x64) se detectar que ele não está instalado no momento.

   • Durante a configuração, você tem a opção de alterar o caminho de instalação padrão (C:\Program Files\Qlik\ConnectorAgent).

Instalando, atualizando e desinstalando silenciosamente o Direct Access gateway

A instalação silenciosa do Direct Access gateway é útil, por exemplo, se você precisar instalar o Direct Access gateway em diversas máquinas em sua organização.

Pré-requisitos

Certifique-se de instalar as versões corretas de todos os softwares obrigatórios antes de iniciar a instalação silenciosa, pois, diferentemente da instalação interativa, isso não pode ser feito durante a instalação.

Instalando ou atualizando o Direct Access gateway

Abra um prompt CMD como administrador e execute o seguinte comando na pasta que contém o executável do Direct Access gateway:

qlik-data-gateway-direct-access.exe /S InstallPath="full-path" AcceptEula=yes

Em que o full-path deve ser substituído pelo caminho de instalação real entre aspas, por exemplo, "C:\TMP\Qlik".

Desinstalando o Direct Access gateway

Abra um prompt CMD como administrador e execute o seguinte comando na pasta que contém o executável do Direct Access gateway:

qlik-data-gateway-direct-access.exe /S /uninstall

Solução de problemas de instalação

Os arquivos de log de instalação fornecem informações que devem ajudar você (ou o Suporte Qlik) a solucionar falhas. O caminho completo para o arquivo de log é:

C:\Users\<user>\AppData\Local\Temp\Qlik Data Gateway - Direct Access_<carimbo de data/hora>.log

Estágio três: configurando o Direct Access gateway

Essa etapa inclui a configuração da URL de locatário do Qlik Cloud, a configuração opcional de um servidor proxy e a geração de uma chave de registro. Você precisará copiar a chave para as configurações do gateway de dados no centro de atividades de Administração (no estágio três abaixo). A chave é usada para estabelecer uma conexão autenticada entre o Direct Access gateway e o locatário do Qlik Cloud.

Na máquina do gateway Direct Access, abra um Prompt de Comando como administrador e altere o diretório de trabalho para a subpasta ConnectorAgent (C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent com uma instalação padrão).

Em seguida, continue conforme descrito abaixo.

Configurando o locatário do Qlik Cloud

Defina com qual locatário do Qlik Cloud se conectar. Para se conectar ao locatário por meio de um servidor proxy, adicione os parâmetros relevantes ao comando, conforme mostrado abaixo.

Comando para configurar o locatário do Qlik Cloud sem um servidor proxy:

Sintaxe:

connectoragent qcs set_config --tenant_url your-qlik-cloud-tenant-url

Exemplo:

connectoragent qcs set_config --tenant_url mytenant.us.qlikcloud.com

Comando para configurar o locatário do Qlik Cloud com um servidor proxy:

Sintaxe:

connectoragent qcs set_config --tenant_url your-qlik-cloud-tenant-url --proxy_url http://host:port --proxy_username username --proxy_password password

Exemplo:

connectoragent qcs set_config --tenant_url mytenant.us.qlikcloud.com --proxy_url http://myproxy:1212 --proxy_username admin --proxy_password f56weqs@

Para obter informações sobre limitações de proxy, consulte Conectando-se ao Qlik Cloud por meio de um servidor proxy.

Configurando o pacote de CA

O pacote de CA autentica a identidade do locatário do Qlik Cloud, garantindo assim uma conexão confiável.

Quem precisa configurar o pacote de CA?

O pacote de CA apenas precisará ser definido se você for:

• Um cliente Qlik Cloud Government
• Um cliente comercial do Qlik Cloud que usa um dispositivo de segurança que atua como um proxy e substitui as informações do certificado recebidas da Internet por seus próprios certificados raiz de CA

Qual pacote devo usar?

Os clientes devem usar o pacote de CA Qlik ou trazer seu próprio pacote de CA, da seguinte maneira:

• O Qlik fornece o pacote de CA: Deve ser usado por clientes Qlik Cloud Government com um ambiente padrão. Um ambiente padrão é um ambiente que não possui um dispositivo de segurança que atua como um proxy e substitui as informações do certificado recebidas da Internet por seus próprios certificados raiz da CA.

  Em uma instalação padrão do Direct Access gateway, o arquivo do pacote de CA pode ser encontrado no seguinte local: C:\Program Files\Qlik\ConnectorAgent\caBundle\qcg_ca_bundle.pem

  Nota informativaVocê pode renomear o arquivo de pacote de CA, mas certifique-se de que ele tenha uma extensão .pem (por exemplo, qlikcerts.pem). Em seguida, execute o(s) comando(s) descrito(s) abaixo.
• Os clientes trazem seu próprio pacote de CA: Deve ser usado se o ambiente do cliente estiver usando um dispositivo de segurança que atua como um proxy e substitui as informações do certificado recebidas da Internet por seus próprios certificados raiz de CA. Se esses certificados forem autoassinados, além do comando para definir o pacote CA, você também precisará executar o comando para permitir esse pacote de CA. Esses dois comandos estão descritos abaixo. Isso se aplica tanto a clientes do Qlik Cloud Government quanto a clientes comerciais do Qlik Cloud.

Comando para configurar o pacote de CA

Execute o comando a seguir para definir o pacote de certificados de CA:

Sintaxe:

connectoragent qcs set_config --ca_bundle_path path-to-ca-bundle-file

Exemplo:

connectoragent qcs set_config --ca_bundle_path c:\ca\cacerts.pem

Comando para permitir o pacote de CA

Alguns ambientes usam um dispositivo de segurança que atua como um proxy e substitui as informações do certificado recebidas da Internet por seus próprios certificados raiz de CA. Esse comando somente precisará ser executado se o próprio dispositivo de segurança usar um certificado autoassinado. Nesse caso, o pacote de CA pode não ser confiável, a menos que você execute o seguinte comando:

connectoragent qcs set_config --ca_bundle_allow_invalid_certs true

Gerando e mostrando a chave de registro

A chave é usada para estabelecer uma conexão autenticada entre o gateway Direct Access e o locatário do Qlik Cloud.

Comando para gerar a chave de registro

connectoragent qcs generate_keys

Comando para mostrar a chave de registro

connectoragent qcs get_registration

A chave é mostrada.

Copie a chave inteira, conforme mostrado no exemplo acima. Você precisará colá-la no centro de atividades de Administração no próximo estágio.

Estágio quatro: retorne ao centro de atividades de Administração e registre o gateway de dados

1. No centro de atividades de Administração, selecione Gateways de dados.

   Todos os gateways de dados existentes serão listados em uma tabela mostrando informações básicas sobre cada gateway.

2. Clique no botão Criar da barra de ferramentas.

   O diálogo Criar gateway de dados é aberto.

   

3. Especifique um nome para o gateway de dados.

4. Opcionalmente, forneça uma descrição para o gateway de dados.

5. Na lista suspensa de tipos de gateway de dados, selecione Direct Access.

6. Na lista suspensa Espaço associado , selecione um espaço.

   Ao associar o gateway Direct Access a um espaço, você deve estar ciente do seguinte:

   • Gateways de dados podem ser criados somente em espaços compartilhados ou gerenciados
   • Para poder criar uma conexão de dados em um espaço que usa um gateway de dados de outro espaço, você deve ter a função Pode consumir dados no espaço do gateway de dados.

   • Para poder criar um gateway de dados, o usuário precisa ser proprietário de um espaço ou ter a função Pode gerenciar. Além disso, o usuário precisa de Direito de usuário Professional ou Full User. Atribua Direito Professional manualmente ou ativando Habilitar atribuição dinâmica de usuários Professional no centro de atividades de Administração.

     Para obter mais informações sobre direitos de usuários e a atribuição dinâmica de acesso Professional, consulte Gerenciando direitos do usuário

   • Gateways de dados só podem ser associados a um único espaço.

7. Cole a chave de registro que você gerou anteriormente no campo Chave.

8. Clique em Criar.

   O gateway de dados é adicionado habilitado à lista Gateways de dados.

Estágio cinco: inicie o serviço Qlik Data Gateway - Direct Access no servidor do Direct Access gateway

No servidor do gateway Direct Access, faça o seguinte para iniciar o serviço:

• Abra o console de Serviços do Windows e inicie o serviço do Qlik Data Gateway - Direct Access.

• Abra um Prompt de Comando como administrador e altere o diretório de trabalho para a subpasta ConnectorAgent (C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent com uma instalação padrão). Em seguida, execute o seguinte comando:

  connectoragent service start

  Uma confirmação de que o serviço foi iniciado com êxito será exibida.

Veja também: Executando o serviço em uma conta diferente

Estágio seis: adicione uma conexão à sua fonte de dados

Localize seu gateway na lista Gateways de dados e verifique se o Estado é "Conectado" (talvez seja necessário atualizar seu navegador para ver o status atual). Em seguida, você pode adicionar uma conexão com a sua fonte de dados.

Há várias maneiras de carregar dados de fontes de dados: 

• Adicionando e gerenciando fontes de dados de espaços

• Carregando e gerenciando dados com o Gerenciador de dados

• Carregando e transformando dados com scripts

A lista de fontes de dados disponíveis conterá entradas duplicadas para as fontes de dados que oferecem suporte para a conectividade do gateway. As fontes de dados compatíveis com o gateway podem ser identificadas pelas palavras "via gateway Direct Access", que aparecem entre parênteses após o tipo de fonte.

Fontes de dados com suporte

• Fontes ODBC. Para obter mais informações, consulte Bancos de dados ODBC - Qlik Cloud (somente em inglês).

• Fontes do SAP BW, SAP SQL e SAP ODP. Requer o Direct Access gateway 1.2.0 ou posterior.

  Para obter informações sobre como configurar a conectividade com essas origens, consulte SAP NetWeaver (somente em inglês).

Limitações e considerações gerais

• O Direct Access gateway pode se conectar apenas a um único locatário.
• Se, por algum motivo, o servidor do Direct Access gateway for reinicializado durante o carregamento de um aplicativo Qlik, o recarregamento falhará. Reinicie o carregamento do aplicativo Qlik para atualizar os dados.

• As consultas de script de recarregamento não podem exceder 500.000 caracteres.

  Para obter informações sobre o recarregamento de scripts, consulte Recarregando scripts.