ServiceNow Data Stream Parameters

The ServiceNow plugin provides configurable data streams to query data from the ServiceNow API.

Each configurable data stream exposes a set of parameters that lets you filter the data you retrieve. The following information describes the available configurable data streams and their parameters in detail.

Catalog Tasks

Returns catalog tasks falling within the dashboard timeframe. Narrow by state, priority and approval, or by who the task is assigned to or requested for.

Parameter
Description
Active
Filter records by whether they are active or inactive. Select to include only currently active records or deselect to include only inactive ones.
State
Select a record State to filter by.
Priority
Select Priority to filter by.
Assigned to
Enter usernames to filter by (e.g. firstname.secondname). Separate values with a comma.
Requested for
Enter usernames to filter by (e.g. firstname.secondname). Separate values with a comma.
Approval
Select an approval state to filter by.

Catalog Tasks (Anytime)

Returns catalog tasks regardless of the dashboard timeframe, with the same filters. Use it for a queue of outstanding work rather than a view of one period.

Parameter
Description
Active
Filter records by whether they are active or inactive. Select to include only currently active records or deselect to include only inactive ones.
State
Select a record State to filter by.
Priority
Select Priority to filter by.
Assigned to
Enter usernames to filter by (e.g. firstname.secondname). Separate values with a comma.
Requested for
Enter usernames to filter by (e.g. firstname.secondname). Separate values with a comma.
Approval
Select an approval state to filter by.

Custom Table

Returns records from any ServiceNow table you name, with control over how many records and which columns come back.

Parameter
Description
Custom Table
Specify the ServiceNow table from which data will be queried. This defines the source of the records for this data stream.
Number of records
Specify the total number of records to retrieve from the selected table. This controls the volume of data returned.
Columns
Specify the columns to return in the data stream output. Useful to limit the amount of data returned and speed up queries.

Table Query

Returns records from a named table using a ServiceNow filter query, which you can copy straight out of a ServiceNow list view.

Parameter
Description
Table name
Specify the table name to run the query on.
Filter query
Optionally, enter a filter query to run. You can copy queries from the ServiceNow console by right-clicking thee query above the toolbar and selecting Copy query
Be aware that not all queries obtained this way will work properly in SquareUp (for example, if the query contains javascript:gs.getUserID()).
Result type
Select how the query results are returned. Choose from:
  • Full results:
    Returns the full rows requested from the table. This is the default behavior and enables the following parameters:
    • Column(s):
      Select the column(s) to return.
    • Top:
      Select to specify the the top n results to return.
  • Aggregate results:
    Aggregate the results via the ServiceNow Aggregate API by configuring following parameters:
    • Group by:
      Optionally, Specify a column to group results by, for example Severity. Aggregations are then performed on a group basis.
    • Show count:
      Select to return a count of the results. If the Group by field is populated then a count is returned for each specified group.
    • Sum:
      Returns the total sum of values for each column you specify.
    • Average:
      Return the mean value for each column you specify.
    • Min:
      Returns the smallest value for each column you specify.
    • Max:
      Returns the largest value for each column you specify.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket