Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Administrator Guide
Zuletzt aktualisiert: 2026-03-13
Externe Agenten registrieren

Externe Agenten registrieren

Voraussetzungen

Basierend auf der Service Ihrer Organisation müssen möglicherweise zusätzliche Schritte durchgeführt werden, um dieses Feature zu aktivieren. Ihre Organisation ist entweder im Main Service Agreement (MSA) oder im Universal Main Service Agreement (UMSA) aufgeführt. So bestimmen Sie die Service Ihrer Organisation:
  1. Wählen Sie Ihren Profil-Avatar in der Workday Community aus.
  2. Wählen Sie
    Profil
     aus.
  3. Wählen Sie auf Ihrer Profilseite den Namen Ihrer Organisation aus, der sich unter Ihrem Namen und neben Ihrer Tätigkeitsbezeichnung befindet.
  4. Zeigen Sie den Wert Ihrer
    Abonnementservicevereinbarung
     an.
Je nach Wert müssen Sie wie folgt vorgehen:
Flexible Credits sind nur für die Registrierung und Verwendung von Agenten in Ihren Produktionsmandanten erforderlich . Sie können erst dann Agenten in der Produktion registrieren und verwenden, wenn Sie ein Opt-in für diese Vereinbarungen gesetzt haben. UMSA ist für Nicht-Produktions- und Produktionsmandanten für von Workday erstellte Agenten erforderlich . UMSA ist für Nicht-Produktionsmandanten für selbst erstellte Agenten nicht erforderlich .
Agent System of Record einrichten .
Sicherheit:
  • Domäne
    Agent Management Hub
     im funktionaler Bereich„Agent System of Record“ . Erforderlich, um zu validieren, ob der Agent in Workday registriert ist.
  • Domäne
    Manage Agents
     im funktionaler Bereich„Agent System of Record“ . Erforderlich für Konfiguration und Kenntnis
  • Domäne
    Set Up: Tenant Setup - Security
     im funktionalen Bereich „System“. Erforderlich für die Registrierung.

Kontext

Momentan können Sie externe Agenten in Workday nur mithilfe der ASOR- API (Application Programming Interface) registrieren und definieren. Externe Agenten werden gleichzeitig mithilfe der API (Application Programming Interface) definiert und registriert. Sie sind keine zwei separaten Schritte. Sie können einen beliebigen API (Application Programming Interface) Client verwenden, um die API (Application Programming Interface) aufzurufen.
Registrierungsendpunkte:
  • REST-API -Endpunkt:
     https://us.agent.workday.com/asor/v1/agentDefinition.
  • Token-Endpunkt:
     https://us.agent.workday.com/auth/oauth2/<Tenant_Name>/ Token
  • Endpunkt autorisieren:
     https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3patent1&redirect_uri=<redirect_uri>
Informationen zur anderen regionalen Verfügbarkeit außerhalb der USA finden Sie in der Dokumentation zum Agent Gateway:Referenz: Regionale Verfügbarkeit von Agent Gateway .

Authentifizierungsoptionen:

Um externe Agenten zu registrieren, benötigen Sie ein Zugriffs-Token in Ihrem ASOR API (Application Programming Interface) Aufruf. Im Folgenden finden Sie die verschiedenen Optionen, um ein Token zum Aufrufen des ASOR API (Application Programming Interface) Aufrufs abzurufen.
Option 1: API (Application Programming Interface) Client manuell authentifizieren
  1. Öffnen Sie die Aufgabe
    Register API (Application Programming Interface) Client
     .
    • Client-Name:
       Geben Sie einen eindeutigen identifizierbaren Namen für Ihren Agenten ein. Wir empfehlen, für jeden Agenten einen separaten Client zu verwenden, damit diese einfacher verwaltet werden können.
    • Client-Gewährungsart:
      Gewährung des Autorisierungscodes
       .
    • Zugriffs-Token-Art:
      Bearer
       .
    • Umleitungs-URI:
       Geben Sie eine URL ein, zu der Benutzer nach der Autorisierung umgeleitet werden sollen.
    • Bereich (funktionale Bereiche):
      Agent System of Record
       .
    • Workday -eigenen Bereich einschließen:
       Aktivieren Sie dieses Kontrollkästchen.
  2. Kopieren und speichern Sie die Werte
    Client-ID
     und
    Geheimer Client-Schlüssel
     . Sie können diese verwenden, um ein Zugriffs-Token zum Aufrufen der Definitions API (Application Programming Interface) abzurufen.
  3. Fügen Sie diese URL in ein neues Fenster ein. Sie sollten mit einem angehängten Code zu google.com weitergeleitet werden, mit dem Sie die folgende API (Application Programming Interface) aufrufen können:
    https://us.agent.workday.com/auth/authorize/<Tenant_Name>?response_type=code&client_id=<client_id>&state=test3patent1&redirect_uri=<redirect_uri>
  4. Erstellen Sie eine neue Anforderung; Antrag mit einem externen API (Application Programming Interface) Client (Beispiel: Brian):
    https://<tenantHost>/ccx/oauth2/<tenantName>/ Token
    • Text:
      Grant_type=authorization_code&code=<authorizationCode>&client_id=<clientID>&client_secret=<ClientSecret>
    • Auth: Benutzername =
      <ClientID>
       , Kennwort =
      <ClientSecret>
       .
    • Dadurch werden ein Zugriffs-Token und ein aktualisieren Token generiert, mit denen Sie die API (Application Programming Interface) der ASOR-Agentendefinition aufrufen können.
    • Bei der Bearbeitung dieses Schritts sind folgende Informationen zu beachten:Konzept: Überlegungen zu externen Agenten .
