Configuration de Qlik Data Gateway - Direct Access

Cette rubrique souligne les conditions préalables requises de Qlik Data Gateway - Direct Access, fournit des instructions d'installation et décrit les limitations et les considérations à prendre en compte lors de l'utilisation de Qlik Data Gateway - Direct Access.

Bonnes pratiques lors de l'utilisation de Qlik Data Gateway - Direct Access

Pour une expérience concluante lors de l'utilisation de Qlik Data Gateway - Direct Access, il est vivement recommandé de suivre les bonnes pratiques suivantes :

• N'utilisez pas la même Direct Access gateway pour le développement, les tests d'acceptation utilisateur et la production, car cela augmenterait le risque de surcharge des ressources disponibles et aurait un impact sur la stabilité du système. D'un point de vue commercial, la combinaison de ressources insuffisantes et d'une stabilité réduite peut entraîner des retards de mise à jour des données des applications de production.
• Pour des performances optimales, installez la Direct Access gateway sur un serveur aussi proche que possible de votre source de données.

• La Direct Access gateway doit être installée sur un Window Server dédié, comme stipulé dans la configuration système requise ci-dessous. Ne l'installez pas sur le serveur de base de données réel ou avec d'autres produits Qlik, y compris, sans s'y limiter, Qlik DataTransfer, Qlik Sense Desktop et Qlik Sense Enterprise.

Conditions préalables requises du système

Cette section décrit le logiciel, les ports et les conditions matérielles pour utiliser Qlik Data Gateway - Direct Access.

Conditions préalables requises des logiciels

• La Direct Access gateway doit être installée sur un ordinateur Windows Server derrière votre pare-feu. Le serveur doit pouvoir accéder à votre source de données.

  Éditions Windows Server supportées :

  • 2016
  • 2019
  • 2022

• Il convient d'installer trois versions différentes de .NET. Installez les versions .NET suivantes uniquement :

  • .NET 4.8 : obligatoire pour l'installation.

  • .NET 6.0.x Runtime (x64) et ASP.NET Core Runtime 6.0.x (x64) (dernier patch)

    Note ActualitésÀ partir de Direct Access gateway 1.6.8, .NET 6.0.x n'est plus obligatoire.

  • .NET 8.0.x Runtime (x64) et ASP.NET Core Runtime 8.0.x (x64) (dernier patch)

  Note InformationsDirect Access gateway 1.6.6 et 1.6.7 nécessitent les deux versions 6.0.x et 8.0.x de .NET et ASP.NET Core Runtimes.

  Pour savoir comment vérifier la version .NET actuellement installée, voir https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed (en anglais).

• Microsoft Visual C++ 2015-2022 Redistributable (x64). Lors de la configuration de Direct Access gateway, il vous sera demandé d'installer le logiciel redistribuable, si le système détecte qu'il n'est pas installé.

Conditions préalables requises supplémentaires des logiciels lors de l'utilisation de sources de données SAP

• Installez le SDK SAP NetWeaver RFC sur le poste Qlik Data Gateway - Direct Access comme décrit à la section Installation du SDK SAP NetWeaver RFC pour Qlik Data Gateway - Accès direct (uniquement en anglais).
• Installez Microsoft Visual C++ 2013 Redistributable (x64) sur le poste Qlik Data Gateway - Direct Access.

Ports et protocoles requis

La section suivante indique les ports requis.

Ports sortants

Le port HTTPS/TCP-443 doit être ouvert pour la communication sortante vers <tenant-id>.<region>.qlikcloud.com.

Ports internes

Vous trouverez ci-dessous une liste de ports utilisés par les processus de passerelle de données internes pour communiquer. Si l'un de ces ports est utilisé par une autre application, reconfigurez l'autre application ou désinstallez-la.

Ports généraux

