Skip to main content

Set up ServiceNow CMDB

Setting up this connector is a guided sequence of seven steps. You can move back at any point, and nothing is created until the last step.

Have your instance URL and a credential ready before you start — see what you need.

Only the first two steps need information from ServiceNow

Steps 3 to 7 are all choices, and every one of them has a sensible default. If you are setting this up for the first time, you can accept what is already selected and change it later.

Open the connector list​

Select the settings icon in the top bar.

The Mesh top bar, with the settings icon beside the search box

Choose Connectors.

The Settings menu, with Connectors in the list

Select Add connector.

The Connectors page, with the Add connector button above the list

Choose ServiceNow CMDB under Guided setup.

The Add connector panel, with ServiceNow CMDB under Guided setup

There is one ServiceNow CMDB entry, and it is under Guided setup

Guided setup is the only way to create this connector, and the same sequence opens again when you edit it later. If the entry is greyed out, guided setup has not been switched on for your tenant yet — contact Axiad.

Step 1 — Identify​

Name the connector and tell Mesh which instance to read.

FieldRequiredWhat to enter
Connector nameYesA label of your choosing. It appears in the connector list and in reports, and you can change it later
ServiceNow instance URLYesYour instance address, for example https://acme.service-now.com

Step 1, Identify, with the connector name and ServiceNow instance URL fields

Rules for the instance URL:

RuleAllowedNot allowed
HTTPS onlyhttps://acme.service-now.comhttp://acme.service-now.com
A service-now.com addresshttps://acme.service-now.comhttps://cmdb.example.com
The address only — no path or queryhttps://acme.service-now.comhttps://acme.service-now.com/nav_to.do
No credentials in the URLhttps://acme.service-now.comhttps://user:pass@acme.service-now.com

A trailing slash is accepted, and so is an explicit :443. Any other port is not.

The instance decides where everything came from

Every record Mesh collects is attributed to this instance. To read a second instance, add a second connector rather than changing this one.

Step 2 — Authenticate​

Choose how Mesh signs in, then fill in only that method's fields.

MethodWhat you enterUse it when
api keyAPI keyYour instance issues API keys for integrations
bearerBearer tokenYou already hold a token issued for this integration
basicUsername, passwordA service account signs in directly
oauth2 client credentialsClient ID, client secret, token URL (optional)An OAuth application integrates on its own behalf
oauth2 passwordClient ID, client secret, username, password, token URL (optional)An OAuth application integrates as a named service account

Step 2, Authenticate, with the api key method selected

Selecting a different method replaces the fields below the cards. The bearer method asks for a single token:

Step 2 with the bearer method selected, asking for a bearer token

Both OAuth methods ask for a client ID and a client secret:

Step 2 with oauth2 client credentials selected, asking for a client ID, client secret and optional token URL

oauth2 password adds a username and password to those, so the OAuth application acts as that account:

Step 2 with oauth2 password selected, asking for client ID, client secret, username, password and optional token URL

Which method to ask for​

Start with whichever your ServiceNow administrator already provisions for integrations. If you have a free choice, the two OAuth methods are preferable: the credential can be revoked on its own without disturbing the account.

If OAuth is set up but refuses the connector

Instances are often provisioned for one OAuth grant and not the other. A common pattern is that basic is refused and oauth2 client credentials reports that the integration user is not configured for OAuth, while oauth2 password works — because the OAuth application is registered against a named account rather than on its own behalf. If an OAuth method fails and your administrator confirms the client is active, try the other one before assuming the credential is wrong.

Things worth knowing​

Fill in one method onlyEnter the credentials for the method you selected and leave the others empty. A configuration carrying credentials for more than one method is refused
The token URL is optionalLeave it empty and Mesh uses your instance's standard token endpoint. Set it only if your instance issues tokens somewhere else
The client ID is not a secretIt is a public identifier. It is shown back to you when you edit the connector. Never paste the client secret into this field
Secrets are never shown againThe client secret, password, API key and bearer token are stored encrypted. When you edit the connector later, leave a secret field empty to keep the stored value

Test connection on this step checks the credential on its own, before you choose any data. You can continue once it passes.

