ServiceNow V1 Connector Configuration Reference
The ServiceNow Datasource retrieves data from the ServiceNow repository.
|
|
V1 deprecation and removal notice
Starting in Fusion 5.12.0, all V1 connectors are deprecated. This means they are no longer being actively developed and will be removed in Fusion 5.13.0.
The replacement for this connector is in active development at this time and will be released at a future date.
If you are using this connector, you must migrate to the replacement connector or a supported alternative before upgrading to Fusion 5.13.0. We recommend migrating to the replacement connector as soon as possible to avoid any disruption to your workflows.
|
For more information, see the:
ServiceNow records are stored in named tables.
The account used to crawl needs to have the personalize_dictionary role in addition to READ access to the following System Tables:
-
Crawl
-
sys_dictionary
-
sys_glide_object
-
sys_db_object
-
Recrawl
-
Sec trimming:
-
sys_security_acl_role
-
sys_group_has_role
-
sys_user_grmember
-
sys_user_has_role
|
|
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.
|
Connects to a ServiceNow web service. This requires that OAuth has been enabled for the ServiceNow instance.
description - string
Optional description for this datasource.
id - stringrequired
Unique name for this datasource.
>= 1 characters
Match pattern: ^[a-zA-Z0-9_-]+$
pipeline - stringrequired
Name of an existing index pipeline for processing documents.
>= 1 characters
properties - Properties
Datasource configuration properties
batch_size - integer
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.
>= 1
<= 10000
exclusiveMinimum: false
exclusiveMaximum: false
Default: 100
db - Connector DB
Type and properties for a ConnectorDB implementation to use with this datasource.
aliases - boolean
Keep track of original URI-s that resolved to the current URI. This negatively impacts performance and size of DB.
Default: false
inlinks - boolean
Keep track of incoming links. This negatively impacts performance and size of DB.
Default: false
inv_aliases - boolean
Keep track of target URI-s that the current URI resolves to. This negatively impacts performance and size of DB.
Default: false
type - string
Fully qualified class name of ConnectorDb implementation.
>= 1 characters
Default: com.lucidworks.connectors.db.impl.MapDbConnectorDb
diagnostic_mode - boolean
Enable to print more detailed information to the logs about each request.
Default: false
enable_security_trimming - boolean
Security trimming restricts query results to records the user is allowed to access by indexing user access information with other document metadata. Enable this option to index user access metadata.
Default: false
exclude_field_name_value - array[string]
Records can be excluded based on values of specific fields. Enter exclusions in the format fieldName=fieldValue, e.g., workflow_state=review.
initial_mapping - Initial field mapping
Provides mapping of fields before documents are sent to an index pipeline.
condition - string
Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.
label - string
A unique label for this stage.
<= 255 characters
mappings - array[object]
List of mapping rules
object attributes:{operation : {
display name: Operation
type: string
}source required : {
display name: Source Field
type: string
}target : {
display name: Target Field
type: string
}}
reservedFieldsMappingAllowed - boolean
Default: false
skip - boolean
Set to true to skip this stage.
Default: false
unmapped - Unmapped Fields
If fields do not match any of the field mapping rules, these rules will apply.
operation - string
The type of mapping to perform: move, copy, delete, add, set, or keep.
Default: copy
Allowed values: copymovedeletesetaddkeep
source - string
The name of the field to be mapped.
target - string
The name of the field to be mapped to.
oauth_application_client_id - string
OAuth application Client ID. This ID is created after registering the OAuth endpoint for the ServiceNow instance.
>= 1 characters
oauth_application_client_secret - string
OAuth application Client Secret. This key is created after registering the OAuth endpoint for the ServiceNow instance.
>= 1 characters
proxyHost - string
The address to use when connecting through the proxy.
proxyPort - integer
The port to use when connecting through the proxy. (HTTP or SOCKS)
servicenow_instance_url - string
The ServiceNow instance address.
>= 1 characters
servicenow_password - string
Password to access the ServiceNow instance.
>= 1 characters
servicenow_username - string
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.
>= 1 characters
tables_to_crawl - array[string]
ServiceNow tables to fetch content from. At least one table name should be entered