Paramétrer le connecteur Openflow pour Workday

Note

Le connecteur est soumis aux conditions d’utilisation du connecteur.

Cette rubrique décrit les étapes de paramétrage du connecteur Openflow pour Workday.

Conditions préalables

  1. Assurez-vous d’avoir consulté Connecteur Openflow pour Workday.

  2. Assurez-vous que vous avez paramétré Openflow.

Obtenir les identifiants de connexion

En tant qu’administrateur Workday, effectuez les actions suivantes :

  1. Créez un utilisateur dans Workday :

    1. Allez sur Workday et connectez-vous en tant qu’administrateur. Dans la barre de recherche Workday, tapez Créer un utilisateur.

    2. Cliquez sur Create Integration System User: Task.

    3. Saisissez un nom d’utilisateur et un mot de passe.

  2. Créez un groupe de sécurité et ajoutez-y l’utilisateur de l’étape 1 :

    1. Dans la barre de recherche de Workday, tapez Create Security Group.

    2. Cliquez sur Create Security Group: Task.

    3. Paramétrez le type sur Integration System Security Group (Unconstrained).

    4. Saisissez un nom de groupe de sécurité et cliquez sur OK.

    5. Dans la fenêtre Edit Integration System Security Group (Unconstrained), ajoutez l’utilisateur du système d’intégration créé à l’étape 1 dans le champ Integration System Users.

  3. Ajoutez des politiques de sécurité de domaine au groupe de sécurité créé à l’étape 2 :

    1. Dans la barre de recherche de Workday, tapez View Security Group.

    2. Allez à Security Group Settings » Maintain Domain Permissions for Security Group.

    3. Dans la section Integration Permissions, dans le champ Domain Security Policies permitting Get access, sélectionnez les domaines de sécurité associés aux rapports que vous souhaitez synchroniser.

    4. Allez sur la page Activate Pending Security Policy Changes et cliquez sur OK.

  4. Créez une application client OAuth:

    1. Dans la barre de recherche de Workday, tapez Register API Client, puis cliquez sur Register API Client for Integrations: Task.

    2. Saisissez un nom de client.

    3. Cliquez sur Non-Expiring Refresh Token.

    4. Dans la barre de recherche du champ d’application, tapez Système et sélectionnez-le.

    5. Cliquez sur OK.

    6. Copiez l’ID client et le secret du client, puis cliquez sur Done.

  5. Dans la page View Integration System Security Group, notez les domaines fonctionnels sous Politiques de sécurité du domaine. Ajoutez-les ensuite en tant que champs d’application/domaines fonctionnels dans l’API client :

    1. Dans la barre de recherche, tapez View API Client.

    2. Choisissez votre API client dans la liste.

    3. Dans la barre bleue supérieure, cliquez sur les trois points, puis sélectionnez API Client » API Clients for Integrations.

    4. Dans le champ Scope (Functional Areas), recherchez et ajoutez les domaines fonctionnels que vous avez notés.

  6. Dans le même menu que précédemment (5c), sélectionnez Manage Refresh Tokens for Integrations.

    1. Dans la forme, recherchez l’utilisateur ISU et sélectionnez-le.

    2. Cliquez sur OK.

    3. Cliquez sur Generate new token et copiez les détails du jeton d’actualisation qui sera utilisé ultérieurement.

Paramétrage du compte Snowflake

En tant qu’administrateur de compte Snowflake, effectuez les tâches suivantes :

  1. Créez un nouveau rôle ou utilisez un rôle existant et accordez le Privilèges de base de données.

  2. Créez un nouvel utilisateur du service Snowflake avec le type SERVICE.

  3. Autorisez l’utilisateur du service Snowflake le rôle que vous avez créé dans les étapes précédentes.

  4. Configurez avec l’authentification par paire de clés pour l’utilisateur de Snowflake SERVICE de l’étape 2.

  5. 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.

    1. 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é.

    2. Dans Openflow, configurez un fournisseur de paramètres associé à ce gestionnaire de secrets, à partir du menu hamburger en haut à droite. Naviguez vers Controller Settings » Parameter Provider et récupérez les valeurs de vos paramètres.

    3. À 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.

  6. 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.

  7. Désignez un entrepôt à utiliser par le connecteur. 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.

Définir le connecteur

En tant qu’ingénieur des données, effectuez les tâches suivantes pour configurer le connecteur :

Installer le connecteur

  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. Accordez les Privilèges de base de données requis au rôle créé lors de la première étape. Remplacez l’espace réservé au rôle par la valeur réelle et utilisez les commandes SQL suivantes :

    CREATE DATABASE DESTINATION_DB;
    CREATE SCHEMA DESTINATION_DB.DESTINATION_SCHEMA;
    GRANT USAGE ON DATABASE DESTINATION_DB TO ROLE <CONNECTOR_ROLE>;
    GRANT USAGE ON SCHEMA DESTINATION_DB.DESTINATION_SCHEMA TO ROLE <CONNECTOR_ROLE>;
    GRANT CREATE TABLE ON SCHEMA DESTINATION_DB.DESTINATION_SCHEMA TO ROLE <CONNECTOR_ROLE>;
    
    Copy
  1. Naviguez jusqu’à la page d’aperçu d’Openflow. Dans la section Featured connectors, sélectionnez View more connectors.

  2. Sur la page des connecteurs Openflow, trouvez le connecteur et sélectionnez Add to runtime.

  3. Dans la boîte de dialogue Select runtime, sélectionnez votre environnement d’exécution dans la liste déroulante Available runtimes.

  4. Sélectionnez 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.

  5. 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.

  6. 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

  1. Cliquez avec le bouton droit de la souris sur le groupe de processus importé et sélectionnez Parameters.

  2. Renseignez les valeurs des paramètres requis comme décrit dans Paramètres de débit.

