Issues and solutions in Build Agent
Summarize
Summary of Issues and solutions in Build Agent
This guide helps ServiceNow customers quickly identify and resolve common issues encountered with Build Agent in the Zurich release. It provides a structured debugging approach, troubleshooting tips, and specific resolutions to frequent problems, enabling smoother development and deployment workflows within the ServiceNow IDE.
Show less
General Debugging Approach
- Copy and paste the exact error message into the Build Agent chat for automated diagnosis and resolution.
- If unresolved, use a structured troubleshooting method: reproduce the issue consistently, review debugger output and logs, check access and configuration, and verify if it’s a known issue.
- Investigate hypotheses in order of simplicity—from access or role issues, configuration problems, naming conflicts, to logic edge cases.
- If multiple fixes fail, start a new chat with a specific prompt and save debugging information to assist Now Support if needed.
Common Issues and Practical Resolutions
- Now Assist panel not visible: Ensure required plugins (snglider, snbuildagent for Trial; snnowcreator for Premium) and admin role are assigned. Confirm supported release in ServiceNow Studio, refresh or re-login. Capture error details and roles if unresolved.
- Build Agent unresponsive: Clear browser cache, try another browser, and check ServiceNow status for outages. Capture request details and browser version if persistent.
- Scope or name conflict: Verify if the scope or app name is already used. Allow Build Agent to self-correct or choose a new unique name. Capture conflicting names and triggering actions if unresolved.
- Stuck in error loop: Revert using Git checkpoints or update set rollback, then restart with a clear error description. Capture error text and recent commits.
- App not deploying: Check build output for errors before deployment. Use ServiceNow SDK build followed by deploy/install steps. Paste build errors into chat for resolution. Capture build logs, SDK version, and update set status if needed.
- Empty UI page: Inspect browser console for errors, paste messages into Build Agent chat for fixes. Capture full console output if problem persists.
- Context limit exceeded: Start a new chat describing your app again as Build Agent has session context limits. Capture last prompt and build summary if issue continues.
- Out of prompts: Check prompt usage and wait for cycle reset or upgrade plan. Capture entitlement state if problems persist.
- Rate limit error: Wait briefly before retrying. Capture error message and timestamp if recurring.
- Unsupported configuration: Perform unsupported steps manually on the platform, then continue with Build Agent. Capture needed configuration and workarounds.
- Missing dependencies (IDE): Allow Build Agent to self-correct or manually add missing packages and run npm install. Capture missing module names and errors if unresolved.
- Long-running prompt times out: Adjust session timeout (glide.ui.sessiontimeout) cautiously in coordination with platform admin. Capture session length and timed-out prompt if still failing.
Identify and resolve common issues in Build Agent.
General debugging approach
Copy the error message and paste it into the Build Agent chat. Build Agent can often diagnose and fix the issue directly. If not, the error message is your starting point for debugging.
If several fixes in the same conversation don't resolve the issue, use a structured approach before starting a new chat.
Use the following prompt to structure your debugging session:
I'm seeing this error: [paste exact error]. This happens when: [describe scenario]. Before suggesting fixes: 1) Help me reproduce this consistently. 2) Review the debugger output and logs. 3) Check for access or configuration issues. 4) Examine if this is a known issue.
Test hypotheses from simplest to most complex:
- Is this an access or role issue?
- Is this a configuration problem?
- Is this a naming convention mismatch?
- Is this a logic edge case?
If structured investigation doesn't resolve the issue within a few attempts, start a fresh conversation with a more specific prompt.
Save any debugging information to convey if you need to contact Now Support.
Issues and solutions
| Issue | Resolution |
|---|---|
| Now Assist panel not visible |
|
| Build Agent unresponsive |
|
| Scope or name conflict |
|
| Stuck in error loop |
|
| App not deploying |
|
| Empty UI page |
|
| Context limit exceeded |
|
| Out of prompts |
|
| Rate limit error |
|
| Unsupported configuration |
|
| Missing dependencies (IDE) |
|
| Long-running prompt times out |
|