Skip to main content
Version: Current

Server Agents

The Agents page lists all the server agents that are owned by or shared with the currently logged-in user.

You can design an Agent using the Agent Designer and publish them to the AI Command Center, where they are versioned, managed, executed, and monitored.

The Control Room workflow engine executes each published Agent and can be invoked manually, via triggers, or through APIs.

Agent Packages​

An Agent is stored and deployed as a agent package (*.nupkg), which contains all assets required for execution.

Agent Package Contents​

An agent package includes:

  • Workflow definition files (*.json)
  • Project metadata (project.json)
  • Form schemas (*.iform)

Each time an agent is published, a new version of the package is created in the AI Command Center.

Agent Views​

The Agents page provides multiple predefined views to help you quickly filter and manage processes by ownership, status, and collaboration.

You can change the view by selecting View from the toolbar or context menu.

ViewDescription
AllDisplays all Agents owned by or shared with the current user, including Draft, Active, and Inactive processes.
All ActiveDisplays all active (enabled) agents owned by or shared with the current user. This is the default view.
My ActiveDisplays active Agents owned by the current user.
My InactiveDisplays Agents owned by the current user that are currently disabled (inactive).
My DraftsDisplays Agents that are still in draft and have not yet been published.
Shared With MeDisplays Agents shared with the current user by other users.

Agent Version Management​

  • Every publish action creates a new version of the Agent.
  • Only one version can be active at any given time.
  • The active version is the one used during execution.
  • You can view and manage versions via Context Menu > View Metadata.

Buddies and workflow engines always execute the active version of the Agent.

Context Menu Options​

The Agents page provides the following context menu options:

IconOptionDescription
ShareShare the Agent with other users and manage permissions
DeleteDelete the Agent (requires Delete permission)
Edit MetadataManage versions, log levels, and activation
Edit ProcessOpen the Agent in Agent Designer for editing
DisableDisable (inactivate) the Agent
EnableEnable (activate) the Agent
EmbedGenerate an embeddable Process Monitor URL
CloneClone the Agent to create a new one
ViewView the Agent in read-only mode
View MetadataView metadata and version details
Create a RequestCreate a new process instance
Shared WithView users who have access to this Agent
AuditView audit history for this Agent

Sharing Agents​

Only the Agent Owner can share an Agent with other users.

Permission Types​

PermissionCapabilities
ViewerView and execute the Agent
EditorView, edit, re-publish, and execute the Agent
OwnerFull control: view, edit, publish, execute, delete, and share

How to Share an Agent​

  1. Navigate to Agents
  2. Select an Agent
  3. Open Context Menu > Share
  4. Select users and assign permissions
  5. Click Share

Viewing Sharing Information​

Use Context Menu > Shared With to view:

  • Users who have access
  • Their permission levels

Editing and Viewing Agents​

Edit Agent​

  • Available to Owners and Editors
  • Opens the Agent in Agent Designer
  • Changes must be saved and published to take effect

View Agent​

  • Opens the Agent in read-only mode
  • Allows inspection and export as an image
  • No modifications allowed

Cloning an Agent​

Cloning creates a new Agent using the current active version.

Steps:

  1. Select an Agent
  2. Click Clone
  3. Provide a new name (and optionally category/description)
  4. Click Clone
note

Only Owners and Editors can clone an Agent.

Enabling and Disabling Agents​

Disable Agent​

You must be the Process Owner or have Manage Other User BPA Process permission.

When a process is disabled:

  • The Agent becomes inactive
  • New instances cannot be created
  • Allocated licenses are released
  • Existing running instances continue uninterrupted

Disabled Agents appear in:

  • My Inactive
  • All views

Enable Agent​

Enabling reactivates the Agent:

  • The Agent becomes available for execution
  • New instances can be created again

Executing a Agent​

To execute an Agent, you must:

  • Have Initiate Process Instance permission
  • Have at least Viewer access to the Agent
  • Ensure the Agent is enabled

Steps:

  1. Navigate to Agents
  2. Select the Agent
  3. Click on Play button
  4. Monitor execution via Process Instances

Auditing Agents​

To view audit history:

  1. Select the Agent
  2. Open Context Menu > Audit
  3. Review all operations performed on the Agent

Embedding Process Monitor​

The Embed option allows monitoring Agent execution from external applications.

Steps:

  1. Select the Agent
  2. Click Embed
  3. Configure:    - Enable embedding    - Regenerate secret key (optional)    - Set link expiry
  4. Copy the Embed URL
  5. Append the Process Instance ID
  6. Open the URL in a browser or embed it in your application

Summary​

The Agents page provides:

  • Clear separation of draft, active, and inactive Agents
  • Flexible views for ownership and collaboration
  • Strong version control and auditability
  • Controlled lifecycle management for safely enabling or disabling Agent execution

This ensures governance, scalability, and predictable execution across enterprise-grade business workflows.