Paramètres de débit

La configuration est divisée en trois contextes de paramètres. Les contextes Workday Destination Parameters et Workday Source Parameters sont responsables de la connexion avec Snowflake et Workday. La page Workday Ingestion Parameters contient tous les paramètres des deux configurations et d’autres paramètres spécifiques à un rapport donné (par exemple, URL de rapport).

Comme le contexte de paramètres Paramètres d’ingestion Workday contient des détails spécifiques au rapport, de nouveaux contextes de paramètres doivent être créés pour chaque nouveau rapport et groupe de processus. Pour créer un nouveau contexte de paramètre, allez dans le menu, sélectionnez Contextes de paramètres et ajoutez un nouveau contexte. Il doit hériter des contextes de paramètres Paramètres de destination Workday et Paramètres source Workday.

Contexte des paramètres Paramètres de destination Workday

Paramètre

Description

Base de données de destination

La base de données de destination dans laquelle la table de destination est créée. Elle doit être créée par l’utilisateur.

Schéma de destination

Le schéma de destination dans lequel la table de destination est créée. Elle doit être créée par l’utilisateur.

Identificateur de compte Snowflake

Le compte Snowflake (dans le format [nom-de-l’organisation]- [nom-de-compte]) où sont stockées les données récupérées dans l’API Workday.

Stratégie d’authentification Snowflake

Définit la façon dont le connecteur se connectera à Snowflake. Utilisez la valeur KEY_PAIR pour spécifier qu’une clé privée doit être fournie pour l’authentification. Lorsque vous travaillez sur SPCS, utilisez SNOWFLAKE_SESSION_TOKEN.

Clé privée de Snowflake

La clé privée RSA utilisée pour l’authentification. La clé RSA doit être formatée selon les normes PKCS8 et comporter les en-têtes et pieds de page standard PEM. Notez que vous devez définir soit le fichier de clé privée de Snowflake, soit la clé privée de Snowflake

Fichier de clé privée de Snowflake

Le fichier qui contient la clé privée RSA utilisée pour l’authentification à Snowflake, formaté selon les normes PKCS8 et comportant les en-têtes et pieds de page standard PEM. La ligne d’en-tête commence par —-BEGIN PRIVATE

Mot de passe de la clé privée de Snowflake

Le mot de passe associé à la clé privée de Snowflake

Rôle Snowflake

Le rôle Snowflake avec les privilèges appropriés sur la base de données et le schéma de destination (USAGE et CREATE TABLE).

Nom d’utilisateur Snowflake

L’utilisateur Snowflake ayant un rôle spécifié dans le paramètre Snowflake Role est affecté.

Entrepôt Snowflake

L’entrepôt Snowflake est utilisé pour charger les données dans les tables.

Contexte des paramètres Paramètres source Workday

Paramètre

Description

Type d’autorisation

Choisissez entre OAUTH ou BASIC_AUTH. Si vous choisissez OAUTH is chosen, vous devez définir les paramètres suivants : OAuth Client ID, OAuth Client Secret, OAuth Refresh Token and OAuth Token Endpoint. Si vous choisissez BASIC_AUTH, vous devez définir Workday Username et Workday Password.

ID client OAuth

L’ID client d’une application enregistrée dans Workday.

Secret du client OAuth

Le secret du client lié à l’ID client.

Jeton d’actualisation OAuth

Le jeton d’actualisation est obtenu par un utilisateur au cours du processus d’enregistrement de l’app. Il est utilisé avec l’ID client et le secret du client pour obtenir un jeton d’accès.

Point de terminaison du jeton OAuth

Le point de terminaison du jeton est obtenu par un utilisateur au cours du processus d’enregistrement de l’app.

Nom d’utilisateur de Workday

Le nom d’utilisateur est utilisé pour se connecter à un compte Workday. Doit être paramétré uniquement lorsque BASIC_AUTH est choisi.

Mot de passe Workday

Le mot de passe est associé au nom d’utilisateur Workday. Doit être paramétré uniquement lorsque BASIC_AUTH est choisi.

Contexte des paramètres Paramètres d’ingestion Workday

Paramètre

Description

Table de destination

La table de destination où sont stockées les données des rapports tirés du Workday. Elle est créée par le connecteur s’il n’existe pas.

URL de rapport

Une URL d’API RaaS pour un rapport créé dans Workday.

Exécuter la planification

Programme d’exécution selon lequel les données sont récupérées dans Workday et sauvegardées dans Snowflake (par défaut, la stratégie de planification Timer driven est utilisée et l’utilisateur spécifie ici un intervalle, par exemple 8h).

Exécutez le flux

  1. Cliquez avec le bouton droit de la souris sur l’avion et sélectionnez Enable all Controller Services.

  2. 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.