Product Selector

Fusion 5.12
    Fusion 5.12

    ServiceNow V1Connector Configuration Reference

    Table of Contents

    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.

    Configuration

    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

      • sys_audit_delete

    • 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.

    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

    description - string

    Optional description for this datasource.

    properties - Properties

    Datasource configuration properties

    db - Connector DB

    Type and properties for a ConnectorDB implementation to use with this datasource.

    type - string

    Fully qualified class name of ConnectorDb implementation.

    >= 1 characters

    Default: com.lucidworks.connectors.db.impl.MapDbConnectorDb

    inlinks - boolean

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

    Default: false

    aliases - boolean

    Keep track of original URI-s that resolved to the current URI. 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

    servicenow_instance_url - string

    The ServiceNow instance address.

    >= 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

    servicenow_password - string

    Password to access the ServiceNow instance.

    >= 1 characters

    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

    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

    tables_to_crawl - array[string]

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

    fields_to_crawl - array[string]

    A list of fields to be fetched for each table. Leave empty to retrieve all fields.

    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.

    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

    diagnostic_mode - boolean

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

    Default: false

    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)

    initial_mapping - Initial field mapping

    Provides mapping of fields before documents are sent to an index pipeline.

    skip - boolean

    Set to true to skip this stage.

    Default: false

    label - string

    A unique label for this stage.

    <= 255 characters

    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.

    reservedFieldsMappingAllowed - boolean

    Default: false

    retentionMappings - array[object]

    Fields that should be kept or deleted

    object attributes:{field required : {
     display name: Field
     type: string
    }    operation : {
     display name: Operation
     type: string
    }    }

    updateMappings - array[object]

    Values that should be added to or set on a field. When a value is added, any values previously on the field will be retained. When a value is set, any values previously on the field will be overwritten.

    object attributes:{field required : {
     display name: Field
     type: string
    }    value required : {
     display name: Value
     type: string
    }    operation : {
     display name: Operation
     type: string
    }    }

    translationMappings - array[object]

    Fields that should be moved or copied to another field. When a field is moved, the values from the source field are moved over to the target field and the source field is removed. When a field is copied, the values from the source field are copied over to the target field and the source field is retained.

    object attributes:{source required : {
     display name: Source Field
     type: string
    }    target required : {
     display name: Target Field
     type: string
    }    operation : {
     display name: Operation
     type: string
    }    }

    unmappedRule - Unmapped Fields

    Fields not mapped by the above rules. By default, any remaining fields will be kept on the document.

    keep - boolean

    Keep all unmapped fields

    Default: true

    delete - boolean

    Delete all unmapped fields

    Default: false

    fieldToMoveValuesTo - string

    Move all unmapped field values to this field

    fieldToCopyValuesTo - string

    Copy all unmapped field values to this field

    valueToAddToUnmappedFields - string

    Add this value to all unmapped fields

    valueToSetOnUnmappedFields - string

    Set this value on all unmapped fields