Configurazione di Qlik Data Gateway - Accesso diretto su un server Windows

Procedure consigliate quando si utilizza Qlik Data Gateway - Accesso diretto

Per un'esperienza ottimale quando si utilizza Qlik Data Gateway - Accesso diretto, si consiglia vivamente di seguire le seguenti procedure consigliate:

• Non usare lo stesso Gateway di Direct Access per lo sviluppo, il testing dell'accettazione degli utenti e la produzione, poiché così facendo aumenterà il rischio di sovraccaricare le risorse disponibili con conseguenze negative sulla stabilità del sistema. Da una prospettiva aziendale, la combinazione di risorse insufficienti e stabilità ridotta, possono causare un ritardo negli aggiornamenti dei dati di applicazione di produzione.

• Per ottenere prestazioni ottimali, installare Gateway di Direct Access su un server il più vicino possibile alla sorgente dati.
• È necessario installare Gateway di Direct Access su un server Windows Server dedicato, come indicato nei requisiti di sistema riportati di seguito. Non installare sul server del database corrente o insieme ad altri prodotti Qlik, inclusi ma non limitati a, Qlik DataTransfer, Qlik Sense Desktop e Qlik Sense Enterprise.

Prerequisiti di sistema

Questa sezione descrive i requisiti relativi a software, porte e hardware per l'utilizzo di Qlik Data Gateway - Accesso diretto su un server Windows.

Installazione di Qlik Data Gateway - Accesso diretto

La configurazione del gateway di Direct Access comporta procedure che devono essere eseguite sia nel centro attività Amministrazione sia sul server del gateway di Direct Access.

Passaggio uno: scaricare Qlik Data Gateway - Accesso diretto

1. Nel centro attività Amministrazione, selezionare Gateway dati.

   Tutti i gateway di dati esistenti saranno elencati in una tabella che riporta le informazioni di base su ciascun gateway.

2. Fare clic sul pulsante della barra degli strumenti Distribuisci.

   Si apre la finestra di dialogo Distribuisci gateway dati.

3. Seleziona Data Gateway Direct Access (Windows), accetta il Contratto con il cliente Qlik, e fai clic su Scarica. Il file di installazione del gateway di Direct Access (qlik-data-gateway-direct-access.exe) verrà scaricato sul computer.

Passaggio due: installare Gateway di Direct Access su un server con firewall che protegge le sorgenti dati

Questa fase prevede l'installazione del Gateway di Direct Access. È possibile installare Gateway di Direct Access automaticamente o in modo interattivo.

Installazione di Gateway di Direct Access in modo interattivo

1. Al termine del download, copiare il file di installazione su un computer Windows Server dietro il firewall. Assicurarsi che il computer possa comunicare con le proprie sorgenti dati.

2. Aprire il file qlik-data-gateway-direct-access.exe per avviare la procedura guidata di installazione.

   Nota informatica

   • Gateway di Direct Access richiede Microsoft .NET 6.x e .NET 8.x. Se la configurazione rileva che è installata una versione precedente, verrà richiesto di installare la versione richiesta. Al termine dell'installazione di .NET, è necessario riavviare il computer del Gateway di Direct Access ed eseguire nuovamente la configurazione del Gateway di Direct Access.

   • La configurazione chiederà di installare Microsoft Visual C++ 2015-2022 Redistributabella (x64) se rileva che non è ancora installato.

   Nota informatica

   • Durante la configurazione, è possibile sovrascrivere le seguenti impostazioni predefinite:
     • Il percorso di installazione(C:\Program Files\Qlik\ConnectorAgent).

     • L'account di servizio di Windows con il quale verrà installato Gateway di Direct Access (LocalSystem) L'account di servizio specificato deve avere sia il diritto di "accesso come servizio" che l'autorizzazione di "scrittura" sulla cartella di installazione di Gateway di Direct Access.

3. Continua a fare clic su Avanti fino al completamento della configurazione.
   

Installazione, aggiornamento e disinstallazione in modo automatico del Gateway di Direct Access

L'installazione automatica del Gateway di Direct Access, può essere utile, ad esempio, se è necessario installare il Gateway di Direct Access su più computer in tutta l'organizzazione. Se necessario, è possibile anche sovrascrivere l'account di servizio predefinito di Windows (LocalSystem).

Prerequisiti

Prima di avviare l'installazione automatica, assicurarsi di installare le versioni corrette di tutti i software indispensabili poiché, a differenza dell'installazione interattiva, non è possibile farlo durante l'installazione.

Installazione o aggiornamento del Gateway di Direct Access

Aprire un prompt CMD come amministratore ed eseguire il seguente comando dalla cartella contenente l'eseguibile del Gateway di Direct Access:

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

Nei casi in cui è necessario sostituire full-path con il percorso di installazione effettivo racchiuso da virgolette, ad esempio, C:\TMP\Qlik.

Sovrascrivere l'account di servizio predefinito di Windows

Per impostazione predefinita, Gateway di Direct Access è installato in LocalSystem nell'account del servizio Windows .

Per installare Gateway di Direct Access con un altro account, includere i seguenti parametri nel comando:

• ServiceAccount: il proprietario dell'account di servizio.

  Nota informaticaL'account di servizio specificato deve avere sia il diritto di "accesso come servizio" che l'autorizzazione di "scrittura" sulla cartella di installazione di Gateway di Direct Access.
• ServicePassword: la password dell'account di servizio specificato.

Esempio di comando con parametri per sovrascrivere l'account di servizio di Windows

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

