Paramétrez Openflow Connector for HubSpot¶
Note
Ce connecteur est soumis aux conditions d’utilisation de Snowflake Connector.
Cette rubrique décrit les étapes pour paramétrer Openflow Connector for HubSpot.
Conditions préalables¶
Assurez-vous d’avoir consulté À propos de Openflow Connector for HubSpot.
Assurez-vous d’avoir Configuration d’Openflow - BYOC ou de Configurer Openflow - Déploiements Snowflake.
Si vous utilisez Openflow - Snowflake Deployments, assurez-vous d’avoir examiné la configuration des domaines requis et d’avoir accordé l’accès aux domaines requis pour le connecteur Hubspot.
Obtenir les identifiants de connexion¶
En tant qu’administrateur de HubSpot, générez un jeton d’application privée HubSpot ou créez-en un dans votre compte HubSpot. Cela vous permet d’authentifier vos requêtes auprès de l’API HubSpot.
Connectez-vous à votre compte HubSpot.
Accédez à Settings en sélectionnant l’icône de l’engrenage dans la barre de navigation supérieure.
Dans la navigation de gauche, accédez à Integrations » Private Apps.
Sélectionnez Create a private app.
Saisissez un nom pour votre application.
Accédez à l’onglet Scopes.
Sélectionnez les champs d’application requis pour les requêtes d’API que vous avez l’intention d’effectuer. Pour trouver les champs d’application nécessaires aux requêtes d’API, voir Champs d’application.
Sélectionnez Create app.
Paramétrez les champs d’application requis pour les requêtes d’API que vous avez l’intention d’effectuer pour chaque point de terminaison.
Sélectionnez View access token pour voir le jeton d’accès. Collez le jeton dans les paramètres du connecteur ou sauvegardez-le en toute sécurité.
Paramétrage du compte Snowflake¶
En tant qu’administrateur de compte Snowflake, effectuez les tâches suivantes :
Créez un nouveau rôle ou utilisez un rôle existant et accordez les Privilèges de base de données et les Affichage des privilèges.
Créez un nouvel utilisateur du service Snowflake avec le type SERVICE.
Autorisez l’utilisateur du service Snowflake le rôle que vous avez créé dans les étapes précédentes.
Configurez avec l’authentification par paire de clés pour l’utilisateur de Snowflake SERVICE de l’étape 2.
Snowflake recommande vivement cette étape. Configurez un gestionnaire de secrets pris en charge par Openflow, par exemple AWS, Azure et Hashicorp, et stockez les clés publiques et privées dans le magasin de secrets.
Note
Si, pour une raison quelconque, vous ne souhaitez pas utiliser un gestionnaire de secrets, il vous incombe de protéger les fichiers de clés publiques et privées utilisés pour l’authentification par paires de clés conformément aux politiques de sécurité de votre organisation.
Une fois le gestionnaire de secrets configuré, déterminez comment vous vous y authentifierez. Sur AWS, il est recommandé d’utiliser le rôle de l’instance EC2 associée à Openflow, car de cette manière, aucun autre secret ne doit être conservé.
Dans Openflow, configurez un fournisseur de paramètres associé à ce gestionnaire de secrets, à partir du menu hamburger en haut à droite. Naviguez jusqu’à Controller Settings » Parameter Provider, puis récupérez vos valeurs de paramètres.
À ce stade, tous les identifiants peuvent être référencés avec les chemins de paramètres associés et aucune valeur sensible ne doit être conservée dans Openflow.
Si d’autres utilisateurs de Snowflake ont besoin d’accéder aux documents bruts ingérés et aux tables ingérées par le connecteur (par exemple, pour un traitement personnalisé dans Snowflake), accordez à ces utilisateurs le rôle créé à l’étape 1.
Créez une base de données et un schéma dans Snowflake pour que le connecteur puisse stocker les données ingérées. Autorisez Privilèges de base de données pour le rôle créé à la première étape.
Créez un entrepôt qui sera utilisé par le connecteur ou utilisez un entrepôt existant. Commencez par la taille d’entrepôt la plus petite, puis faites des essais en fonction du nombre de tables répliquées et de la quantité de données transférées. Les tables de grande taille s’adaptent généralement mieux aux entrepôts multi-clusters, plutôt qu’aux entrepôts de grande taille.
Assurez-vous que l’utilisateur dont le rôle est utilisé par le connecteur dispose des privilèges requis pour utiliser l’entrepôt. Si ce n’est pas le cas, accordez les privilèges requis au rôle.
Définir le connecteur¶
En tant qu’ingénieur des données, effectuez les tâches suivantes pour installer et configurer le connecteur :
Installer le connecteur¶
Pour installer le connecteur, procédez comme suit en tant qu’ingénieur des données :
Accédez à la page d’aperçu d’Openflow. Dans la section Featured connectors, sélectionnez View more connectors.
Sur la page des connecteurs Openflow, trouvez le connecteur et sélectionnez Add to runtime.
Dans la boîte de dialogue Select runtime, sélectionnez votre environnement d’exécution dans la liste déroulante Available runtimes, puis cliquez sur Add.
Note
Avant d’installer le connecteur, assurez-vous que vous avez créé une base de données et un schéma dans Snowflake pour que le connecteur puisse stocker les données ingérées.
Authentifiez-vous au déploiement avec les identifiants de votre compte Snowflake et sélectionnez Allow lorsque vous êtes invité à autoriser l’application d’exécution à accéder à votre compte Snowflake. Le processus d’installation du connecteur prend quelques minutes.
Authentifiez-vous auprès de l’environnement d’exécution avec les identifiants de votre compte Snowflake.
Le canevas Openflow apparaît avec le groupe de processus du connecteur ajouté.
Configuration du connecteur¶
Cliquez avec le bouton droit de la souris sur le groupe de processus importé et sélectionnez Parameters.
Renseignez les valeurs des paramètres requis comme décrit dans Paramètres de débit.
Paramètres de débit¶
Cette section décrit les paramètres de flux que vous pouvez configurer en fonction des contextes de paramètres suivants :
Paramètres de la source HubSpot: pour établir la connexion avec HubSpot.
Paramètres de destination HubSpot: pour établir la connexion avec Snowflake.
Paramètres d’ingestion HubSpot: pour définir la configuration des données téléchargées à partir de HubSpot.
Paramètres de la source HubSpot¶
Paramètre |
Description |
|---|---|
Jeton d’accès HubSpot |
Jeton d’accès à l’application privée HubSpot. |
Paramètres de destination HubSpot¶
Paramètre |
Description |
Obligatoire |
|---|---|---|
Base de données de destination |
La base de données dans laquelle les données seront conservées. Elle doit déjà exister dans Snowflake. Le nom est sensible à la casse. Pour les identificateurs sans guillemets, indiquez le nom en majuscules. |
Oui |
Schéma de destination |
Le schéma dans lequel les données seront conservées, qui doit déjà exister dans Snowflake. Le nom est sensible à la casse. Pour les identificateurs sans guillemets, indiquez le nom en majuscules. Voir l’exemple suivant :
|
Oui |
Stratégie d’authentification Snowflake |
Lorsque vous utilisez :
|
Oui |
Identificateur de compte Snowflake |
Lorsque vous utilisez :
|
Oui |
Clé privée de Snowflake |
Lorsque vous utilisez :
|
Non |
Fichier de clé privée de Snowflake |
Lorsque vous utilisez :
|
Non |
Mot de passe de la clé privée de Snowflake |
Lorsque vous utilisez :
|
Non |
Rôle Snowflake |
Lorsque vous utilisez :
|
Oui |
Nom d’utilisateur Snowflake |
Lorsque vous utilisez :
|
Oui |
Stratégie de valeur surdimensionnée |
Détermine la façon dont le connecteur traite les valeurs qui dépassent ses limites de taille interne (16 MB) pendant la réplication. Les valeurs possibles sont les suivantes :
|
Non |
Entrepôt Snowflake |
Entrepôt Snowflake utilisé pour exécuter des requêtes. |
Oui |
Paramètres d’ingestion HubSpot¶
Paramètre |
Description |
|---|---|
Types d’objets |
Liste de types d’objets HubSpot séparés par des virgules à ingérer. Les valeurs de type d’objet prises en charge sont les suivantes :
|
Mise à jour après |
Filtrer les objets mis à jour après la date ou l’heure spécifiée. Ce paramètre est facultatif. |
Planification d’ingestion des données |
Délai entre les prochaines planifications. Il doit avoir une durée valide, par exemple 30 minutes ou 1 heure. |
Exécutez le flux¶
Cliquez avec le bouton droit de la souris sur l’avion et sélectionnez Enable all Controller Services.
Cliquez avec le bouton droit de la souris sur le groupe de processus importé et sélectionnez Start. Le connecteur démarre l’ingestion des données.
Reconfigurer le connecteur¶
Vous pouvez modifier les paramètres du connecteur une fois que le connecteur a commencé à ingérer des données. Si les critères de la requête d’émission changent, effectuez les étapes suivantes pour vous assurer que les données de la table de destination sont cohérentes.
Arrêtez le connecteur : assurez-vous que tous les processeurs Openflow sont arrêtés.
Accédez aux paramètres de configuration : accédez aux paramètres de configuration du connecteur dans l’interface Snowflake Openflow.
Modifier les paramètres : ajustez les paramètres en fonction des exigences.
Effacer l’état du processeur : Si vous modifiez les critères d’ingestion, Snowflake vous recommande vivement de commencer l’ingestion depuis le début afin de garantir la cohérence des données de la table de destination. Après avoir effacé l’état dans le processeur
List Fresh HubSpot Objects, le connecteur récupérera tous les objets depuis le début. Une troncation manuelle de la table de destination peut être nécessaire pour éviter la duplication des lignes.
Structure des données et vues¶
Le connecteur stocke les données dans les deux formats suivants dans votre base de données Snowflake :
Stockage de données brutes¶
Toutes les données brutes HubSpot sont stockées dans des tables portant les noms exacts spécifiés dans le paramètre Types d’objets. Par exemple :
Si vous configurez
Products,Contacts,Companiesdans le paramètre Types d’objets, le connecteur crée trois tables :PRODUCTS,CONTACTSetCOMPANIES.Chaque table contient la charge utile JSON complète des réponses de l’API HubSpot.
Les données brutes préservent la structure originale et toutes les métadonnées de HubSpot.
Vues aplaties¶
Pour faciliter les requêtes et les analyses, le connecteur crée automatiquement des vues aplaties pour chaque type d’objet :
Chaque table brute a une vue correspondante avec le suffixe
_VIEW. Par exemple,PRODUCTS_VIEW,CONTACTS_VIEWetCOMPANIES_VIEW.Les vues extraient des champs couramment utilisés de la charge utile JSON dans des colonnes individuelles.
Les structures imbriquées complexes sont aplaties pour des requêtes SQL simplifiées.