Maven AGI Copilot Installation Guide

This guide provides step-by-step instructions for configuring the Maven AGI Copilot application on a ServiceNow instance after installation from the Store.

Prerequisites

Before you begin, ensure you have:

  • ServiceNow instance with admin access
  • Maven AGI Copilot application installed from the ServiceNow Store
  • Maven AGI account credentials (organization ID and agent ID from Agent Designer)

Setup Overview

The complete configuration process involves these steps:

  1. OAuth Configuration
  2. Maven AGI Configuration
  3. Configure Application Properties
  4. Configure UI Builder for Service Operations Workspace (SOW)
  5. Test the Installation
  6. Email Configuration (Optional)

1. OAuth Configuration

1.1 Enable Client Credentials Grant

Important: This step must be performed FIRST, before creating the OAuth Client Credentials Grant. This step must be performed in the Global scope. When you first log into your ServiceNow instance, you should already be in the Global scope, but verify by checking the scope selector in the top navigation bar.

ServiceNow Application Scope Selector

  1. Navigate to: All > sys_properties.list
  2. Search for or create the property:
    • Property: glide.oauth.inbound.client.credential.grant_type.enabled
    • Value: true
    • Type: true | false
  3. Click Submit, Create, or Update (if creating new)

Create System Property

1.2 Create OAuth Client Credentials Grant

This step can be performed in the Global scope or in the Maven AGI Copilot (x_magi_app) scope. Ensure step 1.1 is completed first.

The navigation path varies depending on your ServiceNow version:

For ServiceNow Zurich and Yokohama (Inbound Integrations)

  1. Navigate to: Instance > Inbound Integrations

Navigate to Inbound Integrations

  1. Click New Integration
  2. Select Client credentials grant
  3. Fill in the form:
    • Name: Enter a descriptive name (e.g., “Maven AGI Integration”)
    • OAuth application user: System Administrator
    • Client ID: Auto-generated (copy and save this value)
    • Client Secret: Auto-generated (copy and save this value)
  4. Click Submit

For ServiceNow Xanadu (Application Registry)

  1. Navigate to: System OAuth > Application Registry

Navigate to System OAuth

  1. Click New
  2. Select Create an OAuth API endpoint for external clients

Create OAuth Client

  1. Fill in the form:
    • Name: Enter a descriptive name (e.g., “Maven AGI Integration”)
    • Public Client: Leave unchecked (Client Credentials grant requires a confidential client)
    • Client Type: Select “Integration as a Service” (for machine-to-machine integrations)
    • Redirect URL and Login URL: Leave blank (not used for Client Credentials grant)
    • Client Secret: Leave blank (the system will auto-generate it after you save)
    • OAuth Application User: If visible, select System Administrator. If not visible, see below.

OAuth Client Configuration

  1. Click Submit

Configure OAuth Application User (if field was not visible)

The OAuth Application User must be configured, otherwise you will receive an error: “integration user is not configured for OAuth” when trying to authenticate.

If the OAuth Application User field was not visible in step 4:

  1. Right-click on the form and select Form Layout
  2. In the left panel, find the OAuth Application User field (or search for oauth_application_user)
  3. Drag it to the right panel to add it to the form
  4. Click Save
  5. The OAuth Application User field should now be visible in the form
  6. Select System Administrator (or another user with appropriate permissions)
  7. Click Save

Save Your Credentials

After saving, copy and save the generated values:

  • Client ID: Copy and save this auto-generated value
  • Client Secret: Copy and save this auto-generated value

Save both the Client ID and Client Secret securely. You will need these values for Maven AGI configuration.


2. Maven AGI Configuration

