How To | Configure the Q-SYS Reflect App for ServiceNow

Learn to effectively configure the Q-SYS Reflect App for seamless integration with ServiceNow.

Updated at January 20th, 2026

Procedure


Use the following steps for configuration of the Q-SYS Reflect App for ServiceNow:

Overview

This provides step-by-step instructions for configuring the Q-SYS Reflect App scoped application for ServiceNow. The application enables integration with the Q-SYS Reflect APIs using secure communications to populate tables for cores, systems, events, and audit logs.

Requirements

  • ServiceNow Version: 
    • Yokohama Patch 7 Hot Fix 2 or later
  • Required Roles:
    • ServiceNow Admin Role
    • x_qsc_q_sys_reflec.admin Role
  • Network Access: 
    • Ensure outbound HTTPS access to Q-SYS Reflect API endpoints.
  • Setup:
    • Completed Installation of the Q-SYS Reflect App for ServiceNow in your ServiceNow Tenant.   
    • A valid Q-SYS Reflect API Token
      • Q-SYS recommends using  a delegate account for creating the API token for this integration in order to not rely upon a user account when personal access is updated or removed. For more details please see the help file here for instructions on retrieving a Q-SYS Reflect API Token.
    • At lease (1) Q-SYS core registered to your Q-SYS Reflect instance.

Configuration

These step can be performed by users with the admin or x_qsc_q_sys_reflec.reflect_admin roles. 

  1. In the Application Navigator, search for Q-SYS Reflect App (and if you prefer, add it to Favorites).
  2. Click the Configure Application menu item.

  1. You will be presented with a property list for the application. Apart from two properties, it is suggested to leave all properties at their default values until you become more familiar with the application.  

The following two properties must be set for the application to function as expected.

x_qsc_q_sys_reflec.api_token

  • Populate with your Q-SYS Reflect API token.
 
 

x_qsc_q_sys_reflec.base_reflect_url

  • Populate with the base portion of the URL to be used to access Reflect.  i.e., reflect.qsc.com.
 
 

The following remaining properties are optional and their functionality and description are listed below.

Optional Properties

x_qsc_q_sys_reflec.job_automation_enabled

  • Controls whether automated pattern launching is allowed. If set to true, automation is enabled. If set to false, automation is disabled.
  • The app includes a Scheduled Script Execution named QSYSReflect_JobAutomation that automates the loading of data from Q-SYS Reflect.  This scheduled script is not activated by default when the app is first installed.  If you would like to take advantage of this feature, please have your ServiceNow administrator activate this Scheduled Script.  
  • After the Scheduled Script is activated, Users with the reflect_admin or admin role can set the x_qsc_q_sys_reflec.job_automation_enabled  to either false or true depending on if they want the scripts to take advantage of this feature or not.  
  • If set to true, all UI actions terminate gracefully with an informational message to the user.
  • Manual refresh is disabled while automation is enabled. No job was queued. If you want to refresh manually, turn off scheduled automation first. 
  • The Scheduled Script is scheduled to run once Daily by default and includes a condition such that if the x_qsc_q_sys_reflec.job_automation_enabled is set to false, the Scheduled Job will not run. This design gives users with the reflect_admin role the ability to toggle job automation on demand—without submitting a support ticket—while ensuring ServiceNow administrators retain control over system resource usage. 

 

 
 

x_qsc_q_sys_reflec.poll_initial_delay

  • Initial delay (in seconds) before polling begins.
 
 

x_qsc_q_sys_reflec.poll_max_attempts

  • Maximum number of polling attempts before timeout.
 
 

x_qsc_q_sys_reflec.poll_interval_sec

  • Interval (in seconds) between polling attempts.
 
 

x_qsc_q_sys_reflec.poll_429_backoff_factor

  • Multiplier for exponential backoff when rate-limited (HTTP 429).
 
 

x_qsc_q_sys_reflec.poll_429_max_interval_sec

  • Maximum delay (in seconds) allowed during backoff for 429.
 
 

x_qsc_q_sys_reflec.poll_429_jitter_ms

  • Random jitter (in milliseconds) added to backoff delay to avoid thundering herd.
 
 

x_qsc_q_sys_reflec.poll_429_max_attempts

  • Extended retry limit when encountering HTTP 429 rate limits.
 
 

x_qsc_q_sys_reflec.coreevents_max_attempts

  • Maximum polling attempts for CoreEvents before timeout.
 
 

x_qsc_q_sys_reflec.coreevents_max_pages

  • Maximum number of pages to fetch per core in CoreEvents.
 
 

x_qsc_q_sys_reflec.coreevents_page_size

  • Number of events per page in CoreEvents pagination.
 
 

x_qsc_q_sys_reflec.systemevents_max_attempts

  • Maximum polling attempts for SystemEvents before timeout.
 
 

x_qsc_q_sys_reflec.systemevents_max_pages

  • Maximum number of pages to fetch per system in SystemEvents.
 
 

x_qsc_q_sys_reflec.systemevents_page_size

  • Number of events per page in SystemEvents pagination.
 
 

x_qsc_q_sys_reflec.auditevents_max_attempts

  • Maximum polling attempts for AuditEvents before timeout.
 
 

x_qsc_q_sys_reflec.auditevents_max_pages

  • Max pages to receive.