ServiceNow connector schema
Reference for every field in the ServiceNow native connector configuration JSON.
Overview
This page documents each property in the ServiceNow connector config. For guidance on how to use these settings, see ServiceNow native connector. Full endpoint details live in the API Reference.
Config
| Property |
Description |
Type |
Default |
Credentials |
The credentials used to access ServiceNow via the API. Once supplied, these values are encrypted and moved into the EncryptedCredentials property. |
Object (ServiceNowCredentials) |
|
EncryptedCredentials |
The encrypted credentials supplied via the Credentials property. |
Object (ServiceNowCredentials) |
|
EnabledServices |
The list of service types synchronised from ServiceNow. |
Object (EnabledService) |
|
UsersOptions |
Options to define which users are or are not synchronised. |
Object (ListingOptions) |
|
KnowledgeBasesOptions |
Configuration options for which knowledge bases to synchronise. |
Object (ListingOptions) |
|
FacetTypeNameMappings |
A collection of ServiceNow entity facet type name mappings. If none are supplied, the defaults are used. |
Object (FacetTypeNameMapping) |
|
TaxonomyTypeNameMappings |
A collection of standard taxonomy field mappings for default metadata associated with synchronised entities. If none are supplied, the defaults are used. |
Object (TaxonomyTypeNameMapping) |
|
InstanceUrl |
ServiceNow URL. |
String |
|
UserLookupDomainReplacement |
Replaces the domain in the user email address with another domain, which is then used to look up the user within the intranet. |
Object (UserLookupDomainReplacement) |
|
Links |
Configures how links appear in search results breadcrumbs. |
Object (ServiceNowLinks) |
|
Icons |
Overrides which icons are used during indexing for different ServiceNow entity types. |
Object (IconSources) |
|
IsEnabled |
Set to true for this connector synchronisation to be performed. |
Boolean |
True |
LogEventLevel |
The logging level for log messages. Values: Verbose, Debug, Information, Warning, Error. |
Enum |
Information |
PerformUserAccessControlDigestion |
Set to true for this connector to perform user external identities synchronisation. |
Boolean |
True |
PerformDocsDigestion |
Set to true for this connector to perform docs synchronisation. |
Boolean |
True |
ServiceNowCredentials
| Property |
Type |
Username |
String |
Password |
String |
EnabledService
| Property |
Description |
Type |
ServiceType |
The service type that is enabled. Values: RequestItem, Incident, KnowledgeBase, KnowledgeBaseArticle, ChangeRequest. |
Enum |
RoleNames |
Users in any of these roles have access to the synchronised content from the service. |
Array (String) |
ListingOptions
| Property |
Description |
Type |
Default |
ListingMode |
Synchronise all (with a disallowed list) or specific allowed items. Values: All, Specific. |
Enum |
All |
AllListingOptions |
Used if ListingMode is All. |
Object (AllListingOptions) |
|
SpecificListingOptions |
Used if ListingMode is Specific. |
Object (SpecificListingOptions) |
|
FacetTypeNameMapping
| Property |
Description |
Type |
Default |
Type |
The ServiceNow entity type these settings apply to. Values: KnowledgeBase, KnowledgeBaseArticle, RequestedItem, Incident, ChangeRequest, KnowledgeBaseArticleAttachment, RequestedItemAttachment, IncidentAttachment, ChangeRequestAttachment. |
Enum |
KnowledgeBaseArticle |
Name |
The custom name to use for this ServiceNow entity type. |
String |
|
TaxonomyTypeNameMapping
| Property |
Description |
Type |
Default |
Type |
The taxonomy type these settings apply to. Values: FileExtension, KnowledgeBase, Category. |
Enum |
FileExtension |
Name |
The custom name for this taxonomy type, that is, how it appears in your intranet. |
String |
|
UserLookupDomainReplacement
| Property |
Description |
Type |
OriginalDomain |
The domain to match in the user email address. |
String |
ReplacementDomain |
What the original domain is replaced with in the user email address. |
String |
ServiceNowLinks
| Property |
Description |
Type |
Instance |
The name/URL of your ServiceNow site as it should appear in search results breadcrumbs. |
Object (ServiceNowLink) |
Requests |
The name/URL of your ServiceNow Requests site as it should appear in search results breadcrumbs. |
Object (ServiceNowLink) |
Incidents |
The name/URL of your ServiceNow Incidents site as it should appear in search results breadcrumbs. |
Object (ServiceNowLink) |
KnowledgeBase |
The name/URL of your ServiceNow Knowledge Base site as it should appear in search results breadcrumbs. |
Object (ServiceNowLink) |
ChangeRequests |
The name/URL of your ServiceNow Change Requests site as it should appear in search results breadcrumbs. |
Object (ServiceNowLink) |
IconSources
| Property |
Description |
Type |
KnowledgeBase |
Overrides the default icon used for KnowledgeBase during indexing. |
Object (IconSource) |
KnowledgeBaseArticle |
Overrides the default icon used for KnowledgeBaseArticle during indexing. |
Object (IconSource) |
RequestedItem |
Overrides the default icon used for RequestedItem during indexing. |
Object (IconSource) |
Incident |
Overrides the default icon used for Incident during indexing. |
Object (IconSource) |
ChangeRequest |
Overrides the default icon used for ChangeRequest during indexing. |
Object (IconSource) |
KnowledgeBaseArticleAttachment |
Overrides the default icon used for KnowledgeBaseArticleAttachment during indexing. |
Object (IconSource) |
RequestedItemAttachment |
Overrides the default icon used for RequestedItemAttachment during indexing. |
Object (IconSource) |
IncidentAttachment |
Overrides the default icon used for IncidentAttachment during indexing. |
Object (IconSource) |
ChangeRequestAttachment |
Overrides the default icon used for ChangeRequestAttachment during indexing. |
Object (IconSource) |
AllListingOptions
| Property |
Description |
Type |
Disallowed |
A list of sites (relative paths) not to synchronise. |
Array (String) |
SpecificListingOptions
| Property |
Description |
Type |
Allowed |
A list of sites (relative paths) to synchronise. |
Array (String) |
ServiceNowLink
| Property |
Description |
Type |
Name |
The name as it should appear in search results breadcrumbs. |
String |
Url |
The URL. |
String |
IconSource
| Property |
Description |
Type |
Url |
If provided, this URL is used for the icon. If both Url and AssetId are provided, Url is used. |
String |
AssetId |
If provided, this asset ID is used for the icon. If both Url and AssetId are provided, Url is used. |
String |