Skip to main content

Manage agents in the Agent registry

Register Workday agents in Sana, configure their skills and security groups, and activate or deactivate them.

J
Written by JP Arredondo

The Agent registry shows the agents in Workday's Agent System of Record inside Sana. From it, you can register agents, choose which skills they use, decide who can use each skill through Workday security groups, and activate or deactivate agents.

The Agent registry is for agents registered in Workday's Agent System of Record. It's separate from sharing agents that people build in Sana, which is covered in Centralised sharing for Agents.

This article covers:

  • Access: what you need in Workday to see and use the Agent registry

  • Managing agents: registering, configuring skills, and activating or deactivating agents

  • Agent tabs: the Documents and Credentials tabs some agents have


Before you start

Workday decides who sees the Agent registry, not your Sana role. The page appears only when your workspace is connected to Workday, Agent System of Record in Sana is enabled for your Workday tenant, and your Workday account has the Agent Management Hub task. Being a Sana workspace admin isn't enough on its own. If you don't have access, the Agent registry doesn't appear in your settings.

Workday task

What it lets you do in Sana

Agent Management Hub

See and open the Agent registry.

Setup: Agents

Register agents. Without it, the Register agents button doesn't appear.

If you don't see the Agent registry, or you can't register agents, ask your Workday administrator to review your access.


Managing agents

1. Open the Agent registry

  1. Click your workspace name at the top of the left sidebar.

  2. Select Workspace settings.

  3. Under Agent management, select Agent registry.

The page has two parts:

  • Registered agents: a table of the agents already added, with the columns Agent, Status, Built by, Built on and Date added. Click a column header to sort by it. Select an agent to open it. If nothing has been registered yet, the table shows "No agents are registered".

  • Available agents: cards for the agents you can register. If an agent can't be registered yet, its card is marked Missing prerequisites, shows the reason Workday gives, and has no Register button until that's resolved.

2. Register an agent

You can start in two ways:

  • Select Register agents at the top of the page. Under Choose an agent, select the agent you want to register. Agents with missing prerequisites aren't listed. If every available agent is already registered, you'll see "All available agents are already registered."

  • Select Register on an agent's card in Available agents. This takes you straight to the review step for that agent.

In the review step, choose one of these:

  • Register: adds the agent to the registry without configuring or activating it. You can finish setting it up from the agent's page at any time.

  • Register and Configure: adds the agent and takes you straight into configuring its skills.

For information about how using agents affects your flex credits, see the Workday Flex Credits Community page, linked from the review step.

3. Review the agent's overview

Select a registered agent to open its Overview. It shows the agent's profile (name, built on and built by), its current status, and its Lifecycle change history: when it was registered and last modified, and when it was activated or deactivated.

If the agent still needs setting up, the overview shows one of these messages:

  • Configuration required: the agent is registered but needs to be configured before it can be activated. Select Configure.

  • Review required: a suggested configuration is ready. Select Review setup, review the suggested configuration and save it to apply it.

4. Configure skills and access

The Skills tab lists the agent's skills in a table with these columns:

  • Skill name: the capability.

  • Tools: how many tools the skill uses.

  • Available to: the Workday security groups that can use the skill. A skill with no groups shows Not configured.

  • Execution mode: the level of authorization the agent has when it performs the skill.

  • Status: a switch that turns the skill on or off.

Select a skill to open its details. There you'll find its status, the Available to field, its Security and Execution settings and the list of tools it includes.

To set up a skill:

  1. Open the skill, and under Available to, search for and add at least one Workday security group. Select Save. These groups decide which users can use the skill.

  2. Turn the skill on with its status switch. A skill can't be turned on until it has a security group: the switch shows "Grant a security group to this skill to turn it on."

  3. To check the skill's setup in Workday, open the Skill security report and select View in Workday. It shows the effective policy and tool permissions, and lets you test your setup.

You can also do this while configuring the agent, from the configure step of the setup flow. You need at least one enabled skill to continue.