Configure the Maven AGI agent using the ServiceNow instance URL, Client ID, and Client Secret from section 1.

  1. Log into your Maven AGI account at app.mavenagi.com
  2. Navigate to agent settings
  3. Install/configure the ServiceNow connector with:
    • Instance URL: Your ServiceNow instance URL (e.g., https://your-instance.service-now.com)
    • Client ID: From section 1.2
    • Client Secret: From section 1.2

Maven Integration Configuration

  1. Click Install or Update

Maven will test the connection and confirm successful authentication. After configuring the agent in Maven AGI, proceed to section 3 to complete the ServiceNow configuration.


3. Configure Application Properties

Application properties are configured through the Maven Configuration Page.

3.1 Access Maven Configuration Page

  1. Navigate to: All and type Maven in the search field
  2. Select Maven App Configuration Page from the search results

Navigate to Maven Configuration

Choose the configuration page. You should see a page like this:

Maven Configuration Page

3.2 Configure Maven Settings

In the Maven Configuration section, verify and set:

  • Organization ID: Your Maven AGI organization ID (e.g., mavenagi-apps)
  • Agent ID: Your Maven AGI agent ID
  • Copilot URL: https://servicenow.onmaven.app (default)

If you delete the copilotUrl property, the app will default to https://servicenow.onmaven.app.

3.3 Configure Business Rules Triggers

Under Business Rules Trigger Configuration:

  1. Enable Business Rule Triggers (Global): Enable the global switch to allow business rule triggers
  2. Under Trigger Settings by Table, enable the triggers you need:
    • Enable Incident triggers: Triggers when incident records are updated
    • Enable Interaction triggers: Triggers when interaction (chat) records are updated
    • Enable Email triggers: Triggers when emails are received for incidents or cases
    • Enable Chat Message triggers: Triggers when new chat messages are added to interactions

3.4 Configure Knowledge Base Access (Optional)

If you want Maven Copilot to access ServiceNow knowledge articles:

  1. Enable Knowledge Base Access: Turn on the toggle
  2. Under Knowledge Tables, enable the tables you need:
    • Enable kb_knowledge table: Knowledge articles table
    • Enable kb_category table: Knowledge categories table
    • Enable kb_knowledge_base table: Knowledge bases table

3.5 Configure Webhook Authentication

  1. Webhook API Key: Generate a secure API key using openssl rand -hex 32 and enter it here
  2. This key is required for business rules to authenticate webhook calls from ServiceNow to Maven Copilot

The same API key must be configured in your Maven AGI backend settings.

  1. Click Save Configuration

All features are disabled by default for security. Enable only the features you need after installation.


4. Configure UI Builder for Service Operations Workspace (SOW)

After installing the app, the Maven Copilot UI component is available and can be configured on the Service Operations Workspace (SOW) sidebar.

4.1 Find SOW Experience

  1. Navigate to: UI Builder

Navigate to UI Builder

  1. Go to the Experiences tab

Experiences Tab

  1. In the search box, type: SOW or Service Operations Workspace
  2. Select the appropriate SOW experience

SOW in Experiences Tab

4.2 Configure Sidebar

The steps differ depending on your ServiceNow version.

For ServiceNow Zurich and Yokohama

  1. Click on the Tab sidebar in the left navigation

Sidebar Tab Configuration

  1. On the right side, in the Page Collection area, click the dotted box to edit content

Edit Page Collection

  1. Proceed to section 4.3

For ServiceNow Xanadu

In Xanadu, you might not be able to see the dotted square on the Page Collection area. In this case, you need to duplicate the SRP Record:

  1. Click on the Tab sidebar in the left navigation
  2. In the Page Collection area, you will see the existing record (e.g., “SOW - Sidebar tabs top”)
  3. Navigate to: UI Builder > Page Collections (or find the SRP Record directly)
  4. Open the SOW - Sidebar tabs top record (or the appropriate Page Collection record)
  5. Click Edit on the original scope (if the page is read-only)
  6. Click Duplicate variant
  7. Fill in the form:
    • Name: Enter a name (e.g., “Maven Copilot Sidebar”)
    • Application: Select Maven AGI Copilot (x_magi_app) scope
  8. Click Create or Save
  9. Go back to: UI Builder > Experiences > Service Operations Workspace
  10. You should now see the copilot record in the Page Collection
  11. Proceed to section 4.3

4.3 Create New Page

  1. Click Create new page

Create New Page

  1. Create from scratch instead of using a template

Choose Build Responsive

  1. You should see the “Maven Copilot” page setup details

Maven Copilot Page Setup

  1. Review the component parameters. No required parameters are necessary, and you can proceed to pressing Looks Good

Review Component Parameters

  1. You can leave the name set as default and simply click Continue

Click Default Variant

  1. You can choose the Build responsive option

Build Responsive Option

  1. Click Create

4.4 Add Maven Copilot Component

Now that you’ve created the page in ServiceNow, you can add the Maven Copilot UI component to this page.

  1. On the new page’s body, click Add content

Add Content

  1. Search for Maven Copilot component

Search for Maven Copilot Component

  1. Add the component to the page
  2. Click Save

4.5 Configure Sidebar Icon (Optional)

ServiceNow Bug: There is a bug in ServiceNow that prevents the icon from being shown by default. If you want the Maven icon to be displayed in the sidebar, you must follow these additional steps.

  1. Navigate to: All > sys_ux_app_route.list

Navigate to App Route

  1. Search for: Maven Copilot
  2. Filter by: Extension Point: SOW - Sidebar tabs top
  3. Click on the record to edit (click “here” if you see the link “To edit this record click here”)
  4. In the Icon field, enter: sn_tile_icon/x-magi-maven-copilot-ui-component.svg
  5. Click Save

If you don’t see the icon field in the form:

  1. Right-click on the form and select Form Layout
  2. In the left panel, find icon field
  3. Click the arrow to move it to the right panel (make sure it appears above endsplit)
  4. Click Save
  5. The icon field should now appear in the form
  6. Fill in the icon path: sn_tile_icon/x-magi-maven-copilot-ui-component.svg
  7. Click Save

5. Test the Installation

5.1 Navigate to Service Operations Workspace

Before navigating to Service Operations Workspace, ensure you have selected the Maven AGI Copilot (x_magi_app) scope in the scope selector. Failure to select the correct scope may result in permission errors.

  1. Select the Maven AGI Copilot (x_magi_app) scope from the scope selector in the top navigation bar
  2. Navigate to: Service Operations Workspace

SOW Workspace Navigation

  1. Select the list icon on the left sidebar
  2. Choose Incidents: All

Incidents List View

If your instance has demo data loaded, you should see a list of incidents.

5.2 Verify Copilot is Running

  1. Click on any incident to open it
  2. Look for the Maven Copilot icon in the right sidebar
  3. Click the Maven icon
  4. The Maven Copilot sidebar should load and display

Maven Copilot Loaded


6. Email Configuration (Optional)

6.1 Email Properties

  1. Navigate to: All > Email Properties

Navigate to Email Properties

  1. Go to Email Properties

Email Properties Configuration

  1. Ensure the following are enabled:
    • Email sending enabled
    • Email receiving enabled

6.2 Email Accounts

  1. Navigate to Email Accounts
  2. Configure POP3/IMAP/SMTP accounts as needed

If you already have email accounts configured, this step is not necessary. Default email accounts for vendor instances use the pattern [instance]@service-now.com.

Inbound Actions for email-triggered incident creation are already configured by the Maven AGI Copilot application. No additional configuration is required.

6.3 Testing Email

  1. Ensure email sending and receiving are enabled in Email Properties
  2. Send a test email to the configured email account
  3. Check System Mailboxes > Received for the received email
  4. Open the incident created from the email
  5. Verify the Maven Copilot sidebar loads on the right side of the screen

Maven in Email-Created Incident


Troubleshooting

OAuth Configuration Issues

Error: “integration user is not configured for OAuth”

This error occurs when the OAuth Application User field is not set in the OAuth application record.

Solution:

  1. Verify the system property glide.oauth.inbound.client.credential.grant_type.enabled is created and set to true BEFORE creating the OAuth Client Credentials Grant
  2. Navigate to System OAuth > Application Registry and open your OAuth application record
  3. If the OAuth Application User field is not visible, add it to the form layout (right-click form → Form Layout → add the field)
  4. Set the OAuth Application User to System Administrator
  5. Save the record and try authenticating again

Icon Not Appearing in Sidebar

If the Maven Copilot icon is not appearing in the sidebar:

  1. Navigate to: All > sys_ux_app_route.list
  2. Find the Maven Copilot route record
  3. Ensure the icon field is included in the form layout
  4. Verify the icon path is correct: sn_tile_icon/x-magi-maven-copilot-ui-component.svg

Component Not Loading

If the Maven Copilot component is not loading:

  1. Verify all application properties are set correctly via the Maven Configuration Page
  2. Check that the application is installed and active
  3. Verify you have the correct roles assigned
  4. Check browser console for any error messages

Copilot Shows “Connection Error”

Possible causes:

  1. Network connectivity issue between ServiceNow and Maven
  2. OAuth credentials incorrect or expired
  3. Maven agent not active

Solution: Verify OAuth configuration in both ServiceNow and Agent Designer


Summary

After completing this installation guide, you should have:

  1. ✅ OAuth Client Credentials Grant configured
  2. ✅ Maven AGI agent configured with ServiceNow credentials
  3. ✅ Application properties configured (via Maven Configuration Page)
  4. ✅ UI Builder configured for Service Operations Workspace
  5. ✅ Maven Copilot component visible and functional in SOW
  6. ✅ Email integration configured (optional)

Support

For additional assistance:


Next Steps

After completing setup:

  1. Train your Maven agent: Add ServiceNow-specific knowledge to your Maven knowledge base
  2. Configure personas: Customize Maven’s tone and style for ServiceNow interactions
  3. Set up actions: Enable Maven to take actions in ServiceNow (create follow-up tasks, update fields, etc.)
  4. Monitor performance: Use Maven Insights to track copilot usage and effectiveness

For more on optimizing your Maven agent, see: