Enregistrer des agents externes
Conditions préalables
Vous devrez peut-être prendre des étapes supplémentaires pour activer cette fonction en fonction de l’accord sur les service d’abonnement de votre organisation. Votre organisation figure soit dans l’entente-cadre d’abonnement (MSA), soit dans l’accord sur les services principaux universels (UMSA). Pour déterminer l’entente de service d’abonnement de votre organisation :
- Sélectionnez votre avatar de profil dans Workday Community .
- SélectionnezProfil.
- Dans votre page de profil, sélectionnez le nom de votre organisation, qui est sous votre nom et à côté de votre titre d'emploi.
- Affichez la valeur de votreentente de services d’abonnement.
Si la valeur est :
- UMSA, la fonction est automatiquement disponible. Pour de plus amples renseignements sur les données fournies par l’apprentissage automatique, voir Concept : Workday AI for Universal Main Subscription Agreement, Customers .
- MSA, votre organisation doit choisir d’utiliser uMSA.
Les crédits variables ne sont requis que pour enregistrement et l’utilisation d’agents dans vos locataires de production. Vous ne pourrez enregistrer et utiliser aucun agent en production tant que vous n’aurez pas choisi d’utiliser ces accords. UMSA est obligatoire pour les locataires hors production et de production pour les agents Workday-Build. UMSA n’est pas obligatoire pour les locataires hors production pour les agents auto-créés.
Sécurité :
- domaineAgent Management Hubdans le domaine fonctionnel Agent System of Record . Obligatoire pour la validation que l'agent est enregistré dans Workday.
- domaineManage Agentsdans le domaine fonctionnel Agent System of Record . Obligatoire pour l'activation et la configuration des habileté .
- DomaineSet Up: Tenant Setup - Securitydans le domaine fonctionnel System. Obligatoire pour l’inscription.
Contexte
Actuellement, vous pouvez uniquement enregistrer et définir des agents externes dans Workday en utilisant l’ API ASOR. Les agents externes sont définis et enregistrés simultanément à l'aide de l' API, ce qui ne constitue pas deux étapes distinctes. Vous pouvez utiliser n'importe quel client API de votre préférence pour appeler l' API.
Reportez-vous à la documentation sur API ASOR v1.2 dans Github et à l’exemple de documentation sur Workday ASOR JSON pour résoudre les problèmes.
Points de terminaison d’enregistrement :
- REST API Endpoint:https://us.agent.workday.com/asor/v1/agentDefinition.
- Token Endpoint:https://us.agent.workday.com/auth/oauth2/<Tenant_Name>/token
- Point de terminaison d’autorisation :https://us.agent.workday.com/auth/ authorized
Pour des informations relatives à d’autres disponibilité régionales en dehors des États-Unis, consultez la documentation de Agent Gateway :Référence : disponibilité région de l’Agent Gateway le
Options d'authentification :
Pour enregistrer des agents externes, vous avez besoin d’un jeton d'accès dans votre invocation API ASOR. Vous trouverez ci-dessous les différentes options pour obtenir un jeton afin d’appeler l’appel de l’ API ASOR.
Option 1 : Authentifier manuellement un client API
- Accédez à la tâcheRegister API Client.
- Nom du client :entrez un nom unique identifiable pour votre agent. Nous vous recommandons d’utiliser un client distinct pour chaque agent afin de faciliter la gestion.
- Type d'octroi de client :Octroi de code d'autorisation.
- Type de jeton d'accès :Reporter.
- Redirection URI :entrez une adresse URL à laquelle accèdent les utilisateurs après l’autorisation.
- Scope (Functional Areas) :Agent System of Record.
- Inclure les champs d’application définis par Workday :cochez cette case.
- Copiez et enregistrez les valeursde l’identifiant de clientetde la clé secrète client. Vous pouvez l'utiliser pour obtenir un jeton d'accès afin d'appeler l' API de définition .
- Collez cette adresse URL dans une nouvelle fenêtre. Il devrait vous rediriger vers google.com avec un code ajouté que vous pouvez utiliser pour appeler l' API:https://us.agent.workday.com/auth/ authorized
- Créez une nouvelle demande à l’aide d’un client API externe (Exemple : Brune) :https://<tenantHost>/ccx/oauth2/<tenantName>/ jeton
- Corps :Grant_type=authorization_code&code=< authorizedCode>&client_id=<clientID>&client_secret=<ClientSecret>
- Auth : Nom d'utilisateur =<ClientID>, mot de passe =<ClientSecret>.
- Cela génère un jeton d'accès et un jeton actualiser que vous pouvez utiliser pour appeler l’ API de définition de l’agent ASOR.
- Pour cette étape, tenez compte des éléments suivants :Concept : éléments à prendre en compte pour l’ASU de l’agent externe le
L'utilisateur enregistrement l'agent doit avoir accès au domaine Setup: Agents dans le domaine fonctionnel Agent System of Record pour enregistrer un agent à l'aide de l' API ASOR.
Option 2 : Authentification au moyen de Workday Extend
Si vous êtes un utilisateur de Workday Extend ou de Workday Orchestrate, vous pouvez récupérer un jeton d'accès par le site des développeurs de Workday.
- Accédez à Developer.workday.com et ouvrir une session: .
- En haut à droite, cliquez sur le menu utilisateur. Le menu doit afficher le nom actuel de votre société .
- Cliquez sur .
- Sélectionnez votre environnement et locataire , puis cliquez surSe connecter au locataire.
- Ouvrez une session dans le locataire. Vous devez ouvrir une session avec un compte qui a accès audomaine Setup: Agentsdans le domaine domaine fonctionnel Agent System of Record pour enregistrer un agent à l'aide de l' API ASOR.
Enregistrer un agent externe à l'aide de l' API ASOR
Conditions préalables :
- Un jeton d'accès pour un compte ayant accès au domaineSetup: Agentsdans le domaine fonctionnel Agent System of Record : .
- Un client API de votre choix.
- Sécurité : les domaines suivants dans le domaine fonctionnel System :
- Custom Report Creation
- Manage : All Custom Reports
- Report Tag Management
Contexte :
Pour enregistrer un agent externe, vous devez :
- Recherchez les identifiants Workday des API Workday (SOAP et REST) pertinentes que vous comptez inclure dans la définition des outils de votre agent en créant un rapport personnalisé: .
- Recherchez le fournisseur d’agent à l’aide de la tâcheAfficher un fournisseur d’agent.
- Appeler l’ API REST ASOR
Recherche d'identifiants Workday basés sur SOAP et REST pour la définition d'outils d'agent
- Accédez à la tâcheCréer un rapport personnalisé.
- Lorsque vous créez le rapport, tenez compte des éléments suivants :OptionDescriptionType de rapportSélectionnezAvancé.Optimisé pour les performancesDécochez cette case.Source de donnéesSélectionnezServices Web publicspour les API SOAP etToutes les opérations de service publicpour les API REST.
- Pour les API SOAP : sur la pageModifier un rapport personnalisé, dans l’ongletColonnesde la définition du rapport, ajoutez les rangées suivantes :Objet de gestionChampService WebService WebOpération de service WebNom de l'opération du service WebOpération de service WebIdentifiant Workday
- Pour les API REST, dans l’ongletColonnesde la définition de rapport personnalisé de la pageModifier un rapport personnalisé, ajoutez les rangées suivantes :Objet de gestionChampOpération de serviceServiceOpération de serviceNomOpération de serviceIdentifiant Workday
- Enregistrez et exécutez le rapport.
Lorsque vous récupérez les identifiants Workday pour vos API, vous pouvez également faire référence aux listes suivantes :
Rechercher le fournisseur d'agent
Les fournisseurs d’agents font référence à la personne qui a créé l’agent. Ils sont affichés dans le champ
Conçu par du
profil de l’agent.
- Accédez à la tâcheAfficher un fournisseur d’agents, rattachée au domaineSetup: Agents auxfins de sécurité dans le domaine fonctionnel Agent System of Record .
- Utilisez l’identifiant de fournisseur dans votre appel API d’enregistrement d’agent.
Rechercher la plateforme de l'agent
Les plateformes d’agents se rapportent à la plateforme ou au système externe sur lequel l’agent est développé et exécuté, et s’affichent dans le champ
Intégré
du profil de l’agent.
- Accédez à la tâcheView Agent Platforms, rattachée au domaine Setup Agents dans le domaine fonctionnel Agent System of Record .
- Utilisez l'identifiant de la plateforme dans l'appel de API d'enregistrement d'agent.
Appeler l’ API REST ASOR
Créez une nouvelle demande pour enregistrer votre agent à l’aide d’un client API externe, Exemple : Brun.
Pour la demande, tenez compte des éléments suivants :
- Endpoint:https://us.agent.workday.com/asor/v1/agentDefinition
- Opération :POST
- Corps :Reportez-vous à la documentation sur API ASOR v1.2 dans Github et à l’exemple de documentation sur Workday JSON ASOR .
- En-têtes :
- Autorisation : Reporter < jeton>
- wd-agent-tenant-alias:<votre nom de locataire>
Console centrale de la gestion des agents
Après avoir correctement chargé votre définition d'agent dans Workday, vous pouvez vérifier qu'elle est enregistrée en la affichant dans la
console centrale de la gestion des agents
.
- Accédez au rapportConsole centrale de la gestion des agents.
- Cliquez surRegistre des agentspour afficher une liste de vos agents.
- Cliquez sur un agent pour en afficher l'aperçu.
Étapes suivantes
Configurez votre agent dans Workday.