Externe agents registreren
Vooraf vereist
Mogelijk moet u aanvullende stappen uitvoeren om deze functie in te schakelen op basis van de service van uw organisatie. Uw organisatie is opgenomen in de Main Service Agreement (MSA) of de Universal Main Service Agreement (UMSA). Ga als volgt te werk om de service van uw organisatie te bepalen:
- Selecteer uw profielavatar in Workday Community .
- SelecteerProfiel.
- Selecteer op uw profielpagina de naam van uw organisatie. Deze wordt onder uw naam en naast uw functietitel weergegeven.
- Hiermee kunt u de waarde van uwabonnementsserviceovereenkomstweergeven.
Als de waarde is:
- UMSA, de functie is automatisch beschikbaar. Zie Concept: Workday AI for Universal Main Subscription Agreement Customers voor meer informatie over gegevensbijdragen op basis van machine learning.
- MSA, uw organisatie moet zich aanmelden voor uMSA.
Flexkrediet is alleen vereist voor het registreren en gebruiken van agents in uw productietenants. U kunt pas agents in productie registreren en gebruiken als u zich hebt aangemeld voor deze overeenkomsten. UMSA is vereist voor niet-productietenants en productietenants voor door Workday gemaakte agents. UMSA is niet vereist voor niet-productietenants voor zelfgebouwde agents.
Beveiliging:
- Het domeinHub voor agentbeheerin het functionele gebied 'Agent System of Record'. Vereist om te valideren dat de agent is geregistreerd in Workday.
- Het domeinManage Agentsin het functionele gebied 'Agent System of Record'. Vereist voor activering en configuratie.
- Het domeinSet Up: Tenant Setup - Securityin het functionele gebied 'System'. Vereist voor registratie.
Context
Momenteel kunt u externe agents in Workday alleen registreren en definiëren met behulp van de ASOR- API. Externe agents worden tegelijkertijd gedefinieerd en geregistreerd met behulp van de API. Het zijn geen twee afzonderlijke stappen. U kunt elke gewenste API client gebruiken om de API aan te roepen.
Raadpleeg de API documentatie ASOR v1.2 in Github en het ASOR JSON Swagger-documentatievoorbeeld voor het oplossen van problemen.
Registratie-eindpunten:
- REST API Endpoint:https://us.agent.workday.com/asor/v1/agentDefinition.
- Token Endpoint:https://us.agent.workday.com/auth/oauth2/<Tenant_Name>/token
- Eindpunt autoriseren:https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3pagent1&redirect_uri=<redirect_uri>
Zie de documentatie bij Agent Gateway voor informatie over andere regionale beschikbaarheid buiten de VS:Referentie: regionale beschikbaarheid van agentgateway .
Verificatieopties:
Als u externe agents wilt registreren, hebt u een toegangstoken nodig in uw ASOR- API aanroep. Hieronder vindt u de verschillende opties voor het verkrijgen van een token om de ASOR API aanroep aan te roepen.
Optie 1: een API client handmatig verifiëren
- Open de taakRegister- API client.
- Clientnaam:voer een unieke identificeerbare naam in voor uw agent. U wordt aangeraden voor elke agent een afzonderlijke client te gebruiken, zodat ze eenvoudiger te beheren zijn.
- Toekenningstype klant:toekenning autorisatiecode.
- Type toegangstoken:drager.
- Omleidings-URI:voer een URL in waarnaar gebruikers na autorisatie moeten worden omgeleid.
- Bereik (functionele gebieden):geregistreerd agentsysteem.
- Bereik in eigendom van Workday opnemen:schakel dit selectievakje in .
- Kopieer de waarden voor declient-IDenhet clientgeheimen sla ze op. U kunt deze gebruiken om een toegangstoken op te halen om de definitie- API aan te roepen.
- Plak deze URL in een nieuw venster. U wordt omgeleid naar google.com met een toegevoegde code die u kunt gebruiken om de API aan te roepen:https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3pagent1&redirect_uri=<redirect_uri>
- Maak een nieuwe aanvraag met behulp van een externe API client (bijvoorbeeld: Bruno):https://<tenantHost>/ccx/oauth2/<tenantName>/ token
- Hoofdtekst:Grant_type=authorization_code&code=<authorizationCode>&client_id=<clientID>&client_secret=<ClientSecret>
- Auth: Gebruikersnaam =<ClientID>, Wachtwoord =<ClientSecret>.
- Hiermee worden een toegangstoken en vernieuwen gegenereerd token u de ASOR Agent Definition API kunt aanroepen.
- Houd bij het voltooien van deze stap rekening met het volgende:Concept: overwegingen voor ASU externe agent .
De gebruiker die de agent registreert, moet toegang hebben tot het domein 'Setup: Agents' in het functionele gebied 'Agent System of Record' om een agent te registreren met behulp van de ASOR- API.
Optie 2: verifiëren met Extend
Als u een Workday Extend- of Workday Orchestrate-gebruiker bent, kunt u een toegangstoken ophalen via de ontwikkelaarssite van Workday.
- Ga naar 'developer.workday.com' en meld u aan.
- Klik in de rechterbovenhoek op het gebruikersmenu. In het menu moet de huidige bedrijf worden weergegeven.
- Klik op .
- Selecteer uw omgeving en tenant en klik opVerbinden met tenant.
- Meld u aan bij de tenant ''. Als u een agent wilt registreren met behulp van de ASOR- API , moet u zich aanmelden met een account dat toegang heeft tot het domein'Setup: Agents'in het functionele gebied 'Agent System of Record'.
Een externe agent registreren met behulp van de ASOR- API
Vereisten:
- Een toegangstoken voor een account dat toegang heeft tot het domein'Setup: Agents'in het functionele gebied 'Agent System of Record'.
- Een API client naar keuze.
- Beveiliging: de volgende domeinen in het functionele gebied 'System':
- Custom Report Creation
- Manage: All Custom Reports
- Rapporttagbeheer
Context:
Als u een externe agent wilt registreren, moet u:
- Zoek de Workday ID's (WID's) van de relevante Workday API's (SOAP en REST) die u wilt opnemen in de definitie van hulpprogramma's van uw agent door een aangepast rapport '' te maken.
- Zoek de agentaanbieder met behulp van de taakvoor de agentaanbieder weergeven.
- ASOR REST-API aanroepen
Op SOAP- en op REST gebaseerde WID's zoeken voor definitie agenthulpprogramma's
- Open de taakAangepast rapport maken.
- Houd bij het maken van het rapport rekening met het volgende:OptieOmschrijvingRapporttypeSelecteerGeavanceerd.Geoptimaliseerd voor prestatiesSchakel dit selectievakje uit.GegevensbronSelecteerOpenbare webservicesvoor SOAP-API's enAlle bewerkingen van openbare dienstenvoor REST-API's.
- Voor SOAP-API's: voeg op de paginaAangepast rapport bewerkenop het tabbladKolommenvan de rapportdefinitie de volgende rijen toe:BedrijfsobjectVeldWebserviceWebserviceWebservicebewerkingNaam webservicebewerkingWebservicebewerkingWorkday-ID
- Voor REST-API's: voeg op de paginaAangepast rapport bewerkenop het tabbladKolommenvan de rapportdefinitie de volgende rijen toe:BedrijfsobjectVeldServicebewerkingServiceServicebewerkingNaamServicebewerkingWorkday-ID
- Sla het rapport op en voer het uit.
Wanneer u WID's voor uw API's ophaalt, kunt u ook kruisverwijzingen naar deze lijsten maken:
Aanbieder agent zoeken
Agentaanbieders geven aan wie de agent heeft gebouwd en worden weergegeven in het veld
'Gebouwd door'
in het profiel van de agent.
- Open de taak'Agentaanbieder weergeven'( beveiligd in het domein'Setup: Agents') in het functionele gebied 'Agent System of Record'.
- Gebruik de aanbieder-ID in uw API aanroep voor agentregistratie.
Agentplatform zoeken
Agentplatforms verwijzen naar het externe platform of systeem waarop de agent is ontwikkeld en uitgevoerd. Deze worden weergegeven in het veld
'Gebouwd op'
in het profiel van de agent.
- Open de taak'Agentplatforms weergeven'( beveiligd in het domein 'Setup Agents') in het functionele gebied 'Agent System of Record'.
- Gebruik de platform-ID in uw API aanroep voor agentregistratie.
ASOR REST-API aanroepen
Maak een nieuwe aanvraag om uw agent te registreren met behulp van een externe API client, bijvoorbeeld: Bruno.
Houd bij het maken van de aanvraag rekening met het volgende:
- Endpoint:https://us.agent.workday.com/asor/v1/agentDefinition
- Bewerking:POST
- Hoofdtekst:raadpleeg de API documentatie voor ASOR v1.2 op Github en het ASOR JSON -documentatievoorbeeld .
- Kopteksten:
- Autorisatie: Bearer < token>
- wd-agent-tenant-alias:<uw tenantnaam>
Hub voor agentbeheer
Nadat u de agentdefinitie in Workday hebt geladen, kunt u controleren of de definitie is geregistreerd in de
hub voor agentbeheer
.
- Open het rapportHub voor agentbeheer.
- Klik opAgentregisterom een lijst met uw agents weer te geven.
- Klik op een agent om overzichtsgegevens voor de agent weer te geven.
Volgende stappen
Configureer uw agent in Workday.