Configurar Qlik Data Gateway - Direct Access en un servidor Windows

Buenas prácticas en el uso de Qlik Data Gateway - Direct Access

Para disfrutar de una experiencia satisfactoria al utilizar Qlik Data Gateway - Direct Access, se recomienda encarecidamente seguir las siguientes prácticas recomendadas:

• No utilice la misma Direct Access gateway para el desarrollo, las pruebas de aceptación del usuario y la producción, ya que esto aumentará el riesgo de sobrecargar los recursos disponibles y afectará a la estabilidad del sistema. Desde una perspectiva empresarial, la combinación de recursos insuficientes y una menor estabilidad podría provocar retrasos en la actualización de los datos de las aplicaciones de producción.

• Para un rendimiento óptimo, instale Direct Access gateway en un servidor que esté lo más cerca posible de su fuente de datos.
• Direct Access gateway debe instalarse en un servidor Windows específico, tal como se estipula en los requisitos del sistema a continuación. No lo instale en el servidor de base de datos real ni junto con otros productos de Qlik, incluidos, entre otros, Qlik DataTransfer, Qlik Sense Desktop y Qlik Sense Enterprise.

Requisitos previos del sistema

Esta sección describe los requisitos de software, puertos y hardware para usar Qlik Data Gateway - Direct Access en un servidor Windows.

Instalar Qlik Data Gateway - Direct Access

La configuración de la pasarela Direct Access gateway implica procedimientos que deben realizarse tanto en el centro de actividades Administración como en el servidor de la pasarela Direct Access gateway.

Etapa uno: Descargar Qlik Data Gateway - Direct Access

1. En el centro de actividades Administración, seleccione Pasarelas de datos.

   Cualquier pasarela de datos existente se indicará en una tabla que muestra información básica sobre cada puerta de enlace.

2. Haga clic en el botón de la barra de herramientas Implementar.

   Se abre el cuadro de diálogo Implementar la pasarela de datos.

3. Seleccione Pasarela de datos de acceso directo (Windows), acepte el Acuerdo de cliente de Qlik y haga clic en Descargar. El archivo de configuración de la pasarela Direct Access gateway (qlik-data-gateway-direct-access.exe) se descargará en su equipo.

Segunda etapa: instale Direct Access gateway en un servidor situado detrás del cortafuegos que protege sus fuentes de datos.

Esta etapa consiste en instalar Direct Access gateway. Puede instalar Direct Access gateway de forma interactiva o silenciosa.

Instalar Direct Access gateway de forma interactiva

1. Cuando se complete la descarga, copie el archivo de instalación en una máquina con Windows Server detrás del firewall. Asegúrese de que la máquina pueda comunicarse con sus fuentes de datos.

2. Abra el archivo qlik-data-gateway-direct-access.exe para iniciar el asistente de configuración.

   Nota informativa

   • Direct Access gateway requiere Microsoft .NET 6.x y .NET 8.x. Si el programa de instalación detecta que hay instalada una versión anterior, se le pedirá que instale la versión que precisa. Cuando se complete la instalación de .NET, deberá reiniciar la máquina de Direct Access gateway y luego ejecutar la instalación de Direct Access gateway nuevamente.

   • El programa de instalación le pedirá que instale Microsoft Visual C++ 2015-2022 Redistribuible (x64) si detecta que no está instalado actualmente.

   Nota informativa

   • Durante la configuración, puede anular opcionalmente los siguientes valores predeterminados:
     • La ruta de instalación(C:\Archivos de programa\Qlik\ConnectorAgent).

     • La cuenta de servicio de Windows bajo la que se instalará Direct Access gateway(LocalSystem). La cuenta de servicio especificada debe tener tanto el derecho "Abrir sesión como servicio" como el permiso de escritura "Write" en la carpeta de instalación de la pasarela de datos Direct Access gateway.

3. Pulse Siguiente hasta que se complete la configuración.
   

Instalar, actualizar y desinstalar Direct Access gateway de forma silenciosa

Instalar Direct Access gateway de forma silenciosa es útil, por ejemplo, si necesita realizar la instalación de Direct Access gateway en varias máquinas de su organización. Si es necesario, también puede anular la cuenta de servicio predeterminada de Windows(LocalSystem).

Requisitos previos

Asegúrese de instalar las versiones correctas de todo el software necesario antes de comenzar la instalación silenciosa ya que, a diferencia de la instalación interactiva, esto no se puede hacer durante la instalación.

Instalar o actualizar Direct Access gateway

Abra un mensaje de CMD como administrador y ejecute el siguiente comando desde la carpeta que contiene el ejecutable Direct Access gateway:

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

Donde full-path debe reemplazarse por la ruta de instalación real entre comillas dobles, por ejemplo, "C:\TMP\Qlik".

Anular la cuenta de servicio predeterminada de Windows

