Procedure

Use the following steps to install the Q-SYS Reflect App for ServiceNow:

Overview

This provides step-by-step instructions for installing 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 - to install application and assign the x_qsc_q_sys_reflec.admin or x_qsc_q_sys_reflec.user roles to users after the application has been installed:
    • x_qsc_q_sys_reflec.admin – for users that require permissions to initiate UI Actions (jobs), cancel/delete jobs, and configure properties pertaining to the application.
    • x_qsc_q_sys_reflec.user - for users who require only read access to all forms/lists.  Users with this role cannot initiate UI Actions or cancel/delete jobs or configure properties pertaining to the application.
• Network Access: 
  • Ensure outbound HTTPS access to Q-SYS Reflect API endpoints.
• System Property Setup:
  • Two properties require configuration for the application to function correctly.  It is suggested that all other properties be left at their defaults until you gain familiarity with the application.  Instructions are provided on the How To | Configure Q-SYS Reflect App for ServiceNow article for how to populate them:
    • Populate x_qsc_q_sys_reflec.api_token with your Q-SYS Reflect API token.
    • Populate x_qsc_q_sys_reflec.base_reflect_url with the base portion of the URL to be used to access Reflect.  i.e., reflect.qsc.com.

      Note

      Q-SYS recommends using a delegate account for creating the API token for this integration in order. This prevents the need to rely on a user account when personal access is updated or removed. Please see the Q-SYS help file here for instructions on retrieving a Q-SYS Reflect API Token.

       

Installation Tenant

ServiceNow and Q-SYS recommend for first time installations that the Q-SYS Reflect App to be provisioned on a development installation of ServiceNow.  Once your ServiceNow admin has completed setup and verification of the workflows and configuration of the App within your development environment, it can be moved to the Test and then Production ServiceNow environments.

Setup

1. Log in to ServiceNow with admin role.
2. Navigate to System Applications > All Available Applications > All.
3. Search for 'Q-SYS Reflect App for ServiceNow' and click its title.
4. Click the Install button.
5. After the installation is complete add users to the x_qsc_q_sys_reflec.admin or x_qsc_q_sys_reflec.user roles as needed for your organization.
6. Verify installation under My Company Applications.

For uninstallation of the Q-SYS Reflect App for ServiceNow please review the How To | Uninstall Q-SYS Reflect App for ServiceNow article.