Common issues and solutions in Build Agent
Summarize
Summary of Common issues and solutions in Build Agent
This guide helps ServiceNow customers identify and resolve frequent problems encountered with Build Agent in the Australia release version. It complements the general debugging approach by offering targeted solutions for common Build Agent errors and behaviors, enabling customers to quickly diagnose and fix issues for smoother development workflows.
Show less
General debugging approach
- Start by pasting the exact error message into the Build Agent chat; it often can diagnose and fix the problem automatically.
- If multiple fixes fail, structure your debugging by reproducing the error, reviewing logs, checking access/configuration, and verifying if the issue is known.
- Test hypotheses progressively from simple (access or role issues) to complex (logic edge cases).
- If unresolved, start a new chat with a precise prompt and save debugging information for possible Now Support contact.
Common issues and practical solutions
- Now Assist panel not visible: Confirm required plugins (snglider, snbuildagent, snnowcreator) and admin role are assigned; refresh or re-login; if unresolved, capture error details and user roles.
- Build Agent unresponsive: Clear browser cache, try a different browser, and verify ServiceNow service status; capture request and browser details if issue persists.
- Scope or name conflict: Check if the app scope or name is already used; allow Build Agent to assign a unique scope or select a new name manually; document the conflict if unresolved.
- Stuck in error loop: Use Git checkpoints or update set rollback to revert changes; begin a new conversation with the specific error and recent commits.
- App not deploying: Verify build output for errors before deployment; run ServiceNow SDK build and then deploy sequentially; provide build logs and update set status if issues continue.
- Empty UI page: Check browser console for errors; share console output with Build Agent to troubleshoot UI issues.
- Context limit exceeded: Start a new chat window and re-describe the application; Build Agent resumes work without previous session context.
- Out of prompts: Monitor your prompt usage within the 30-day cycle; wait for reset or upgrade to Now Assist for Creator; capture entitlement info if needed.
- Rate limit error: Occurs when too many requests are sent; wait briefly before retrying; record error and timestamp if persistent.
- Unsupported configuration: Confirm requested metadata/features are supported; manually complete unsupported steps on the platform, then continue with Build Agent.
- Missing dependencies (IDE): Check package.json entries; allow Build Agent to self-correct or manually add packages and run npm install; capture missing module and install errors if unresolved.
- Long-running prompt times out: Verify session timeout settings (glide.ui.sessiontimeout); coordinate with admins before changes; provide session length and prompt details if timeouts persist.
Key outcomes
By following this structured troubleshooting guidance and applying the tailored solutions, ServiceNow customers can efficiently resolve Build Agent issues related to access, configuration, deployment, session limits, and more. This ensures smoother development cycles, better application deployment success, and optimized use of Build Agent capabilities.
Identify and resolve common issues in Build Agent. Use this reference alongside the general debugging approach to identify and fix problems.
General debugging approach
When something goes wrong, paste the exact error message 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 you attempt several fixes in the same conversation without progress, 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.
Then 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 does not 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 |
|