Step 3 — Choose data​

Choose which ServiceNow tables Mesh reads. Each one is a group of records rather than a single field, and the panel header counts how many of the eleven you have selected.

Step 3, Choose data, listing the standard ServiceNow table groups with checkboxes

Table groupServiceNow tableBecomes in MeshSelected by default
Configuration itemscmdb_ci_computerMachine assetsYes
Installed softwarecmdb_sam_sw_installSoftware assetsYes
Peoplesys_userUser accountsYes
Groupssys_user_groupGroupsYes
Group membershipssys_user_grmemberWho belongs to which groupYes
Organizationscmn_departmentOrganization contextYes
Locationscmn_locationLocation recordsYes
Certificatescmdb_ci_certificateCertificate recordsYes
Vulnerabilitiessn_vul_vulnerabilityInventory recordsNo
Containerscmdb_ci_docker_containerSoftware assetsNo
Software catalogcmdb_sam_sw_discovery_modelSoftware assetsNo
Clearing a group removes everything built from it

Correlations, risk scores and dashboards that draw on a group are incomplete without it. The eight selected by default are the ones most of Mesh depends on — clear one only when you have a reason.

Containers count as software, not machines

Mesh reads containers into your software inventory. Software catalog is also software: it is the models that connect installations to licenses and services, and two of the recommended relationships in Step 5 need it.

Adding a table Mesh does not read by default​

If your organization keeps asset data in a table that is not in the list, choose Add a custom ServiceNow table.

The Add a custom ServiceNow table form, with name, table path and information type

FieldWhat to enter
What should Mesh call this table?A short name in lowercase letters, numbers and underscores, starting with a letter — for example business_applications
ServiceNow table pathThe API path exactly as it appears in your instance, for example /api/now/table/u_business_application
What kind of information is it?What these records represent in Mesh

The information types are: machine, application, user, group, software component, crypto asset, entitlement, location, organization, certificate and ServiceNow software.

After you save the table, map its fields in Step 4. Three of them are required: a Record identity, a Display name, and a date and time field for Last updated.

Ask before adding a custom table

Which table to read, and which of its fields mean what, depends on how your CMDB is structured. Talk to Axiad before adding one — a table mapped to the wrong information type produces records that look right but correlate badly.

Step 4 — Understand fields​

This step shows how ServiceNow fields become Mesh fields. For the standard table groups the mapping is fixed — it is part of the connector, and the step is there so you can see it rather than change it.

Step 4, Understand fields, showing the locked mapping from ServiceNow fields to Mesh meanings

Each group expands to a table with the ServiceNow field on the left and what Mesh does with it on the right. Configuration items, for example, maps thirteen fields:

ServiceNow fieldMesh meaning
sys_idRecord identity
nameDisplay name
manufacturerSupplier
assigned_toOwner
install_statusLifecycle state
locationLocation
departmentOrganization
install_dateInstall date
serial_numberSerial number
osOperating system
os_versionOS version
fqdnFully qualified host name
sys_updated_onChange tracking

Use Visual map instead of Table view to see the same thing as a diagram.

A custom table you added in Step 3 is the one case where you do set the mapping, and you do it here, in plain language.

Where a field is empty in ServiceNow, Mesh shows nothing

Mesh reports what your CMDB holds. A machine with no manufacturer in ServiceNow arrives with no supplier in Mesh rather than a guess.

Some of the most useful detail is not on the record itself — a computer's manufacturer is a reference to another table, not a name. This step tells Mesh which of those references to follow.

Everything here is optional. A connector with no relationships is a valid connector.

Step 5, Connect related, listing the recommended relationships

RelationshipWhat it addsReads fromNeeds this group selected
Computer → manufacturerThe manufacturer name on each configuration itemManufacturer companyConfiguration items
Software catalog → installed productsLinks software models to the products installedSoftware productSoftware catalog
Software catalog → ownerThe company a software license is held byLicense owner companySoftware catalog
Certificate → hostMatches a certificate name to the host it runs onComputer hostCertificates
Group → membersThe people in each group, through the membership tableGroup memberGroups