Note: if a skill's switch says "This skill can't be configured.", the skill can't be changed from the Agent registry. You'll also see this while a suggested setup is waiting for review: select Review setup on the agent's overview first.

5. Activate or deactivate an agent

After you configure at least one enabled skill, select Continue to reach the Activation summary, which lists the enabled skills and their security groups. Then choose:

  • Activate Agent: saves the configuration and makes the agent available to users.

  • Save and Exit: saves the configuration and leaves the agent inactive. You can activate it later from its overview.

Changes you make in the setup flow are saved only when you select Continue or Save and Exit. If you select Cancel, they're discarded.

To deactivate an active agent, open its overview and turn off the status switch. Deactivating pauses the agent.

Note: if the status switch is grayed out, Workday isn't allowing that change for the agent right now.


Agent tabs

Documents tab

The Documents tab appears for the Self-Service Agent when it's enabled for your Workday tenant. Use it to give the agent documents to ground its answers on:

  1. Under Source accounts, select Add source to connect an account.

  2. Under Documents, select Add documents and choose files or folders from a connected source. For SharePoint, you choose the site first.

Each document shows a sync status, such as Synced, Sync pending, Out of sync or Unavailable.

You can remove a document or disconnect a source account. Neither can be undone: removing a document takes it away from the agent, and disconnecting an account takes away every document synced from it.

If you see "Add Documents isn’t available yet — a required Workday configuration hasn’t been resolved.", ask your Workday administrator to complete the configuration.

Credentials tab

The Credentials tab appears only for registered third-party agents. It shows the endpoints and OAuth client details the agent uses:

  • Agent Credential Information: the agent's OAuth endpoint URLs.

  • OAuth Client Detail for Delegate Skills: the client ID, the redirect URI (which you can set or edit), the client secret, and whether PKCE is required.

  • OAuth Client Detail for Ambient Skills: the agent system user, the client ID and the x509 certificate (which you can set or replace).

Note: when you select Generate new secret, copy the new secret right away. You won't be able to see it again, and the previous secret stops working, so any service still using it must be updated to the new one.


Troubleshooting

An action fails with an error

If registering, activating, deactivating or saving a skill fails, Sana shows a message such as "Couldn't register this agent. Please try again." Try again. If it keeps failing, contact your Workday administrator.

Add Documents isn't available

If the Documents tab says a required Workday configuration hasn't been resolved, ask your Workday administrator to complete it.


FAQ

Q: I'm a Sana workspace admin. Why don't I see the Agent registry?

A: Access comes from Workday, not from your Sana role. Your workspace has to be connected to Workday, Agent System of Record in Sana has to be enabled for your tenant, and your Workday account needs the Agent Management Hub task. Ask your Workday administrator to check.

Q: Why don't I see the Register agents button?

A: Registering agents needs the Setup: Agents task in Workday. Ask your Workday administrator to review your access.

Q: Why can't I register an agent listed under Available agents?

A: Its card is marked Missing prerequisites. The card shows the reason Workday gives, and you can register the agent once it's resolved.

Q: Why can't I turn a skill on?

A: A skill needs at least one Workday security group before it can be turned on. Open the skill, add a group under Available to, select Save, then turn it on.

Q: Who can use an agent once it's active?

A: Users in the Workday security groups assigned to each enabled skill. The groups under Available to decide who can use that skill.

Q: Why doesn't my agent have a Documents or Credentials tab?

A: The Documents tab appears only for the Self-Service Agent, when it's enabled for your Workday tenant. The Credentials tab appears only for registered third-party agents.

Q: What happens when I generate a new client secret?

A: The previous secret stops working, and you can only see the new one once. Copy it right away and update any service that used the old secret.

Q: Is this where I share agents built in Sana with my organization?

A: No. The Agent registry manages agents registered in Workday's Agent System of Record. To publish agents people build in Sana, see Centralised sharing for Agents.


Related articles

Did this answer your question?