• 5050 (API REST d'agent de connecteur)
• 9027 (API REST DCAAS)

Ports ODBC

• 3005 (API REST de connecteur ODBC)
• 50060 (gRPC de connecteur ODBC)

Ports SAP

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

Protocole WSS

Outre HTTPS, la passerelle Accès direct utilise également le protocole WSS (WebSocket Secure). Par conséquent, assurez-vous que votre pare-feu et votre serveur proxy (si vous prévoyez d'en utiliser un) sont configurés de sorte à autoriser les connexions WSS sortantes.

Matériel minimal recommandé

• 8 cœurs

• Mémoire de 32 Go

• Stockage de 5 Go

Chiffrement système

Qlik Cloud Government prend en charge l'utilisation de Qlik Data Gateway - Direct Access uniquement lorsque Windows est configuré de sorte à s'exécuter dans un mode de fonctionnement approuvé par FIPS 140-2 (mode FIPS). Pour activer le mode FIPS, activez la politique Windows : Chiffrement système : utilisez des algorithmes compatibles FIPS pour le chiffrement, le hachage et la signature. Pour plus d'informations, voir l'étape 3 de la procédure Utilisation de Windows dans un mode de fonctionnement approuvé par FIPS 140-2.

Installation de Qlik Data Gateway - Direct Access

La configuration de Direct Access gateway implique des procédures à réaliser dans le centre d'activités Administration et sur le serveur Direct Access gateway.

Étape un : téléchargez Qlik Data Gateway - Direct Access

1. Dans le centre d'activités Administration, sélectionnez Passerelles de données.

   Toutes les passerelles de données existantes seront répertoriées dans un tableau indiquant des informations de base sur chacune.

2. Cliquez sur le bouton de barre d'outils Déployer.

   La boîte de dialogue Déployer la passerelle de données s'ouvre.

3. Sélectionnez Passerelle de données - Accès direct, acceptez le Contrat client Qlik et cliquez sur Télécharger. Le fichier de configuration Direct Access gateway (qlik-data-gateway-direct-access.exe) sera téléchargé sur votre poste.

Étape deux : installez la Direct Access gateway sur un serveur derrière le pare-feu protégeant vos sources de données

Cette étape implique l'installation de Direct Access gateway. Vous pouvez installer Direct Access gateway de manière interactive ou en mode silencieux.

Installation interactive de Direct Access gateway

1. Une fois le téléchargement terminé, copiez le fichier de configuration sur un poste Windows Server derrière le pare-feu. Assurez-vous que le poste peut communiquer avec vos sources de données.

2. Ouvrez le fichier pour lancer l'Assistant de configuration. Continuez en cliquant sur Suivant jusqu'à la fin de la configuration.
   

   Note Informations

   • Direct Access gateway nécessite Microsoft .NET 6.x et .NET 8.x. Si la configuration détecte qu'une version précédente est installée, vous serez invité à installer la version requise. Une fois l'installation de .NET terminée, vous devrez redémarrer le poste Direct Access gateway, puis exécuter de nouveau la configuration de Direct Access gateway.

   • Lors de la configuration, il vous sera demandé d'installer Microsoft Visual C++ 2015-2022 Redistributable (x64), si le système qu'il n'est pas installé.

   • Lors de la configuration, vous pouvez éventuellement modifier le chemin d'accès par défaut de l'installation (C:\Program Files\Qlik\ConnectorAgent).

Installation, mise à niveau et désinstallation en mode silencieux de Direct Access gateway

L'installation de Direct Access gateway en mode silencieux s'avère utile si vous devez installer Direct Access gateway sur plusieurs postes au sein de votre entreprise.

Conditions préalables requises

Assurez-vous d'installer les versions correctes conformément aux Conditions préalables requises des logiciels avant de démarrer l'installation en mode silencieux, car, contrairement à l'installation interactive, cela ne peut pas être effectué lors de l'installation.

Installation ou mise à niveau de Direct Access gateway

Ouvrez une invite CMD en tant qu'administrateur et exécutez la commande suivante depuis le dossier contenant l'exécutable Direct Access gateway :

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

Où full-path doit être remplacé par le chemin d'accès à l'installation réel entre guillemets, par exemple, "C:\TMP\Qlik".

Désinstallation de Direct Access gateway

Ouvrez une invite CMD en tant qu'administrateur et exécutez la commande suivante depuis le dossier contenant l'exécutable Direct Access gateway :

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

Dépannage de l'installation

Les fichiers journaux de l'installation fournissent des informations qui devraient pouvoir vous aider (ou aider Qlik Support) à résoudre les problèmes. Le chemin d'accès complet au fichier journal est le suivant :

C:\Users\<utilisateur>\AppData\Local\Temp\Qlik Data Gateway - Direct Access_<horodatage>.log

Étape trois : configurez la Direct Access gateway

Cette étape inclut la configuration de l'URL de votre client Qlik Cloud, en configurant éventuellement un serveur proxy et en générant une clé d'inscription. Vous devrez copier la clé dans les paramètres de la passerelle de données dans le centre d'activités Administration (à l'étape trois ci-dessous). La clé est utilisée pour établir une connexion authentifiée entre Direct Access gateway et le client Qlik Cloud.

Sur le poste Direct Access gateway, ouvrez une invite de commande en tant qu'administrateur et définissez le répertoire de travail sur le sous-dossier ConnectorAgent (C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent avec une installation par défaut).

Ensuite, procédez comme suit.

Configuration du client Qlik Cloud

Indiquez le client Qlik Cloud auquel se connecter. Pour vous connecter au client via un serveur proxy, ajoutez les paramètres pertinents à la commande, comme indiqué ci-dessous.

Commande permettant de configurer le client Qlik Cloud sans serveur proxy :

Syntaxe :

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

Exemple :

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

Commande permettant de configurer le client Qlik Cloud avec un serveur proxy :

Syntaxe :

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

Exemple :

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

Pour des informations sur les limitations en matière de proxy, voir Connexion à Qlik Cloud via un serveur proxy.

Activation du CA bundle

Le CA bundle authentifie l'identité du client Qlik Cloud, garantissant ainsi une connexion fiable.

Qui doit activer le CA bundle ?

Le CA bundle doit être activé uniquement si vous êtes :

• un utilisateur Qlik Cloud Government ;
• un utilisateur Qlik Cloud commercial qui utilise un appliance de sécurité jouant le rôle de proxy et remplaçant les informations de certificat reçues via Internet par les certificats racines provenant de sa propre autorité de certification (CA).

Quel bundle utiliser ?

Les utilisateurs doivent utiliser le Qlik CA bundle ou apporter leur propre CA bundle, comme suit :

• Qlik fournit le CA bundle : Doit être utilisé par les utilisateurs Qlik Cloud Government disposant d'un environnement standard. Un environnement standard est un environnement qui n'a pas d'appliance de sécurité jouant le rôle de proxy et remplaçant les informations de certificat reçues via Internet par les certificats racines provenant de sa propre autorité de certification (CA).

  Dans une installation Direct Access gateway par défaut, le fichier CA bundle se trouve à l'emplacement suivant : C:\Program Files\Qlik\ConnectorAgent\caBundle\qcg_ca_bundle.pem

  Note InformationsVous pouvez renommer le fichier CA bundle, mais vérifiez qu'il dispose d'une extension .pem (par exemple, qlikcerts.pem). Exécutez ensuite la ou les commandes décrites ci-dessous.
• Les utilisateurs apportent leur propre CA bundle : Doit être utilisé si l'environnement de l'utilisateur utilise un appliance de sécurité qui joue le rôle de proxy et remplace les informations de certificat reçues via Internet par les certificats racines provenant de sa propre autorité de certification (CA). Si ces certificats sont auto-signés, en plus de la commande permettant d'activer le CA bundle, vous devez exécuter la commande autorisant le CA bundle. Ces deux commandes sont décrites ci-dessous. Cela s'applique aux utilisateurs Qlik Cloud Government comme aux utilisateurs Qlik Cloud commerciaux.

Commande permettant d'activer le CA bundle

Pour activer le CA certificate bundle, exécutez la commande suivante :

Syntaxe :

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

Exemple :

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

Commande permettant d'autoriser le CA bundle

Certains environnements utilisent un appliance de sécurité qui joue le rôle de proxy et remplace les informations de certificat reçues via Internet par les certificats racines provenant de sa propre autorité de certification (CA).. Cette commande doit être exécutée uniquement si l'appliance de sécurité lui-même utilise un certificat auto-signé. Dans ce cas, il se peut que le CA bundle ne soit pas considéré comme fiable tant que vous n'avez pas exécuté la commande suivante :

connectoragent qcs set_config --ca_bundle_allow_invalid_certs true

Génération et affichage de la clé d'inscription

La clé est utilisée pour établir une connexion authentifiée entre Direct Access gateway et le client Qlik Cloud.

Commande permettant de générer la clé d'inscription

connectoragent qcs generate_keys

Commande permettant d'afficher la clé d'inscription

connectoragent qcs get_registration

La clé s'affiche.

Copiez la clé complète, comme indiqué dans l'exemple ci-dessus. Vous devrez la coller dans le centre d'activités Administration à l'étape suivante.

Étape quatre : revenez au centre d'activités Administration et enregistrez la passerelle de données

1. Dans le centre d'activités Administration, sélectionnez Passerelles de données.

   Toutes les passerelles de données existantes seront répertoriées dans un tableau indiquant des informations de base sur chacune.

2. Cliquez sur le bouton de barre d'outils Créer.

   La boîte de dialogue Créer une passerelle de données s'ouvre.

   

3. Spécifiez un nom pour la passerelle de données.

4. Vous pouvez éventuellement fournir une description pour la passerelle de données.

5. Dans la liste déroulante Type de la passerelle de données, sélectionnez Accès direct.

6. Dans la liste déroulante Espace associé, sélectionnez un espace.

   Lors de l'association de Direct Access gateway à un espace, faites attention aux points suivants :

   • Il est possible de créer des passerelles de données uniquement dans des espaces partagés ou gérés.
   • Pour pouvoir créer une connexion de données dans un espace qui utilise une passerelle de données d'un autre espace, vous devez être titulaire du rôle Peut consommer des données dans l'espace de la passerelle de données.

   • Pour pouvoir créer une passerelle de données, l'utilisateur doit être propriétaire d'un espace ou titulaire du rôle Peut gérer. De plus, l'utilisateur doit être titulaire de Droit Professional ou Full User. Affectez Droit Professionnel manuellement ou en sélectionnant Activer l'affectation dynamique des utilisateurs Professional dans le centre d'activités Administration.

     Pour plus d'informations sur les droits d'utilisateur et l'affectation dynamique de l'accès Professional, consultez Gestion des droits d'utilisateur.

   • Les passerelles de données peuvent être associées à un seul espace.

7. Collez la clé d'inscription précédemment générée dans le champ Clé.

8. Cliquez sur Créer.

   La passerelle de données est ajoutée à l'état activé à la liste Passerelles de données.

Étape cinq : démarrez le service Qlik Data Gateway - Direct Access sur le serveur Direct Access gateway

Sur le serveur Direct Access gateway, effectuez l'une des opérations suivantes pour démarrer le service :

• Ouvrez la console Services Windows et démarrez le service Qlik Data Gateway - Direct Access.

• Ouvrez une invite de commande en tant qu'administrateur et définissez le répertoire de travail sur le sous-dossier ConnectorAgent (C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent avec une installation par défaut). Ensuite, exécutez la commande suivante :

  connectoragent service start

  Une confirmation que le service a correctement démarré s'affiche.

Consultez aussi : Exécution du service sous un autre compte

Étape six : ajoutez une connexion à votre source de données

Recherchez votre passerelle dans la liste Passerelles de données et vérifiez que son État est Connecté (pour voir l'état actif, vous devrez peut-être actualiser votre navigateur). Vous pouvez ensuite ajouter une connexion à votre source de données.

Il existe plusieurs façons de charger des données à partir de sources de données :

• Ajout et gestion de sources de données provenant d'espaces

• Chargement et gestion de données avec Data Manager

• Chargement et transformation de données avec un script

Pour les sources de données supportant la connectivité par passerelle, la liste des sources de données disponibles contiendra des entrées en double. Les sources de données compatibles avec des passerelles peuvent être identifiées par les termes « via Direct Access gateway » qui apparaissent entre parenthèses après le type de source.

Sources de données supportées

• Sources ODBC. Pour plus d'informations, voir Bases de données ODBC ‒ Qlik Cloud (uniquement en anglais).

• Sources SAP BW et SAP SQL. Nécessite Direct Access gateway 1.2.0 ou une version ultérieure.

  Pour des informations sur la configuration de la connectivité à ces sources, voir SAP NetWeaver (uniquement en anglais).

Restrictions et considérations générales

• Direct Access gateway peut se connecter à un seul client.
• Si, pour une raison ou une autre, le serveur Direct Access gateway est redémarré lors du chargement d'une application Qlik, le chargement échoue. Redémarrez le chargement de l'application Qlik pour actualiser les données.

• Les requêtes d'actualisation de script ne peuvent pas dépasser 500 000 caractères.

  Pour des informations sur l'actualisation des scripts, voir Actualisation des scripts.