Select Use this to add one.

A relationship can only read from a group you selected

The source has to be one of the table groups selected in Step 3, or the relationship is refused when you check it. Two of the recommended relationships read from Software catalog, which is not selected by default — go back to Step 3 and select it first if you want them.

Building your own​

Choose build one from the beginning to describe a relationship yourself. A relationship is one or more hops: at each hop you name a field on the record you have, the table it points into, and the field in that table that matches.

The relationship builder, with the first hop's source field, lookup table and matching field

SettingWhat it means
Use a field on the source recordThe field that points at the other record
Lookup tableThe table that field points into
Matching fieldThe field in that table the value matches, usually Record ID
The source field is a ServiceNow referenceSelect this when the field is a ServiceNow reference rather than plain text
+ Add another hopFollow a second step, when what you want is one table further out
This relationship uses a many-to-many membership tableSelect this when the link is a membership table rather than a direct reference. You then name the field that points from the membership table to the related record

Last, choose what to bring back: the field on the far record, and the Mesh meaning to put it under.

The relationship builder with the fields to bring back and the option to save it as custom

Select Check relationship setup to validate everything before you continue. Each saved relationship can be edited or removed from the list.

Start from a recommendation

Opening a recommended relationship and adjusting it is easier than starting with an empty builder — the hops are already filled in correctly. Saving changes keeps it as your own copy.

Step 6 — Tuning​

How often Mesh reads, how fast it calls the API, and how much one run collects. The defaults suit most instances.

Step 6, Tuning, with the six pace and limit settings

SettingDefaultChoicesWhat it changes
How often Mesh readsEvery hour15 minutes, 1 hour, 4 hours, 12 hours, 24 hoursHow quickly a CMDB change reaches Mesh, against load on your instance
Request rateStandard · 8 / secGentle 4 / sec, Standard 8 / sec, Fast 16 / secHow fast Mesh calls the API
If ServiceNow stops respondingStandard · 3 attempts2, 3 or 5 attemptsHow long Mesh keeps trying before the run fails
Rows per page (software installations)10,000 rows500, 2,000, 5,000, 10,000, 20,000How many rows one response carries
Records per run50,000 records25,000 to 200,000How much one run collects before stopping
Requests per run100,000 requests50,000, 100,000, 200,000A ceiling on API calls per run
Change the rate before the schedule

If your instance is shared with other integrations, Gentle is the setting that reduces pressure without making your data older. Reading less often has a bigger effect on how current Mesh is.

Run limits are a stopping point, not a cap on your estate

When a run reaches Records per run it stops and the next run carries on from where it left off. A large CMDB loads over several runs rather than failing.

Step 7 — Review and create​

Check the summary, then select Test connection.

Step 7, Review and create, with the summary and the Test connection button

Create connector stays unavailable until the test passes.

Step 7 after a successful test, with Create connector available

A pass means ServiceNow accepted the credential and table access was confirmed. If it fails, see Troubleshooting.

Select Create connector. The connector appears in the list and the first collection starts.

The first collection can take a while

Mesh reads your whole CMDB the first time. On a large estate this takes several runs. You can use Mesh meanwhile, though data is incomplete until it finishes.

Check that it worked​

  1. Open Settings › Connectors and find your connector.
  2. Watch Sync status go from Starting to Good.
  3. For run-by-run detail, open the row menu and choose Logs, or open Settings › Data source syncs. See Data source synchronizations.

Change a connector later​

Open the row menu on the connector and choose Edit. The same seven steps open again with your answers filled in.

Every answer can be changed, including the instance URL and the authentication method. Leave a secret field empty to keep the credential already stored, and the connection test has to pass again before you can save.

Changes to what is collected apply on the next run.

Two changes make you re-enter every credential

A stored secret is only ever reused with the instance and the method it was saved for, so changing the instance URL or changing the authentication method means entering the credentials again from scratch.

A different instance is usually a different connector

Every record Mesh has collected through this connector is attributed to the instance it came from. Pointing an existing connector at another instance re-attributes that history. Unless you are correcting a typo, add a second connector instead.