De manera predeterminada, Direct Access gateway se instala bajo la cuenta de servicio de Windows LocalSystem .

Para instalar Direct Access gateway bajo una cuenta diferente, incluya los siguientes parámetros en su comando:

• ServiceAccount: el nombre de la cuenta de servicio.

  Nota informativaLa cuenta de servicio especificada debe tener tanto el derecho "Abrir sesión como servicio" como el permiso de escritura "Write" en la carpeta de instalación de la pasarela de datos Direct Access gateway.
• ServicePassword: la contraseña de la cuenta de servicio especificada.

Ejemplo de comando con parámetros para anular la cuenta de servicio de Windows

qlik-data-gateway-direct-access.exe /S InstallPath="C:\TMP\Qlik" AcceptEula=yes ServiceAccount="qliktech.com\user" ServicePassword=kZmbkb8m8BGGz91

Desinstalar Direct Access gateway

Abra un mensaje de CMD como administrador y ejecute el siguiente comando desde la carpeta que contiene el ejecutable Direct Access gateway:

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

Solución de problemas en la instalación

Los archivos de registro de la instalación pueden ser útiles para solucionar problemas con la instalación o la actualización:

Desde Direct Access gateway 1.7.7, la ruta completa a los archivos de registro es:

<carpeta de instalación de Direct Access gateway>\data\logs\_<TimestampQlik Data Gateway - Direct Access>.log

Si su versión de Direct Access gateway es anterior a la 1.7.7, la ruta completa a los archivos de registro es:

C:\Users\<user>\AppData\Local\Temp\_<TimestampQlik Data Gateway - Direct Access>.log

Etapa cuatro: registre la pasarela de datos

El siguiente paso es registrar la pasarela de datos. Esto se puede hacer a través del centro de actividades Administración o en la línea de comandos.

Opción 1: a través del centro de actividades Administración

Puede registrar la pasarela mediante el centro de actividades Administración. Vea Opción 1: desde el centro de actividades Administración.

Opción 2: registro automático mediante la línea de comandos

También puede registrar Direct Access gateway automáticamente desde la línea de comandos, sin utilizar el centro de actividades Administración. Este método utiliza un token de sesión de corta duración generado a partir de un cliente de OAuth.

Nota informativaEl registro automático solo se admite a través de la línea de comandos. Actualmente no está disponible una API de REST para el registro automático de la puerta de enlace.

Requisitos previos

Una clave de API con permiso de administrador de espacio empresarial inquilino para crear y administrar clientes de OAuth.

Registro de la pasarela con registro automático

1. Genere una clave JSON Web Key (JWK) en la máquina de Direct Access gateway. Este comando crea claves privadas en la máquina de Direct Access gateway:

   ConnectorAgent.exe qcs generate_jwk

2. Copie la JWK que devuelve el comando.

3. Utilizando la clave de API, cree un cliente OAuth para la pasarela a través de la API de administración del espacio empresarial inquilino, proporcionando la JWK que copió en el paso anterior.

   curl "https://<tenant-url>/api/v1/oauth-clients" -X POST -H 'accept: application/json' -H 'content-type: application/json' -H 'authorization: Bearer <api-key>' -d '{"appType":"web","clientName":"<client-name>","description":"","allowedScopes":["admin.direct-access-gateways:register_gateway","admin.direct-access-gateways:delete_gateway"],"allowedAuthMethods":["private_key_jwt"],"publicKeys":[<jwk>],"allowedGrantTypes":["client_credentials"]}'

4. Copie el valor client_id devuelto en la respuesta.

5. Establezca el método de consentimiento del cliente OAuth como de confianza.

   curl "https://<tenant-url>/api/v1/oauth-clients/<client-id>/connection-configs/me" -X PATCH -H 'accept: application/json' -H 'content-type: application/json' -H 'authorization: Bearer <api-key>' -d '[{"op":"replace","path":"/consentMethod","value":"trusted"}]'

6. Cree una aserción de registro en la máquina Direct Access gateway:

   ConnectorAgent.exe qcs generate_registration_assertion --tenant_url <tenant-url> --client-id <client-id>

7. Solicite un token de acceso. Esto también activa la creación automática de la cuenta de usuario bot utilizada por la pasarela.

   curl "https://<tenant-url>/oauth/token" -X POST -H 'content-type: application/x-www-form-urlencoded' -d "grant_type=client_credentials" -d "client_id=<client-id>" -d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" -d "client_assertion=<assertion>" -d "scope=admin.direct-access-gateways:register_gateway admin.direct-access-gateways:delete_gateway"

8. Busque el usuario bot creado automáticamente.

   curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <API-key>'

9. Copie el ID de my-bot-client.

10. Cree un rol "DAG Registration".

    curl "https://<tenant-url>/api/v1/roles" -X POST -H 'accept: application/json' -H 'content-type: application/json' -H  'authorization: Bearer API-key' -d '{"name":"DAG Registration","description":"Role for registering a gateway","assignedScopes":["admin.direct-access-gateways:register_gateway", "admin.direct-access-gateways:delete_gateway"]}'

