Registrare gli agenti esterni
Prerequisiti
Potrebbe essere necessario eseguire ulteriori passaggi per abilitare questa funzionalità in base al contratto servizio in abbonamento dell'organizzazione. L' organizzazione ha aderito al contratto di servizio principale (MSA) o al contratto UMSA (Universal Main Service Agreement). Per determinare il contratto servizio in abbonamento dell'organizzazione:
- Selezionare l'avatar del profilo nella Workday Community .
- SelezionareProfilo.
- Nella pagina del profilo, selezionare il nome dell'organizzazione, che si trova sotto il nome e accanto al titolo impiego.
- Visualizzare il valoredel Contratto di servizio in abbonamento.
Se il valore è:
- UMSA, la funzionalità è automaticamente disponibile. Per ulteriori informazioni sui contributi di dati di machine learning, consultare Concetto: Workday AI for Universal Main Subscription Agreement Customers .
- MSA, l' organizzazione deve abilitare uMSA.
I crediti flessibili sono obbligatorio solo per la registrazione e l'utilizzo degli agenti nei tenant di produzione. Non sarà possibile registrare e utilizzare gli agenti in produzione fino a quando non saranno stati attivati questi contratti. UMSA è obbligatorio per i tenant non di produzione e di produzione per gli agenti Workday-Built. L'UMSA non è obbligatorio per i tenant non di produzione per gli agenti creati autonomamente.
Criteri di sicurezza:
- dominioAgent Management Hubnell'area area funzionale Agent System of Record . Obbligatorio per verificare che l'agente sia registrato in Workday.
- dominioManage Agentsnell'area area funzionale Agent System of Record . Obbligatorio per l'attivazione e la configurazione skill .
- DominioSet Up: Tenant Setup - Securitynell'area funzionale System Obbligatorio per la registrazione.
Contesto
Al momento, è possibile registrare e definire agenti esterni in Workday solo utilizzando l' API ASOR . Gli agenti esterni vengono definiti e registrati contemporaneamente utilizzando l' API, non sono due step separati. È possibile utilizzare qualsiasi client API di propria preferenza per richiamare l' API.
Per la risoluzione dei problemi, fare riferimento alla documentazione API ASOR v1.2 in Github e all'esempio di documentazione ASOR JSON Swagger .
Endpoint di registrazione:
- Endpoint API REST :https://us.agent.workday.com/asor/v1/agentDefinition.
- Token Endpoint:https://us.agent.workday.com/auth/oauth2/<Tenant_Name>/token
- Autorizzazione endpoint:https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3pagent1&redirect_uri=<redirect_uri>
Per informazioni relative alla disponibilità in altre aree geografiche al di fuori degli Stati Uniti, consultare la documentazione di Agent Gateway:Riferimenti: Disponibilità a livello regionale di Agent Gateway .
Opzioni di autenticazione:
Per registrare gli agenti esterni, è necessario un token di accesso nella chiamata API ASOR. Di seguito sono elencate le diverse opzioni per ottenere un token per richiamare la chiamata API ASOR.
Opzione 1: autenticare manualmente un client API
- Accedere attivitàRegistrazione client API.
- Nome cliente:immettere un nome univoco per l'agente. Si consiglia di utilizzare un client separato per ogni agente, in modo da semplificarne la gestione.
- Tipo sovvenzione cliente:assegnazione codice autorizzazione.
- Tipo token di accesso:Bearer.
- URI di reindirizzamento:immettere un URL a cui reindirizzare gli utenti dopo l'autorizzazione.
- Ambito (aree funzionali):sistema di registrazione agente.
- Includi ambito di proprietà Workday :selezionare la casella di controllo.
- Copiare e salvare i valoriID clienteSegreto client. È possibile utilizzarli per ottenere un token di accesso per chiamare l' API di definizione .
- Incollare questo URL in una nuova finestra. Dovrebbe reindirizzarti a google.com con un codice aggiunto che puoi utilizzare per chiamare l' API:https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3pagent1&redirect_uri=<redirect_uri>
- Creare una nuova richiesta utilizzando un client API esterno (esempio: Bruno):https://<tenantHost>/ccx/oauth2/<tenantName>/ token
- Corpo:grant_type=authorization_code&code=<authorizationCode>&client_id=<clientID>&client_secret=<ClientSecret>
- Auth: Username =<ClientID>, Password =<ClientSecret>.
- Questo genera un token di accesso e token aggiornare che è possibile utilizzare per chiamare l' API ASOR Agent Definition .
- Questo step contiene i seguenti elementi:Concetto: Considerazioni su ASU agente esterno .
L'utente registrazione l'agente deve avere accesso al dominio Setup: Agents nell'area area funzionale Agent System of Record per poter registrare un agente utilizzando l' API ASOR .
Opzione 2: autenticazione tramite estensione
Gli utenti Workday Extend o Workday Orchestrate possono recuperare un token di accesso tramite il sito per sviluppatori di Workday.
- Accedere a developer.workday.com e accedere.
- In alto a destra, fare clic sul menu utente. Il menu dovrebbe visualizzare il nome azienda corrente.
- Fare clic su .
- Selezionare l'ambiente e il tenant e fare clic suConnetti a tenant.
- Accedere al tenant. Per registrare un agente utilizzando l' API ASOR , è necessario accedere con un account che abbia accesso al dominioSetup: Agentsnell'area area funzionale Agent System of Record.
Registrare un agente esterno utilizzando l' API ASOR
Prerequisiti:
- Un token di accesso per un account che ha accesso al dominioSetup: Agentsnell'area area funzionale Agent System of Record .
- Un client API a scelta.
- Criteri di sicurezza: i seguenti domini nell'area funzionale System:
- Custom Report Creation
- Manage: All Custom Reports
- Report Tag Management
Context:
Per registrare un agente esterno, è necessario:
- Trovare gli ID Workday (WID) delle API Workday (SOAP e REST) pertinenti che si intende includere nella definizione degli strumenti dell'agente creando un report personalizzato.
- Trovare il provider agente utilizzando l' attivitàVisualizzazione provider agente.
- Richiamare l' API REST ASOR
Ricerca di WID basati su SOAP e REST per la definizione degli strumenti agente
- Accedere all'attivitàCreazione report personalizzato.
- La creazione del report contiene i seguenti elementi:OpzioneDescrizioneTipo reportSelezionareAvanzato.Ottimizzato per performanceDeselezionare questa casella di controllo.Origine datiSelezionarePublic Web Servicesfor SOAP APIs eAll Public Service Operationsfor REST APIs.
- Per le API SOAP: nella paginaModifica report personalizzato, nella schedaColonnedella definizione del report, aggiungere le seguenti righe:Oggetto businessCampoServizio WebServizio WebOperazione del servizio WebNome operazione servizio WebOperazione del servizio WebID Workday
- Per le API REST: nella paginaModifica report personalizzato, nella schedaColonnedella definizione del report, aggiungere le seguenti righe:Oggetto businessCampoOperazione di servizioServizioOperazione di servizioNomeOperazione di servizioID Workday
- Salvare ed eseguire il report.
Quando si recuperano i WID per le API, è anche possibile fare riferimento incrociato ai seguenti elenchi:
Individuare il provider dell'agente
I provider agente fanno riferimento a chi ha creato l'agente e vengono visualizzati nel campo
Creato da
nel profilo dell'agente.
- Accedere attivitàView Agent Provider, protetto al dominioSetup: Agentsnell'area area funzionale Agent System of Record .
- Utilizzare l'ID provider nella chiamata API di registrazione agente.
Trovare la piattaforma agente
Le piattaforme agente si riferiscono alla piattaforma o al sistema esterno su cui l'agente è sviluppato ed eseguito e vengono visualizzate nel campo
Integrazione
del profilo dell'agente.
- Accedere attivitàView Agent Platforms, protetto al dominio Setup Agents nell'area area funzionale Agent System of Record .
- Utilizzare l'ID piattaforma nella chiamata API di registrazione agente.
Richiamare l' API REST ASOR
Creare una nuova richiesta per registrare l'agente utilizzando un client API esterno, ad esempio Bruno.
La richiesta contiene i seguenti elementi:
- Endpoint:https://us.agent.workday.com/asor/v1/agentDefinition
- Operazione:POST
- Corpo:consultare la documentazione API ASOR v1.2 in Github e l'esempio di documentazione ASOR JSON Swagger .
- Intestazioni:
- Autorizzazione: Bearer < token>
- wd-agent-tenant-alias:< nome del tenant>
Hub gestione agenti
Dopo aver caricato la definizione dell'agente nel Workday, è possibile verificarne la registrazione visualizzandola nell'Hub
gestione agenti
.
- Accedere al reportHub gestione agenti.
- Fare clic suRegistro agentiper visualizzare un elenco degli agenti.
- Fare clic su un agente per visualizzarne le informazioni generali.
Passaggi successivi
Configurare l'agente in Workday.