Versions Compared

Old Version 36

changes.mady.by.user Gouri Bhagchandani

Saved on

compared with

New Version Current

changes.mady.by.user Gouri Bhagchandani

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Read


Description:

This Snap connects to the particular instance provided by ServiceNow, executes the query and fetches the records or keys depending on the chosen action, and returns the result as a document stream.

  • Expected upstream Snaps: Any Snap that provides a document output view such as a Mapper Snap.
  • Expected downstream Snaps: None or any Snap that has a document input view such as a Filter or a Data or a JSON Formatter.
  • Expected input:  A Table Name and a search query.
  • Expected output:  Return records as query results.
Prerequisites:

None


Support and limitations:

  • Works in Ultra Task Pipelines.

    Note

    In Ultra Pipelines, set the Page size as 1 for the Snap to process one document/record at a time.


Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring ServiceNow Accounts for information on setting up this type of account.


Views:


Input

This Snap has at most one document input view.

Output

This Snap has exactly one document output view. If no results are found, an empty document is written to the output.

Error

This Snap has at most one error view and produces zero or more documents in the view.


Settings

Label



Required.The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Table Namename

Insert excerpt
ServiceNow Delete
ServiceNow Delete
nopaneltrue

API type


Required. A property that determines which API to be used. Options available include:

  • default: For default behavior
  • table: For querying using service now table API
Note
Default API does not support OrderBy in the Query Field due to ServiceNow Limitation. 

Default value: default

Query


An encoded query string to filter the records. For more information, see Encoded Query Strings. 

Example: active=true
Default value: [None] 

Note

  • Use the Dollar sign ($) when querying custom fields created in ServiceNow. Example: $incident_state=New.

  • Do not use the Dollar sign ($) when querying fields that are auto-generated by ServiceNow. Example: active = true.


Fields


This property specifies the fields to be retrieved from the table.
Note: This property works only when API type is selected as 'table'.

Display value


A property that determines whether to display values for the reference fields. 

  • true=display reference field
  • false=do not display
  • all=display both—reference field and its value

Default value: true

Page size

Required. Number of documents for processing in a single batch.

Minimum Value: 1

Maximum Value: 500

Default Value: 500

Note

Set the value as 1 when using the Snap in an Ultra Pipeline.


Display variables


A property that determines whether to display composite fields in a hierarchical order.

  • true=display
  • false=do not display

Default value: Selected

Pass through

 

If selected, the input document will be passed through to the output view under the key 'original'.


Default value: Selected


Allow empty query result

A property that determines whether the query for an empty result is allowed or not. If selected, the Snap writes an empty document when it fetches no records. Otherwise, an exception is thrown.


Default value: Not selected

Number Of Retriesof retries

Specifies the maximum number of retry attempts when the Snap fails to read.

Example: 3

Minimum value: 0

Default value: 0

Retry Interval interval (seconds)

Specifies the minimum number of seconds the Snap must wait before each retry attempt.

Example: 3

Minimum value: 1

Default value: 1

Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

For more information on how to define the Action and Query, see Action Parameters. 

Example

The example assumes that you have configured & authorized a valid ServiceNow account (see Configuring ServiceNow Accounts) to be used with this Snap.  

The following ServiceNow Query Snap shows how you can query and retrieve records from a ServiceNow table. The following Snap queries the incident table. The Snap specifies that the query results include only some of the columns (Such as active, upon_approval, location, impact, urgency) in the incident table.

Note

When the API type is set to default, the Query field specifies the filter condition. When the API type is set to table, the Fields field specifies the filter condition. In the below example, if the API type is specified as default, then the specified Query searches the active column and returns all the records that have the column field value as true (active=true). 


 

After successful validation of the Snap, you will see a data preview that shows the query results: 

You can also learn how to use ServiceNow Query Snap from the example pipeline (Pipeline: Data from Salesforce.com and ServiceNow).

Insert excerpt
ServiceNow Snap Pack
ServiceNow Snap Pack
nopaneltrue