11. Asigne roles a nivel de espacio empresarial inquilino al usuario bot.

    curl "https://<tenant-url>/api/v1/users/<bot-user-ID>" -X PATCH  -H 'accept: application/json' -H 'content-type: application/json' -H  'authorization: Bearer <API-key>' -d ' [ { "op": "replace", "path": "/assignedRoles", "value": [ { "name": "DAG Registration" } ] } ]'

12. Obtenga el espacio de Direct Access Gateway.

    curl "https://<tenant-url>/api/v1/spaces" -H  'authorization: Bearer <API-key>'

13. Copie el ID del espacio de Direct Access Gateway.

14. Añada el usuario bot al espacio con el permiso Puede editar.

    curl "https://<tenant-url>/api/v1/spaces/<DAG-space-ID>/assignments" -X POST -H 'accept: application/json' -H 'content-type: application/json' -H  'authorization: Bearer <API-key>' -d '{"assigneeId": "<Bot-user-ID>","roles": ["consumer","dataconsumer","producer"], "type": "user"}'

15. En caso de que la aserción existente haya caducado, genere una nueva.

    ConnectorAgent.exe qcs generate_registration_assertion --tenant_url <tenant-url> --client-id <client-ID>

16. Registre la pasarela:

    ConnectorAgent.exe qcs register_gateway --tenant_url <tenant-url> --gateway_name <gateway-name> --gateway_description <gateway-description> --space_name <space-name> --client-id <client-ID> --assertion <assertion>

Eliminación de una pasarela registrada automáticamente

Siga los siguientes pasos para cancelar el registro de una pasarela de datos que se registró mediante el método automático basado en token de sesión descrito anteriormente. Estos pasos también eliminan el cliente OAuth, el usuario bot y el rol que se crearon para ella.

1. Genere una aserción, tal y como se describe en el paso seis de Registro automático de pasarela de datos mediante un token de sesión.

2. Elimine la pasarela de datos:

   ConnectorAgent.exe qcs delete_gateway --tenant_url <tenant-url> --gateway_name <gateway-name> --client-id <client-ID> --assertion <assertion>

3. Elimine el JWK.

   ConnectorAgent.exe qcs delete_jwk

4. Busque la cuenta de usuario de bot que se creó para la pasarela.

   curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <api-key>'

5. Copie el ID del bot.

6. Elimine esta cuenta de usuario de bot.

   curl -X DELETE "https://<tenant-url>/api/v1/users/<bot-user-ID>" -H "Authorization: Bearer <api-key>"

7. Busque el rol “DAG Registration” que se creó para la pasarela.

   curl "https://<tenant-url>/api/v1/roles?limit=1&filter=(name eq \"DAG Registration\")" -H "Authorization: Bearer <api-key>"

8. Copie el ID de rol.

9. Elimine este rol.

   curl -X DELETE "https://<tenant-url>/api/v1/roles/<role-ID>" -H "Authorization: Bearer <api-key>"

10. Elimine el cliente de OAuth.

    curl -X DELETE "https://<tenant-url>/api/v1/oauth-clients/<client-ID>" -H "qlik-confirm-delete: <client-ID>" -H "Authorization: Bearer <api-key>"

Etapa cinco: Inicie el servicio Qlik Data Gateway - Direct Access en el servidor de la pasarela de acceso directo

En el servidor de puerta de enlace de Acceso directo, realice una de las siguientes acciones para iniciar el servicio:

• Abra la consola de Servicios de Windows e inicie el servicio Qlik Data Gateway - Direct Access.

• Abra un símbolo del sistema como administrador y cambie el directorio de trabajo a la subcarpeta ConnectorAgent (C:\Archivos de programa\Qlik\ConnectorAgent\ConnectorAgent con una instalación predeterminada). Luego, ejecute. el siguiente comando:

  connectoragent service start

  Se mostrará una confirmación de que el servicio se inició correctamente.

Vea también: Ejecutar el servicio con una cuenta diferente

Etapa seis: Agregue una conexión a su fuente de datos

Vea Etapa seis: Agregue una conexión a su fuente de datos.

Fuentes de datos compatibles

Los siguientes conectores ODBC son compatibles con las instalaciones de servidor de Windows:

• Fuentes ODBC. Para más información, consulte Bases de datos ODBC - Qlik Cloud (solo en inglés).
• Fuentes REST. Para más información, consulte Fuentes REST - Qlik Cloud (solo en inglés).

• Fuentes SAP BW, SAP SQL y SAP ODP. Requiere Direct Access gateway 1.2.0 o posterior.

  Para obtener información sobre cómo configurar la conectividad con estas fuentes, consulte SAP NetWeaver (solo en inglés).