The CloudRadial AutomationAI ServiceNow extension lets a workflow or agent work with ServiceNow ITSM records: list, read, create, and update incidents and change requests, add work notes, look up problems and service catalog requests and tasks, query the configuration management database (CMDB), and find users. This article covers what the extension can do, the service account it needs, which tools require approval, how to query records, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
- What the Extension Covers
- Setting Up a ServiceNow Service Account
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Querying ServiceNow Records
- Skills
- Tips for Working With ServiceNow Data
What the Extension Covers
The extension calls the ServiceNow REST Table API on your instance and provides 16 tools across these areas:
| Area | What you can automate |
| Incidents | List and read incidents, create an incident, update its state, priority, or assignment, and add a work note or customer-visible comment |
| Change requests | List and read change requests, create a normal, standard, or emergency change, and update one, for example to move its state, set its schedule, or assign it |
| Problems | List and read problem records. Read-only. |
| Service catalog | List service catalog requests, and list and read their fulfillment tasks. Read-only. |
| CMDB | Query configuration items across all CI classes, such as servers, applications, and network gear. Read-only. |
| Users | Find a user to resolve a caller, assignee, or requester. Read-only. |
Install it from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
Setting Up a ServiceNow Service Account
The extension signs in to ServiceNow with HTTP Basic authentication: the username and password of a ServiceNow account. Use a dedicated service account rather than a person's own account. Creating a user requires the user_admin role in ServiceNow. Go to All > User Administration > Users, select New, fill in the form, and then:
- Select the Web service access only check box, which marks the account as non-interactive. If your instance's user form has an Identity type field, select Machine, which turns the check box on for you.
- Add only the roles it needs for the tables your automations touch, for example
itilfor incidents, problems, and changes - Save the record, then select Set Password to give the account a password. Basic authentication does not work without one.
For the full procedure, see ServiceNow's Create a user documentation.
Providing the Credentials to Your Runner
Store three secrets in your runner's Key Vault with these exact names:
| Secret | Value |
ServiceNow-ApiUrl |
Your instance base URL, for example https://acme.service-now.com, with no path after it |
ServiceNow-Username |
The service account's username |
ServiceNow-Password |
That account's password |
For how to add these, see Accessing and updating your runner's Key Vault. The agent reads the credentials from the runner and never asks you for them. If you work in a separate ServiceNow instance for each client, see Managing companies and per-company credentials.
Reads and Approval-Gated Changes
Of the 16 tools, 11 are read-only and run without interruption. The other 5 create or change something, and every one of them is approval-gated: the run pauses and the request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
| Tool behavior | Tools |
| Approval-gated | Create an incident; update an incident; add a work note or comment to an incident; create a change request; update a change request |
| Read-only | List and read incidents, change requests, problems, and catalog tasks; list catalog requests; query the CMDB; find users |
The extension has no delete tools.
Querying ServiceNow Records
List tools take a ServiceNow encoded query. Join conditions with ^ for AND and ^OR for OR, and sort with ^ORDERBY or ^ORDERBYDESC followed by a field name. For example:
-
active=true^priority=1finds active priority 1 records -
short_descriptionLIKEvpnfinds records whose short description contains "vpn" -
sys_class_name=cmdb_ci_serverlimits a CMDB query to servers
List tools page through results for you and return the complete set in one call, up to a page limit. Narrow a large query with conditions rather than asking for every record.
Every record has two identifiers. The sys_id is a 32-character key that tools use to read and update the record. The number, such as INC0010001 or CHG0030001, is the reference people use. Reference fields, such as the caller, assignee, assignment group, and configuration item, take the referenced record's sys_id, so the agent looks up the user or CI first.
Skills
The extension ships five skills that guide an agent through common ServiceNow tasks:
| Skill | Use it to |
| Manage Incidents | Find, read, open, or update an incident, including changing its state, priority, or assignment, or adding a work note. Creates and updates are approval-gated. |
| Manage Change Requests | Find, read, raise, or update a normal, standard, or emergency change request and move it through its states. Creates and updates are approval-gated. |
| Look Up Problems & Requests | Read problem records, service catalog requests, and their fulfillment tasks. Read-only. |
| Query the CMDB | Find or read configuration items such as servers, applications, network gear, and services. Read-only. |
| Look Up Users | Find a user and their sys_id to resolve a caller, assignee, requester, or approver before setting a reference field. Read-only. |
Tips for Working With ServiceNow Data
- Refer to people by name, email address, or username and let the agent look up their
sys_id - Choice fields take ServiceNow's stored value, not the label. For incident state, 1 is New, 2 is In Progress, 3 is On Hold, 6 is Resolved, 7 is Closed, and 8 is Canceled. For priority, 1 is Critical through 5 is Planning; for impact and urgency, 1 is High, 2 is Medium, and 3 is Low.
- Work notes are internal, and comments are visible to the customer. Adding either appends an entry to the incident's activity log; it does not replace earlier notes.
- To scope catalog tasks to one request, filter on the request's
sys_id, for examplerequest=<sys_id> - If every call fails at sign-in, check that
ServiceNow-ApiUrlis your instance host with no path, and that the service account has a password and web service access - If an approved create or update fails, check that the service account has the roles for that table
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.