Workday
Le connecteur Workday vous permet de vous connecter à une instance Workday et accéder aux données Workday comme une base de données traditionnelle.
Avant de commencer
Avant d'utiliser le connecteur Workday, effectuez les tâches suivantes :
- Dans votre projet Google Cloud :
- Accorder à l'utilisateur le rôle IAM roles/connectors.admin configuration du connecteur.
- Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.
- Activez les services suivants :
secretmanager.googleapis.com
(API Secret Manager)connectors.googleapis.com
(API Connectors)
Pour savoir comment activer des services, consultez la page Activer des services.
Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.
Configurer le connecteur
Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :
- Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.
- Cliquez sur + Créer pour ouvrir la page Créer une connexion.
- Dans la section Emplacement, choisissez l'emplacement de la connexion.
- Région : sélectionnez un emplacement dans la liste déroulante.
Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.
- Cliquez sur Next (Suivant).
- Région : sélectionnez un emplacement dans la liste déroulante.
- Dans la section Détails de connexion, procédez comme suit :
- Connecteur : sélectionnez Workday dans la liste déroulante des connecteurs disponibles.
- Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
- Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.
Les noms de connexion doivent répondre aux critères suivants :
- Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
- Les lettres doivent être en minuscules.
- Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
- Les noms de connexion ne peuvent pas dépasser 63 caractères.
- Saisissez éventuellement une Description pour l'instance de connexion.
- Compte de service : sélectionnez un compte de service disposant des rôles requis.
- Vous pouvez également configurer les paramètres du nœud de connexion :
- Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
- Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.
Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.
-
Locataire : le locataire du compte. Exemple :
abc_cms1
Vous pouvez obtenir le nom dans les détails de configuration de votre instance Workday. -
Service : le ou les services spécifiques à partir desquels récupérer les données. Saisissez-les en les séparant par une virgule
liste. Par exemple,
absenceManagement,common,compensation,recruiting,payroll,person
. - Version WSDL : version du WSDL à utiliser.
- Utiliser un proxy : cochez cette case pour configurer un serveur proxy pour la connexion, et spécifiez les valeurs suivantes :
-
Schéma d'authentification du proxy : sélectionnez le type d'authentification pour l'authentification auprès du serveur proxy. Les types d'authentification suivants sont compatibles :
- Basique : authentification HTTP de base.
- Condensé : authentification HTTP par condensé.
- Utilisateur du proxy : nom d'utilisateur à utiliser pour l'authentification auprès du serveur proxy.
- Mot de passe du proxy : secret Secret Manager du mot de passe de l'utilisateur.
-
Type SSL du proxy : type SSL à utiliser lors de la connexion au serveur proxy. Les types d'authentification suivants sont compatibles :
- Auto : paramètre par défaut. Dans le cas d'une URL HTTPS, l'option "Tunnel" est utilisée. Dans le cas d'une URL HTTP, l'option "JAMAIS" est utilisée.
- Toujours : la connexion SSL est toujours activée.
- Jamais : la connexion n'est pas activée pour SSL.
- Tunnel : la connexion s'effectue via un proxy de tunnelisation. Le serveur proxy ouvre une connexion à l'hôte distant et le trafic transite par le proxy.
- Dans la section Serveur proxy, saisissez les détails du serveur proxy.
- Cliquez sur + Ajouter une destination.
- Sélectionnez un type de destination.
- Adresse de l'hôte : spécifiez le nom d'hôte ou l'adresse IP de la destination.
Si vous souhaitez établir une connexion privée à votre système backend, procédez comme suit :
- Créez un rattachement de service PSC.
- Créez un rattachement de point de terminaison, puis saisissez les détails du rattachement de point de terminaison dans le champ Adresse de l'hôte.
- Adresse de l'hôte : spécifiez le nom d'hôte ou l'adresse IP de la destination.
- Vous pouvez également cliquer sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
- Cliquez sur Suivant.
- Dans la section Destinations, saisissez les informations concernant l'hôte distant (système backend) auquel vous souhaitez vous connecter.
- Vous pouvez configurer les types de destination suivants:
- URL de base: cliquez sur + Ajouter une destination, puis saisissez l'URL de base de votre instance Workday. Par exemple,
https://wd5-impl-service23.workday.com
. - URL de l'API: cliquez sur + Ajouter une destination, puis saisissez l'URL de l'API de votre instance Workday. Par exemple,
https://wd5-impl-service23.workday.com/srx/api/v1/TENANT
. - URL WSDL: cliquez sur + Ajouter une destination, puis saisissez l'URL WSDL de votre instance Workday.
Vous pouvez utiliser le protocole REST ou le protocole SOAP pour communiquer avec votre instance Workday. Pour comprendre comment configurer la connexion pour chacun des protocoles, consultez la section Configurer la connexion pour REST ou SAP.
- URL de base: cliquez sur + Ajouter une destination, puis saisissez l'URL de base de votre instance Workday. Par exemple,
- Cliquez sur Suivant.
- Vous pouvez configurer les types de destination suivants:
-
Dans la section Authentification, saisissez les informations d'authentification.
- Sélectionnez un type d'authentification, puis saisissez les informations appropriées.
Les types d'authentification suivants sont compatibles avec la connexion Workday :
- Nom d'utilisateur et mot de passe
- OAuth 2.0 - Code d'autorisation
- Cliquez sur Next (Suivant).
Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.
- Sélectionnez un type d'authentification, puis saisissez les informations appropriées.
- Vérifiez vos informations de connexion et d'authentification.
- Cliquez sur Créer.
Configurer la connexion pour REST ou SAP
Configuration pour REST
Pour que la connexion utilise le protocole REST, vous devez utiliser l'authentification OAuth 2.0 – Code d'autorisation. et configurez les champs suivants:
Dans la section Détails de la connexion:
- Locataire
- Service
- Version WSDL
Dans la section Destinations:
- URL de base
- URL de l'API
Dans la section Authentification:
- ID client
- Code secret du client
Configuration pour le protocole SOAP
Pour que la connexion utilise le protocole SOAP, vous devez utiliser le type d'authentification Nom d'utilisateur et mot de passe. et configurez les champs suivants:
Dans la section Détails de la connexion:
- Locataire
- Service
- Version WSDL
Dans la section Destinations:
- URL de base
Dans la section Authentification:
- Nom d'utilisateur
- Mot de passe
Configurer l'authentification
Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.
- Nom d'utilisateur et mot de passe
- Nom d'utilisateur : nom d'utilisateur du connecteur
- Mot de passe : Secret de Secret Manager contenant le mot de passe associé au connecteur.
- OAuth 2.0 - Code d'autorisation
- ID client : ID client fourni par votre application externe.
- Champs d'application : champs d'application d'autorisation.
- Secret du client : sélectionnez le secret Secret Manager. Vous devez avoir créé le secret Secret Manager avant de configurer cette autorisation.
- Version du secret : version du secret Secret Manager pour le code secret du client.
- URL d'autorisation:saisissez l'URL d'autorisation générée lorsque vous créé l'instance Workday.
- Type de connexion:sélectionnez un type de connexion.
Pour le type d'authentification OAuth 2.0 - Authorization code
, après avoir créé la connexion, vous
doit effectuer quelques étapes supplémentaires
pour configurer l'authentification. Pour plus d'informations,
consultez la section Étapes supplémentaires après la création d'une connexion.
Étapes supplémentaires après la création de la connexion
Si vous avez sélectionné OAuth 2.0 - Authorization code
pour
vous devez effectuer les étapes supplémentaires suivantes après avoir créé la connexion:
- Sur la page Connexions :
localisez la connexion qui vient d'être créée.
Notez que l'état du nouveau connecteur sera Autorisation requise.
- Cliquez sur Autorisation requise.
Le volet Modifier l'autorisation s'affiche.
- Copiez la valeur Redirect URI (URI de redirection) dans votre application externe.
- Vérifiez les détails de l'autorisation.
- Cliquez sur Autoriser.
Si l'autorisation aboutit, l'état de la connexion est défini sur Active (Actif) dans la Page "Connexions".
Nouvelle autorisation pour le code d'autorisation
Si vous utilisez le type d'authentification Authorization code
et que vous avez modifié la configuration de votre application Workday,
vous devez autoriser à nouveau votre connexion Workday. Pour autoriser à nouveau une connexion, procédez comme suit:
- Cliquez sur la connexion requise sur la page Connexions.
La page "Détails de la connexion" s'ouvre.
- Cliquez sur Edit (Modifier) pour modifier les détails de la connexion.
- Vérifiez les détails du code d'autorisation OAuth 2.0 dans la section Authentification.
Si nécessaire, apportez les modifications nécessaires.
- Cliquez sur Enregistrer. La page des détails de la connexion s'affiche.
- Cliquez sur Modifier l'autorisation dans la section Authentification. Le volet Autoriser s'affiche.
- Cliquez sur Autoriser.
Si l'autorisation aboutit, l'état de la connexion est défini sur Active (Actif) sur la page Connexions.
Entités, opérations et actions
Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.
- Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.
Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste
Entities
est vide. - Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, d'opérations ne sont pas répertoriées dans la liste
Operations
. - Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et une sortie
. Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste
Actions
est vide.
Limites du système
Le connecteur Workday peut traiter 3 transactions par seconde, par nœud, et régule toutes les transactions au-delà de cette limite. Par défaut, Integration Connectors alloue deux nœuds (pour une meilleure disponibilité) à une connexion.
Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.
Exemples d'opérations sur les entités
Cette section explique comment effectuer certaines opérations sur les entités dans ce connecteur.
Exemple : Répertorier tous les enregistrements
Cet exemple répertorie tous les enregistrements de l'entité Scorecards
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
Scorecards
dans la listeEntity
. - Sélectionnez l'opération
List
, puis cliquez sur OK. - Si vous le souhaitez, vous pouvez effectuer les actions suivantes dans la section Task Input (Entrée dans la tâche) de la tâche Connectors (Connecteurs).
filtrer votre ensemble de résultats en spécifiant une clause de filtre. Préciser
La valeur de la clause de filtre doit toujours être entre guillemets simples ('). Exemple :
Id='13b1724a91ce448bad2f1986321fc70f'
. Toi Vous pouvez également spécifier plusieurs conditions de filtre à l'aide des opérateurs logiques. Par exemple,Id='13b1724a91ce448bad2f1986321fc70f' and Inactive=false
.
Exemple – Obtenir un enregistrement
Cet exemple récupère un enregistrement avec l'ID spécifié à partir de l'entité Scorecards
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
Scorecards
dans la listeEntity
. - Sélectionnez l'opération
Get
, puis cliquez sur OK. - Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId (ID d'entité).
puis saisissez
1|CN=admin,CN=Users,DC=test-ldap,DC=com
dans le champ Default Value (Valeur par défaut).Ici,
1|CN=admin,CN=Users,DC=test-ldap,DC=com
est une valeur de clé primaire dans l'entitéScorecards
.
Exemple : Créer un enregistrement
Cet exemple crée un enregistrement dans l'entité PayrollInputs
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
PayrollInputs
dans la listeEntity
. - Sélectionnez l'opération
Create
, puis cliquez sur OK. - Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur
connectorInputPayload
, puis saisissez une valeur semblable à celle-ci dans la section ChampDefault Value
:{ "Worker_Id": "21327", "Worker_Descriptor": "Worker 2" }
Si l'intégration réussit, le champ
connectorOutputPayload
de votre tâche de connecteur comportera un semblable à celle-ci:{ "Id": "c3c68bc9a13f901d43ca8e5ddcaa0000" }
Exemple – Mettre à jour un enregistrement
Cet exemple met à jour l'enregistrement avec l'ID spécifié dans l'entité Scorecards
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
Scorecards
dans la listeEntity
. - Sélectionnez l'opération
Update
, puis cliquez sur OK. - Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur
connectorInputPayload
, puis saisissez une valeur semblable à celle-ci dans la section ChampDefault Value
:{ "ScorecardDescription": "New updated description", "ScorecardName": "Scorecard_1" }
- Cliquez sur entityId, puis saisissez
f368471438b14705a1178c6744d75853
dans le champ Valeur par défaut.
Exemple : Supprimer un enregistrement
Cet exemple supprime l'enregistrement avec l'ID spécifié dans l'entité Scorecards
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
Scorecards
dans la listeEntity
. - Sélectionnez l'opération
Delete
, puis cliquez sur OK. - Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId et
puis saisissez
e002de05784910123c443f7eb0970722
dans le champ Default Value (Valeur par défaut).
Utiliser Terraform pour créer des connexions
Vous pouvez utiliser l'outil Terraform ressource pour créer une connexion.Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.
Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet exemple de modèle.
Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:
Nom du paramètre | Type de données | Requis | Description |
---|---|---|---|
locataire | STRING | Faux | Locataire du compte. |
service | STRING | Faux | Service ou services spécifiques à partir desquels récupérer les données. Saisissez-les sous forme de liste d'éléments séparés par une virgule. |
wsdlversion | STRING | Faux | Version du WSDL à utiliser. |
proxy_enabled | VALEUR BOOLÉENNE | Faux | Cochez cette case pour configurer un serveur proxy pour la connexion. |
proxy_auth_scheme | ENUM | Faux | Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Les valeurs acceptées sont: BASIC, DIGEST, NONE |
proxy_user | STRING | Faux | Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer. |
proxy_password | SECRET | Faux | Mot de passe à utiliser pour l'authentification auprès du proxy ProxyServer. |
proxy_ssltype | ENUM | Faux | Type SSL à utiliser lors de la connexion au proxy ProxyServer. Les valeurs acceptées sont: AUTO, ALWAYS, NEVER et TUNNEL. |
Utiliser la connexion Workday dans une intégration
Une fois la connexion créée, elle devient disponible à la fois Apigee Integration et Application Integration. Vous pouvez utiliser la connexion lors d'une intégration via la tâche "Connecteurs".
- Pour comprendre comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la section Tâche Connecteurs.
- Pour découvrir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez la section Tâche Connecteurs.
Obtenir de l'aide auprès de la communauté Google Cloud
Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.Étape suivante
- Découvrez comment suspendre et réactiver une connexion.
- Découvrez comment surveiller l'utilisation des connecteurs.
- Découvrez comment afficher les journaux du connecteur.