Der Benutzer, der den Agenten Registrierung, muss Zugriff auf die Domäne "Setup: Agents" im funktionaler Bereich "Agent System of Record" haben, um einen Agenten mithilfe der ASOR- API (Application Programming Interface) zu registrieren.
Option 2: Authentifizieren Sie mithilfe von Extend
Wenn Sie ein Benutzer von Workday Extend oder Workday Orchestrate sind, können Sie ein Zugriffs-Token über die Entwicklersite von Workday abrufen.
  1. Öffnen Sie Developer.workday.com und melden Sie sich an.
  2. Klicken Sie oben rechts auf das Benutzermenü. Im Menü sollte der Name Ihres aktuellen Unternehmen angezeigt werden.
  3. Klicken Sie auf
    Mandantenanmeldung
    bei Mandant
     .
  4. Wählen Sie Ihre Umgebung und Mandant aus und klicken Sie auf
    Connect to Tenant
     .
  5. Melden Sie sich beim Mandant "" an. Sie müssen sich mit einem Konto anmelden, das Zugriff auf die Domäne
    "Setup: Agents"
     im funktionaler Bereich "Agent System of Record" hat, um einen Agenten mithilfe der ASOR- API (Application Programming Interface) zu registrieren.

Registrieren Sie einen externen Agenten mithilfe der ASOR- API (Application Programming Interface)

Voraussetzungen:
  • Ein Zugriffs-Token für ein Konto, das Zugriff auf die Domäne
    Setup: Agents
     im funktionaler Bereich„Agent System of Record“ hat.
  • Ein API (Application Programming Interface) Client Ihrer Wahl.
  • Sicherheit: Folgende Domänen im funktionalen Bereich „System“:
    • Custom Report Creation
    • Manage: All Custom Reports
    • Report Tag Management
Kontext:
Um einen externen Agenten zu registrieren, müssen Sie Folgendes tun:
  • Suchen Sie nach den WIDs der relevanten Workday - APIs (SOAP und REST), die Sie in die Tools-Definition Ihres Agenten aufnehmen möchten, indem Sie einen benutzerdefinierter Bericht erstellen.
  • Suchen Sie den Agent-Anbieter mithilfe der Aufgabe
    "Agent-Anbieter anzeigen"
     .
  • Rufen Sie die REST-API ASOR auf
Wählen Sie SOAP- und REST-basierte WIDs für die Definition von Agent-Tools
  1. Öffnen Sie die Aufgabe
    Create Custom Report
    .
  2. Bei der Erstellung des Berichts sind folgende Informationen zu beachten:
    Option
    Beschreibung
    Berichtsart
    Wählen Sie
    Erweitert
     aus.
    Optimiert für Performance
    Deaktivieren Sie dieses Kontrollkästchen.
    Datenquelle
    Wählen Sie
    Public Web Services
     für SOAP-APIs und
    Alle Public Service Operations
     für REST-APIs.
  3. Für SOAP-APIs: Fügen Sie auf der Seite
    Edit Custom Report
     auf dem
    Register
     Spalten der Berichtsdefinition die folgenden Zeilen hinzu:
    Geschäftsobjekt
    Feld
    Webservice
    Webservice
    Webservicevorgang
    Name des Webservicevorgangs
    Webservicevorgang
    Workday-ID
  4. Für REST-APIs: Fügen Sie auf der Seite
    Edit Custom Report
     auf dem
    Register
     Spalten der Berichtsdefinition die folgenden Zeilen hinzu:
    Geschäftsobjekt
    Feld
    Servicevorgang
    Service
    Servicevorgang
    Name
    Servicevorgang
    Workday-ID
  5. Speichern Sie den Bericht und führen Sie ihn aus.
Beim Abrufen von WIDs für Ihre APIs können Sie auch auf folgende Listen verweisen:
Suchen Sie den Agent-Anbieter
Agent-Anbieter geben an, wer den Agenten erstellt hat, und werden im Feld
Erstellt von
 im Profil des Agenten angezeigt.
  1. Öffnen Sie die Aufgabe
    Agent-Anbieter anzeigen
     , gesichert über die Domäne
    Setup: Agents
     im funktionaler Bereich„Agent System of Record“.
  2. Verwenden Sie die Anbieter-ID in Ihrem API (Application Programming Interface) -Aufruf zur Agentenregistrierung.
Suchen Sie die Agent-Plattform
Agent-Plattformen verweisen auf die externe Plattform oder das System, auf dem der Agent entwickelt wird und ausgeführt wird und die im Feld
Erstellt
 für im Profil des Agenten angezeigt werden.
  1. Öffnen Sie die Aufgabe
    Agent-Plattformen anzeigen
     , die über die Domäne Setup Agents im funktionaler Bereich „Agent System of Record“ gesichert ist .
  2. Verwenden Sie die Plattform-ID in Ihrem API (Application Programming Interface) Aufruf zur Agentenregistrierung.
Rufen Sie die REST-API ASOR auf
Erstellen Sie eine neue Anforderung; Antrag , um Ihren Agenten über einen externen API (Application Programming Interface) Client zu registrieren, z. B. Brian.
Bei der Erstellung der Anforderung; Antrag sind folgende Informationen zu beachten:

Agent-Management-Hub

Nachdem Sie Ihre Agent-Definition erfolgreich in Workday geladen haben, können Sie verifizieren, ob die Agent-Definition registriert ist, indem Sie sie im
Agent-Management-Hub
 anzeigen.
  1. Öffnen Sie den Bericht
    Agent-Management-Hub
     .
  2. Klicken Sie auf
    Registrierung von Agenten
     , um eine Liste Ihrer Agenten anzuzeigen.
  3. Klicken Sie auf einen Agenten, um Übersichtsinformationen zu ihm anzuzeigen.

Nächste Schritte

Konfigurieren Sie Ihren Agenten in Workday.