Disinstallazione di Gateway di Direct Access

Aprire un prompt CMD come amministratore ed eseguire il seguente comando dalla cartella contenente l'eseguibile del Gateway di Direct Access:

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

Risoluzione dei problemi di installazione

I file di registro dell'installazione possono essere utili per la risoluzione dei problemi con l'installazione o l'aggiornamento:

Da Gateway di Direct Access 1.7.7, il percorso completo ai file di registro è:

<Gateway di Direct Access cartella di installazione>\data\logs\Qlik Data Gateway - Accesso diretto_<Timestamp>.log

Se la tua Gateway di Direct Access versione è precedente alla 1.7.7, il percorso completo dei file di log è:

C:\Users\<user>\AppData\Local\Temp\Qlik Data Gateway - Accesso diretto_<Timestamp>.log

Fase quattro: Registrare il gateway dati

Il passaggio successivo consiste nel registrare il gateway dati. Questa operazione può essere eseguita sia tramite il centro attività Amministrazione sia da riga di comando.

Opzione 1: tramite il centro attività Amministrazione

È possibile registrare il gateway utilizzando il centro attività Amministrazione scomparsa. Vedere Opzione 1: Tramite il centro attività Amministrazione.

Opzione 2: Registrazione automatica tramite riga di comando

È anche possibile registrare Gateway di Direct Access automaticamente dalla riga di comando, senza utilizzare il centro attività Amministrazione . Questo metodo utilizza un token di sessione di breve durata generato da un client OAuth.

Nota informaticaLa registrazione automatica è supportata solo tramite riga di comando. Un'API REST per la registrazione automatica del gateway non è attualmente disponibile.

Prerequisiti

Una chiave API con autorizzazione di amministratore tenant per creare e gestire client OAuth.

Registrazione del gateway tramite registrazione automatica

1. Genera una JSON Web Key (JWK) sulla macchina Gateway di Direct Access." Questo comando crea chiavi private sulla macchina Gateway di Direct Access:

   ConnectorAgent.exe qcs generate_jwk

2. Copia il JWK restituito dal comando.

3. Utilizzando la chiave API, crea un client OAuth per il gateway tramite l'API di amministrazione del tenant, fornendo il JWK copiato nel passaggio precedente.

   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. Copia il valore client_id restituito nella risposta.

5. Imposta il metodo di consenso del client OAuth su attendibile.

   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. Crea un'asserzione di registrazione sulla macchina Gateway di Direct Access:

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

7. Richiedi un token di accesso. Questo attiva anche la creazione automatica dell'account utente bot utilizzato dal gateway.

   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. Cerca l'utente bot creato automaticamente.

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

9. Copia l'ID di my-bot-client.

10. Creare un ruolo "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. Assegna ruoli a livello di tenant all'utente 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. Recupera lo spazio Direct Access Gateway.

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

13. Copia l'ID dello spazio Direct Access Gateway.

14. Aggiungi l'utente bot allo spazio con l'autorizzazione Può modificare.

    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. Nel caso in cui l'asserzione esistente sia scaduta, generarne una nuova.

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

16. Registrare il gateway:

    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>

Rimozione di un gateway registrato automaticamente

Utilizzare i passaggi seguenti per annullare la registrazione di un gateway registrato mediante il metodo automatico basato su token di sessione descritto sopra. Questi passaggi rimuovono inoltre il client OAuth, l'utente bot e il ruolo che sono stati creati per esso.

1. Genera un'asserzione, come descritto nel passaggio sei di Registrazione automatica del gateway utilizzando un token di sessione.

2. Elimina il gateway:

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

3. Elimina il JWK.

   ConnectorAgent.exe qcs delete_jwk

4. Cercare l'account utente del bot creato per il gateway.

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

5. Copia l'ID del bot.

6. Elimina questo account utente bot.

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

7. Cerca il ruolo “DAG Registration” creato per il gateway.

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

8. Copia l'ID del ruolo.

9. Elimina questo ruolo.

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

10. Elimina il client OAuth.

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

Fase cinque: Avviare il servizio Qlik Data Gateway - Accesso diretto sul server del gateway di c

Sul server del gateway Accesso diretto, eseguire una delle seguenti azioni per avviare il servizio:

• Aprire la console Servizi di Windows e avviare il servizio Qlik Data Gateway - Accesso diretto.

• Aprire un prompt dei comandi come amministratore e cambiare la directory di lavoro nella sottocartella di ConnectorAgent (C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent con un'installazione predefinita). Eseguire quindi il seguente comando:

  connectoragent service start

  Viene visualizzata la conferma che il servizio è stato avviato correttamente.

Vedere anche: Esecuzione del servizio con un altro account.

Passaggio sei: aggiunta di una connessione alla sorgente dati

Vedere Passaggio sei: aggiunta di una connessione alla sorgente dati.

Sorgenti dati supportate

I seguenti connettori ODBC sono supportati per le installazioni del server Windows:

• Sorgenti ODBC. Per maggiori informazioni, vedere Database ODBC - Qlik Cloud (solo in lingua inglese).
• Sorgenti REST. Per maggiori informazioni, vedere Sorgenti REST - Qlik Cloud (solo in lingua inglese).

• Sorgenti SAP BW, SAP SQL e SAP ODP. Richiede Gateway di Direct Access 1.2.0 o versione successiva.

  Per informazioni sull'impostazione della connettività a queste sorgenti, vedere SAP NetWeaver (solo in lingua inglese).