ServiceNow Connector Configuration Reference

Configuration

The ServiceNow Datasource retrieves data from ServiceNow repository via the ServiceNow REST API. ServiceNow records are stored in named tables.

Configuration

The account used to crawl should have READ access to the following System Tables:

Crawl
- sys_dictionary
- sys_glide_object
Recrawl
- sys_audit_delete
Sec trimming:
- sys_security_acl_role
- sys_group_has_role
- sys_user_grmember
- sys_user_has_role

Tip	When entering configuration values in the UI, use unescaped characters, such as `\t` for the tab character. When entering configuration values in the API, use escaped characters, such as `\\t` for the tab character.

Property Description

batch_size

Batch size

Number of records to fetch in batch requests. The default is 100 to avoid the ServiceNow REST request timeout of 60 seconds. Only increase the batch size if you are sure a higher batch size will not trigger the timeout.

type: integer

default value: '100'

exclusiveMaximum: false

exclusiveMinimum: false

maximum: 10000

minimum: 1

collection

Collection

Collection documents will be indexed to.

type: string

pattern: ^[a-zA-Z0-9_-]+$

diagnostic_mode

Diagnostic Mode

Enable to print more detailed information to the logs about each request.

type: boolean

default value: 'false'

exclude_field_name_value

Exclude records by field values

Records can be excluded based on values of specific fields. Enter exclusions in the format fieldName=fieldValue, e.g., workflow_state=review.

type: array of string

oauth_application_client_id

OAuth application Client Id

required

OAuth application Client ID. This ID is created after registering the OAuth endpoint for the ServiceNow instance.

type: string

minLength: 1

oauth_application_client_secret

OAuth application Client Secret

required

OAuth application Client Secret. This key is created after registering the OAuth endpoint for the ServiceNow instance.

type: string

minLength: 1

proxyHost

Proxy host

The address to use when connecting through the proxy.

type: string

proxyPort

Proxy port

The port to use when connecting through the proxy. (HTTP or SOCKS)

type: integer

proxyType

Proxy type

Type of proxy to use, if any. Allowed values are 'HTTP' and 'SOCKS'. Leave empty for no proxy.

type: string

default value: 'HTTP'

servicenow_instance_url

ServiceNow Instance URL

required

The ServiceNow instance address.

type: string

minLength: 1

servicenow_password

ServiceNow password

required

Password to access the ServiceNow instance.

type: string

minLength: 1

servicenow_username

ServiceNow username

required

A user with access to all of the tables configured below. This user should also have access to related tables, as appropriate, in order to retrieve content referenced in other tables.

type: string

minLength: 1

tables_to_crawl

ServiceNow tables to crawl

ServiceNow tables to fetch content from. At least one table name should be entered

type: array of string

minimum number of items (minItems): 1

Enable Security Trimming

Property

Description

Field Mapping

Initial Mappings Description

mappings

Field Mappings

List of mapping rules

type: array of object

object attributes: {
  operation : {
    display name: Operation
    type: string
    default value: 'copy'
    description : The type of mapping to perform: move, copy, delete, add, set, or keep.
    enum: { copy move delete set add keep     }

    }
  source (required) : {
    display name: Source Field
    type: string
    description : The name of the field to be mapped.
    }
  target : {
    display name: Target Field
    type: string
    description : The name of the field to be mapped to.
    }
  }

reservedFieldsMappingAllowed

Allow System Fields Mapping?

type: boolean

default value: 'false'

unmapped

Unmapped Fields

If fields do not match any of the field mapping rules, these rules will apply.

type: object

    }
  source : {
    display name: Source Field
    type: string
    description : The name of the field to be mapped.
    }
  target : {
    display name: Target Field
    type: string
    description : The name of the field to be mapped to.
    }
  }

ConnectorDb Configuration

Property Description

aliases

Process Aliases?

Keep track of original URI-s that resolved to the current URI. This negatively impacts performance and size of DB.

type: boolean

default value: 'false'

inlinks

Process Inlinks?

Keep track of incoming links. This negatively impacts performance and size of DB.

type: boolean

default value: 'false'

inv_aliases

Process Inverted Aliases?

Keep track of target URI-s that the current URI resolves to. This negatively impacts performance and size of DB.

type: boolean

default value: 'false'

type

Implementation Class Name

Fully qualified class name of ConnectorDb implementation.

type: string

default value: 'com.lucidworks.connectors.db.impl.MapDbConnectorDb'

minLength: 1

General Configuration

Property

Description

description

Description

Optional description for datasource instance.

Datasource ID

Unique name for datasource instance.

pipeline

Pipeline ID

The index pipeline used to process documents.