GuidesAPI Reference
Guides

Schema

Config

Credentials

The credentials used to access ServiceNow Online via the API. Once supplied, these values will be encrypted and moved into the EncryptedCredentials property.

EncryptedCredentials

The encrypted credentials that were supplied via the Credentials property

EnabledServices

The list of service types that will be synchronised from Service Now

UsersOptions

Options to define which users will (or will not) be synchronised

KnowledgeBasesOptions

Configuration options for which knowledge bases to synchronise

FacetTypeNameMappings

A collection of ServiceNow entity facet type name mappings. If none are supplied then the defaults will be used.

TaxonomyTypeNameMappings

A collection of standard taxonomy field mappings for default meta data associated with synchronised entities. If none are supplied then the defaults will be used.

InstanceUrl

Service Now URL

  • Type: String

UserLookupDomainReplacement

Can be used to replace the domain in the user email address with another domain, which is then used to perform a lookup of the user within the intranet

Links

Configure how links should appear in search results breadcrumbs

Icons

Can be used to override which icons should be used during indexing for different ServiceNode drive entity types

IsEnabled

Set to true for this connector synchronisation to be performed

  • Type: Boolean
  • Default: True

LogEventLevel

The logging level for log messages to be recorded

  • Type: Enum
  • Values: Verbose, Debug, Information, Warning, Error, Fatal
  • Default: Information

PerformUserAccessControlDigestion

Set to true for this connector to perform user external identities synchronisation for this connector

  • Type: Boolean
  • Default: True

PerformDocsDigestion

Set to true for this connector to perform docs synchronisation for this connector

  • Type: Boolean
  • Default: True

ServiceNowCredentials

Username

  • Type: String

Password

  • Type: String

EnabledService

ServiceType

The service type that is enabled

  • Type: Enum
  • Values: RequestItem, Incident, KnowledgeBase, KnowledgeBaseArticle, ChangeRequest

RoleNames

Users that are in any of these roles will have access to the synchronised content from the service

  • Type: Array (String)

ListingOptions

ListingMode

You can choose to synchronise all (and specifying a disallowed list) or specific allowed

  • Type: Enum
  • Values: All, Specific
  • Default: All

AllListingOptions

If the SitesListingMode is AllSites then these settings are used

SpecificListingOptions

If the SitesListingMode is SpecificSites then these settings are used

FacetTypeNameMapping

Type

The ServiceNow entity type that these settings apply to

  • Type: Enum
  • Values: KnowledgeBase, KnowledgeBaseArticle, RequestedItem, Incident, ChangeRequest, KnowledgeBaseArticleAttachment, RequestedItemAttachment, IncidentAttachment, ChangeRequestAttachment
  • Default: KnowledgeBaseArticle

Name

The custom name that you want to use for this ServiceNow entity type

  • Type: String

TaxonomyTypeNameMapping

Type

The taxonomy type that these settings apply to

  • Type: Enum
  • Values: FileExtension, KnowledgeBase, Category
  • Default: FileExtension

Name

The custom name for this taxonomy type. I.e. how you want this to appear in your intranet.

  • Type: String

UserLookupDomainReplacement

OriginalDomain

The domain to match in the user email address

  • Type: String

ReplacementDomain

What the original domain should be replaced with in the user email address

  • Type: String

ServiceNowLinks

Instance

The name/url of your ServiceNow site as it should appear in search results breadcrumbs.

Requests

The name/url of your ServiceNow Requests site as it should appear in search results breadcrumbs.

Incidents

The name/url of your ServiceNow Incidents site as it should appear in search results breadcrumbs.

KnowledgeBase

The name/url of your ServiceNow Knowledge Base site as it should appear in search results breadcrumbs.

ChangeRequests

The name/url of your ServiceNow Change Requests site as it should appear in search results breadcrumbs.

IconSources

KnowledgeBase

If provided will override the default icon used for KnowledgeBase during indexing

KnowledgeBaseArticle

If provided will override the default icon used for KnowledgeBaseArticle during indexing

RequestedItem

If provided will override the default icon used for RequestedItem during indexing

Incident

If provided will override the default icon used for Incident during indexing

ChangeRequest

If provided will override the default icon used for ChangeRequest during indexing

KnowledgeBaseArticleAttachment

If provided will override the default icon used for KnowledgeBaseArticleAttachment during indexing

RequestedItemAttachment

If provided will override the default icon used for RequestedItemAttachment during indexing

IncidentAttachment

If provided will override the default icon used for IncidentAttachment during indexing

ChangeRequestAttachment

If provided will override the default icon used for ChangeRequestAttachment during indexing

AllListingOptions

Disallowed

A list of sites (relative paths) that you do not want to synchronise

  • Type: Array (String)

SpecificListingOptions

Allowed

A list of sites (relative paths) that you want to synchronise

  • Type: Array (String)

ServiceNowLink

Name

The name as it should appear in search results breadcrumbs

  • Type: String

Url

The url

  • Type: String

IconSource

Url

If provided, then this url will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.

  • Type: String

AssetId

If provided, then this asset id will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.

  • Type: String

Updated 5 months ago