Upload
others
View
3
Download
0
Embed Size (px)
Citation preview
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
Trial Download QuickStart Guide v11
Everything you need to know to get started with QuerySurge™ and Your Data
Built by
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
2
QuickStart Guide version 11
Note: The purpose of this QuickStart Guide is to provide you with the ability to get up and running with your data and
databases / files. If you do not have access to your data, then your best bet is to go through the QuerySurge™ Tutorial.
The Tutorial comes complete with sample data and sample SQL queries, along with data models and schemas.
About QuerySurge™
QuerySurge™ is the only testing tool built specifically to automate the testing of data warehouses and the ETL testing
process. QuerySurge™ ensures that the data extracted from sources remains intact in the target by analyzing and
pinpointing any differences. QuerySurge™ is also very effective when testing Data Migrations, Database Upgrades,
System Upgrades and Interface Testing.
QuerySurge™ helps you:
• Test across different platforms, whether they are flat files, XML, Oracle, Teradata, Microsoft, IBM, or other databases / data warehouses.
• Automate the testing effort from the execution of tests, to the comparison of all data, to emailing the results to your team.
• Speed up testing by executing tests and comparing millions of result sets as much as 100 times faster than manually.
• Schedule tests to run anytime, whether it be right now, or every Tuesday at 8pm or when the ETL process is complete.
• View and share test results through our deep-dive reporting ability and our automated emailing of reports and notifications.
The QuerySurge™ workflow parallels the major tasks involved in testing your data warehouse architecture – it can be
used by ETL Developers, ETL Testers, Business Analysts who build and deliver your data warehouse, and the Operations
teams who monitor it in production.
Caution: Make sure that after you have installed QuerySurge™, you utilize the ‘Setup Wizard’ (below) on the top toolbar
of QuerySurge™ to connect to your source files and / or databases and target data warehouse before beginning this
QuickStart Guide. If you have not performed the necessary connections for both source and target, QuerySurge™ will
not be able to access your data.
http://www.querysurge.com/http://www.querysurge.com/product-tour/defects-we-findhttp://www.querysurge.com/product-tour/defects-we-findhttp://www.querysurge.com/business-challenges/testing-across-different-platformshttp://www.querysurge.com/business-challenges/automate-the-testing-efforthttp://www.querysurge.com/business-challenges/speed-up-testinghttp://www.querysurge.com/business-challenges/test-schedulinghttp://www.querysurge.com/business-challenges/view-and-share-test-results
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
3
Table of Contents About QuerySurge™ ………………………………………………………………………………………………………………………………………………………...2
About QuerySurge™ .............................................................................................................................................................. 2
Welcome to QuerySurge™ .................................................................................................................................................... 5
Resources ........................................................................................................................................................................ 5
Documentation ............................................................................................................................................................... 5
Understanding QuerySurge™ ................................................................................................................................................ 6
1) Design Library ......................................................................................................................................................... 6
2) Scheduling .............................................................................................................................................................. 6
3) Run Dashboard ....................................................................................................................................................... 7
4) Reporting ................................................................................................................................................................ 7
5) Administration ........................................................................................................................................................ 7
The QuerySurge™ Testing Process ....................................................................................................................................... 8
About the QuerySurge™ Architecture ................................................................................................................................ 10
QuerySurge™ Terminology ................................................................................................................................................. 12
QuickStart Guide ................................................................................................................................................................... 13
Login to QuerySurge™ ................................................................................................................................................. 13
Review of QuerySurge™ Agent and Agent Status ...................................................................................................... 18
Design-Time Run execution of an existing QueryPair test .......................................................................................... 21
Creating a Scheduled Execution Scenario .................................................................................................................... 35
Running Reports ........................................................................................................................................................... 40
Query Wizard ................................................................................................................................................................ 42
Review of Data Health Dashboard ............................................................................................................................... 48
Automated Email Notifications ................................................................................................................................... 51
Command Line Integration .......................................................................................................................................... 54
Troubleshooting Common Issues ................................................................................................................................ 58
Things to do next .......................................................................................................................................................... 64
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
4
About RTTS (developers of QuerySurge™) ......................................................................................................................... 65
About QuerySurgeTM ............................................................................................................................................................ 65
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
5
Welcome to QuerySurge™
Welcome to QuerySurge™, RTTS’ enterprise testing tool that automates the testing of Big Data, Data Warehouses and
the ETL testing process. QuerySurge™ is also very effective when testing Data Migrations, Database Upgrades, System
Upgrades and Interface Testing. QuerySurge™ ensures that the data extracted from sources remains intact in the target
by analyzing and pinpointing any differences.
This QuickStart Guide is not meant to be an all-inclusive guide, but is targeted at providing you with an overview of
QuerySurge™ and some of the key functionality provided. Additional information regarding other features in
QuerySurge™ can be found in our Knowledge Base by clicking the Help > Help Center buttons.
Resources
QuerySurge™ Help is built into the product and provides immediate answers to questions that arise as you work
with QuerySurge™. Help can be found in the top toolbar in text form or in the bottom panel by the Help icon.
QuerySurge™ Chat can be accessed through the QuerySurge™ product or on the QuerySurge™ web site. Experts
are available Monday to Friday from 9:00am to 5:00pm Eastern Time (New York) to assist you with questions regarding
installation, configuration, and usage of the QuerySurge™ testing tool. Chat can also be used during off hours to leave
text questions or comments.
Video Library provides tutorials, demos, and webinars on the ins and outs of QuerySurge™ usage.
http://www.querysurge.com/product-tour/video-library
Contact Us page provides a form where you can submit comments, questions, or suggestions.
http://www.querysurge.com/company/contact-us
Documentation
• System Requirements Guide – hardware and software needed to minimally and optimally run
QuerySurge™.
• Installation Guides
o for Windows (Single Machine) or Windows (Multi Machine)
o for Linux (Single Machine) or Linux (Multi Machine)
• Configuration Guides. (Most of these configurations are automated in the ‘Setup Wizard’ within
QuerySurge™).
o Configuring A Connection To IBM DB2
o Configuring A Connection To A Delimited Flat File
o Configuring A Connection To A Fixed-Width Flat File
o Configuring A Connection To Oracle
o Configuring A Connection to Teradata
o Configuring a Connection to SQL Server
• QuickStart User Guide (this document)
http://www.querysurge.com/http://www.querysurge.com/product-tour/video-libraryhttp://www.querysurge.com/company/contact-ushttps://querysurge.zendesk.com/hc/en-us/articles/206127793-QuerySurge-System-Requirementshttps://querysurge.zendesk.com/hc/en-us/articles/115000204686-QuerySurge-Windows-Installation-Guide-Single-Machinehttps://querysurge.zendesk.com/hc/en-us/articles/115000203486-QuerySurge-Windows-Installation-Guide-Multi-Machinehttps://querysurge.zendesk.com/hc/en-us/articles/115000204786-QuerySurge-Linux-Installation-Guide-Single-Machinehttps://querysurge.zendesk.com/hc/en-us/articles/214400323-QuerySurge-Linux-Installation-Guide-Multi-Machinehttps://querysurge.zendesk.com/hc/en-us/articles/205748806-Configuring-Connections-IBM-DB2https://querysurge.zendesk.com/hc/en-us/articles/206083633-Configuring-Connections-Delimited-Flat-Fileshttps://querysurge.zendesk.com/hc/en-us/articles/205759826-Configuring-Connections-Fixed-Width-Flat-Fileshttps://querysurge.zendesk.com/hc/en-us/articles/205763696-Configuring-Connections-Oraclehttps://querysurge.zendesk.com/hc/en-us/articles/206087653-Configuring-Connections-Teradatahttps://querysurge.zendesk.com/hc/en-us/articles/206087203-Configuring-Connections-Microsoft-SQL-Serverhttp://www.querysurge.com/Site/web/resources/installation/QuerySurge-QuickStart-User-Guide.pdf
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
6
Understanding QuerySurge™
Data Warehouse Testing Comprehensive testing of a data warehouse at every point throughout the ETL (extract, transform, and load)
process is becoming increasingly important as more data is being collected and used for strategic decision-
making.
Data warehouse projects are undertaken as a result of mergers and acquisitions, compliance and regulations,
data consolidation, and the increased reliance on data-driven decision making (using Business Intelligence tools,
etc.).
Any way you slice it, the data warehouse/business intelligence (BI) platform is complex and presents many data
quality and testing problems to overcome. Some of the main challenges of data warehouse testing are:
• Data Completeness: Verifying that all data has been loaded from the sources to the target data
warehouse.
• Data Transformation: Ensuring that all data has been transformed correctly during the ETL process.
• Data Quality: Ensuring that the ETL process correctly rejects, corrects, ignores, substitutes default
values, and reports invalid data.
• Regression Testing: Ensuring existing functionality remains intact each time a new release of code is
completed.
QuerySurge™ is a test tool that automates data warehouse and ETL testing. QuerySurge™ verifies data
completeness, correct transformation logic, ensures data quality, and provides for regression testing of upwards
of 100% of all data. QuerySurge™ has five different modules:
1) Design Library
Use the QuerySurge™ ‘Design Library’ tools to create collections of powerful tests across your data warehouse
architecture.
❑ Create test QueryPairs between any two points (Source, Staging, Data Warehouse, Data Mart) in your
architecture
❑ See query history for all of your queries
❑ Run QueryPair executions as you build queries to ensure they produce the required results
❑ Make your design flexible with Reusable Query Snippets - Snippet libraries of query fragments that you
can use to modularize your queries, helping to speed up the process of bulk QueryPair updates.
❑ Run the Query Wizard, which provide information for 1) row count compares, 2) full table compares,
and 3) column compares without writing any SQL code.
2) Scheduling
Schedule your testing by time and location (By selecting agents) for maximum productivity. Schedule your
tests for the specific time and day, or run tests when an event, like the ETL process, completes.
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
7
❑ Mix-and-match test QueryPairs in QuerySurge™ Test Suites to meet specific project execution goals
❑ Build groups of QuerySurge™ Test Suites to test specific mappings, ETL logic or data warehouse sources
❑ Build QuerySurge™ Scenarios for scheduling your execution runs at specific dates and times
❑ Use the execution API for event-based scheduling
3) Run Dashboard
Visualize and track the real-time progress of your running Scenarios on the QuerySurge™ ‘Run Dashboard’. A
graphical display helps you to follow the flow of your queries, and you can drill-down to see test details and
data failures.
❑ View query execution progress live via graphical run status displays
❑ Drill-down into data as QuerySurge™ executes to examine results as they become available during
execution
❑ See real-time statistics for each QueryPair executed and for the Scenario execution as a whole
❑ Alert your team about the status of execution via custom email notifications
❑ Export detailed results in Excel, CSV or XML formats to share with team members and other project
stakeholders
4) Reporting
Get a comprehensive audit and share detailed results with others. Use QuerySurge™ reports to share both high-
level and detailed views of your testing with team members, managers, and business stakeholders.
❑ Choose from a wide selection of configurable reports within the QuerySurge™ ‘Data Intelligence
Reporting Center’
❑ Built-in reports range from high-level summary reports to lower-level, detailed reports with a complete
audit trail of test modifications
❑ Configure reports for specific date ranges, asset types, or specific executions to get a view into your
results that you need
❑ Export your reports as Excel or PDF files to share within your organization or to archive for future audit
needs
5) Administration
The administration module provides access to the control features of your QuerySurge™ installation. Here, you
have the ability to create and manage user profiles, database connections, Agent configuration, data storage
and automated email notification options.
❑ Create and manage QuerySurge™ users and Agents ❑ Manage QuerySurge™ data storage with the included storage tools ❑ Create and manage connections to source and target data stores ❑ View QuerySurge™ server information, including configuration settings and your application licensing
details ❑ Create automated email notifications to send results to your team at the end of a test run
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
8
The QuerySurge™ Testing Process
Testing and validating the ETL process is the key component to the success of a data warehouse
implementation. Bad data caused by defects in the ETL process can cause data problems in reporting that can
result in poor strategic decision making.
Example: A large fast food company depends on BI reports to determine how much raw beef to order on a
monthly basis, by sales region and time of year. If these reports are not correct, then the company could order
an incorrect amount which could cost the company millions of dollars in either lost revenue or wasted product.
Developers utilize ETL tools to accomplish the extracting, transformation and loading of data from sources into
target systems.
Test Points and ETL Legs
• An ‘ETL Leg’ refers to a single ETL process that moves/transforms data between two discrete points in the data
warehouse architecture.
• A full ETL process may have multiple legs.
• Test points and single ETL leg: the verification is between the source and the target for that leg.
Example: An operational source database (source test point) is extracted, transformed and loaded into a data
warehouse (target test point). Testing is conducted across this ETL leg.
• Test points and multiple ETL legs: The multi Leg approach is to validate multiple legs of the ETL process in a
single test, ‘jumping over’ ETL legs in the process. A typical multi Leg test is to validate the entire ETL process
from data sources to final data endpoint utilizing test points only at the data sources and at the final data
endpoint.
Data Mapping Document
A data mapping document, frequently called a source-to-target map, is the most important artifact when testing
a data warehouse and is generally created in an Excel spreadsheet or Word document. The mapping document
acts as a central part of the functional requirements. Testers use the mapping document to verify that the data
has been extracted from the source databases and files into the target data warehouse and data marts correctly,
and that the transformations have been performed according to the specifications detailed in the mapping
document. The following information is contained within the mapping document:
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
9
QuerySurge™: The Process in a Nutshell
❑ Review mapping document
❑ Determine the optimum percent of coverage or amount of data that is required to be tested, based upon time
and resources
❑ If not testing 100% of the data, determine the exact sampling of data needed
❑ Create test cases that exercise the requirements of the mapping document
❑ Create pairs of SQL queries (QueryPairs) – one aimed at the source database or file, one at the target data
warehouse or data mart
❑ Bundle groups of QueryPairs into Test Suites to run Scenarios
❑ Schedule Scenarios to run a) immediately, b) at a certain day and time, or c) automatically after an event
❑ Analyze and drill down into your results and identify bad data and data defects with our robust reporting engine.
❑ Report defects in your defect tracking tool (i.e. HP Quality Center, IBM Rational Quality Manager, Jira, Bugzilla,
etc.)
❑ Have reports sent automatically via email to team members
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
10
About the QuerySurge™ Architecture
QuerySurge™ is a locally installed, browser-based testing tool. Supporting all current browsers (Chrome, Firefox, IE,
Edge, etc.), QuerySurge™ is perfect for teams that are geographically distributed. QuerySurge™ extracts the data-under-
test to its own, separate infrastructure,
which eliminates processing overhead on
the source and target database servers in
your data warehouse architecture. The
QuerySurge™ architecture is comprised of
an application server, database server and
Agents.
QuerySurge™ Application Server and
Database
QuerySurge™ utilizes a Tomcat application
server and a MySQL database. The database
is bundled with and embedded within the
product.
QuerySurge™ Agents
QuerySurge™ Agents are the components of the architecture that execute queries against source and target data
sources, returning the results to the QuerySurge™ database. The Agents execute SQL queries, validating each piece of
data throughout the ETL process. This exposes all data mismatch failures, row count differences, and column type
mismatch failures, affording you the ability to test to 100% of your data quickly.
Although the Agents issue queries to both the source and target databases, they do not reside on the physical source or
target database boxes. QuerySurge™ Agents can be deployed on the same box as the QuerySurge™ Application Server
and QuerySurge™ Database Server in a single box install or on any “satellite” boxes in the environment (often, these are
test lab boxes or available desktop boxes). The QuerySurge™ Agent, when it receives a bundle of queries, can run
multiple queries simultaneously (in parallel).
One of the features QuerySurge™ gives you is the ability to raise your ‘testing throughput’. The idea is to be able to fire
off QueryPairs in bulk against your sources and targets so that you can execute at the highest level your environment
can support. The QuerySurge™ Agent lets you do this, because you can deploy multiple Agents in your environment – on
‘satellite’ boxes surrounding your QuerySurge™ server (note that each Agent can run multiple query threads as well).
QuerySurge™ allows you to install up to 10 Agents.
More Agents = more queries = more throughput
How many Agents are appropriate for your environment? The answer is – you find out by experimentation. Once you
have built an initial test library, start with 2 or 3 Agents, and see how your sources and targets behave. Add additional
Agents in a subsequent cycle, again monitoring the source and target behavior. As you continue to add Agents, the loads
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
11
on sources and targets will grow with query volume – and source/target response times will start to grow as well. Once
you have identified the level where response times have started to increase, back down to the previous level. This level
is roughly the maximum throughput your current environment can support.
For more information on Agents, please visit Administration→Agents in the Help guide.
Database / Data Warehouse Support
In principle, QuerySurge™ can support any JDBC-compliant data source. QuerySurge™ currently ships with Oracle,
MySQL, Teradata, Aster, SQL Server, DB2, Informix, Excel, Vertica, RedShift, Hadoop, Netezza, Sybase, in-memory
database, and flat file support and supports many other data sources.
Installation Requirements
For a trial installation, the QuerySurge™ application server, the QuerySurge™ database server and QuerySurge™ Agents
may be installed either on a single box or on separate boxes. Minimum requirements for a single box installation are 4
GB of memory and 100 GB of disk space. More memory and disk space will always provide better performance.
Deploying to a distributed environment with multiple boxes or VM images (i.e. database server on one box, app server
on another, Agent(s) on other boxes) will have a positive impact on the query size, data volume and QuerySurge™
performance that can be handled during the trial. For additional information on system requirements, please refer to
the document QuerySurge™ System Requirements.
http://www.querysurge.com/https://querysurge.zendesk.com/hc/en-us/articles/206127793-QuerySurge-System-Requirements
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
12
QuerySurge™ Terminology
QueryPair
A pair of SQL queries where one query retrieves data from a source file or database and
another SQL query that retrieves data from a target database, data warehouse or data mart.
Agent
Performs the actual query tasks. Agents execute queries against source and target data stores, and return
the results to the QuerySurge™ database.
Design-Time Run
Allows you to execute a QueryPair test to make sure that it behaves as you expect. This is not intended for
actual test execution purposes.
Query Snippet
Reusable piece of SQL code that can be embedded in one or many queries. The purpose of a Snippet is to
minimize the number of places you need to make changes on the same code in different SQL calls.
Test Suite
A collection of QueryPairs used for execution. This feature allows you to group your QueryPairs execution
purposes that is independent of your ‘Design Library’ organization.
Scenarios
A collection of Test Suites that are scheduled for execution.
Query Wizard
A tool that allows you to generate QueryPairs automatically, requiring no SQL coding. It is a fast and easy
way to create QueryPairs for both manual testers who do not have SQL skills as well as for testers who are
skilled at SQL and want to speed up test authoring. The Query Wizard generates tests that can cover about
80% of all data in a data warehouse automatically. 1
Widgets
Project Widgets give you a real-time view into your project progress at all levels, from QueryPair
development to execution and results.
Command Line Integration
Provides the ability to schedule Test Suites to run using Windows Task Scheduler or integrate with a
continuous build system.
1 A recent poll conducted by RTTS on targeted LinkedIn groups found that 80% of columns in data warehouse tables have no transformations.
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
13
QuerySurge™
QuickStart Guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
14
Login to QuerySurge™
Upon QuerySurge™ installation one Administrative user is created for you to get started.
1. On the installation machine click the ‘Start’ button
2. In the ‘Start’ menu select All Programs → QuerySurge™ → Launch QuerySurge™
3. QuerySurge™ will launch in your default browser
4. Enter Username “admin” and Password “admin” and click the ‘Login’ button
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
15
Create a QueryPair test from scratch
A QueryPair is what QuerySurge™ refers to as a pair of queries that have the following characteristics:
o One SQL query that retrieves data from a source file or database o Another SQL query that retrieves data from a target big data store, data warehouse, data mart or database
These two queries together comprise a QueryPair.
1. Click the ‘QueryPairs’ folder in the ‘Design Library’ panel
2. Click the ‘Create New QueryPair’ button
3. Enter “My Test QueryPair” in the ‘QueryPair Name’ field and enter “My first QueryPair” in the ‘Description’ field
Points of interest:
o The ‘Create a New QueryPair’ dialog contains:
▪ QueryPair Name field – a name for your QueryPair
▪ Description field – a description for your QueryPair
▪ Mapping field – for reference back to a mapping document if applicable. (Data mapping is a
process used in data warehousing by which different data models are linked to each other.
Mappings are typically used for transformations in the ETL process or for consolidation of
multiple databases and / or redundant columns. )
4. Click the ‘Save’ button on the ‘Create New QueryPair’ dialog and the new QueryPair tab will open
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
16
Points of interest:
o The ‘QueryPair’ tab contains:
▪ ‘Source’ and ‘Connection’ – for storing the source query with a connection
▪ ‘Target’ and ‘Connection’ – for storing the target query with a connection
▪ ‘Save’ icons – for saving the source or target query
5. Enter your SQL in the ‘Source’ query text ‘Editor’ (copy/paste will work)
6. Select your source DB from the source ‘Connection’ drop-down
7. Enter your SQL in the ‘Target’ query text ‘Editor’ (copy/paste will work)
8. Select your target DB from the target ‘Connection’ drop-down
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
17
Points of interest:
o In the screenshot above ‘countryName’ is the column name in the source COUNTRYISO table
o In the screenshot above ‘countryName’ is the column name in the target ‘Country’ table (same name in
both source and target)
o For demonstration purposes, both columns were aliased to ‘Country’. QuerySurge™ does not require
both source and target columns to be named the same (although this is a best practice), however the
columns need to be in the same logical order between source and target
9. Click the ‘Save’ icon on both the source and target queries.
For more information on QueryPairs, please visit Design Library→QueryPairs in the Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
18
Review of QuerySurge™ Agent and Agent Status
QuerySurge™ Agents perform the actual query tasks. Agents execute queries against source and target data stores, and return the results to QuerySurge™. When you install a QuerySurge™ Agent, the installer will ask you for the URL of your QuerySurge™ installation. The installer will then install and start the Agent. When the Agent starts, it will check its registration status with QuerySurge™, and it will auto-register if necessary.
1. Agent status can be determined visually via the Agent icon in the bottom right of the GUI
Points of interest:
o Agent icon appears red on bottom when busy
o Agent icon appears yellow on bottom when idle
o Agent icon appears gray on bottom when offline
o Mouse-over the Agent icon to reveal the status of all Agents
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
19
2. Click the Agent icon to open an ‘Agent Activity’ window
Points of interest:
o The ‘Agent Activity’ window contains:
▪ Hostname – the names of all Agents that have been added
▪ Project Name – Name of project currently executing test. This will be blank if no execution is
running
▪ Status – Agents can be Idle, Offline, or Running a Scenario
▪ Last Ping – date and time the Agent last communicated with QuerySurge™. Active Agents
display a checked green symbol, inactive Agents display an X’d red symbol
▪ Scenario Name – Name of the test currently executing. This will either be the Scenario Name
or for DTR based runs “DesignTime”
▪ QueryPair Name – Name of QueryPair or Staging Query Executing.
▪ Owner – User who has triggered this execution
▪ Elapsed Time – How long this execution has been running
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
20
Additional points
o You may install multiple QuerySurge™ Agents up to the number that your license permits.
o Each QuerySurge™ Agent deployed in your environment needs at least one JDBC driver to work with
your data sources. A JDBC driver is a piece of software that allows your Agent to "talk" to a data source.
So, for example, if you plan to use QuerySurge™ with Oracle and Teradata, you will need to install both
the Oracle and the Teradata drivers with each Agent.
o The QuerySurge™ Installer comes bundled with JDBC drivers for several industry-standard databases,
and you can install these drivers when you install the Agent.
o You can always add new drivers using the installer after you have installed an Agent.
o Your JDBC driver product may not be bundled with QuerySurge™; if not, you will have to deploy the
JDBC driver(s) manually to the Agent machine.
o QuerySurge™ Agent installs as a service by default.
For more information on Agents, please visit Administration→Agents in the Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
21
Design-Time Run execution of an existing QueryPair test
The ‘Design-Time Run’ tab displays detailed results for each QueryPair . This tab allows you to execute a QueryPair
test run to make sure that it behaves as you expect. This is not intended for actual testing execution purposes.
1. Click on the + next to the ‘QueryPairs’ folder on the left to expand the folder
Points of interest:
o QuerySurge™ utilizes a folder structure similar to Microsoft Windows Explorer
o Multiple sub-folders can be contained within folders
o QueryPairs are contained within each folder
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
22
2. Double-click your QueryPair to open it (Example below is one of the tutorial QueryPairs included with
QuerySurge)
Points of interest:
A QueryPair has the following tabs:
o The ‘QueryPair’ tab contains
▪ ‘Source Query’ and ‘Connection’ – for storing the query with a specific database connection
▪ ‘Target Query’ and ‘Connection’ – for storing the query with a specific database connection
▪ ‘Save’ icons – for saving the source or target query
o The ‘Properties’ tab contains
▪ QueryPair name, description, and mapping fields
▪ Data Type Checking – Ability to broadly check data types (e.g. text vs numeric) or convert all
types to varchar (String) before comparisonRow Count Options – to set reporting for row
count differences
▪ Row Count Options – to set whether or not a QueryPair fails if extra rows exist in the source
or target.
▪ Shared Key Column Definition – to set a column from either the source or target query as
key
▪ Column Threshold Options – Ability to allow fields to pass if within a user defined threshold
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
23
▪ Duplicate Row Options – to set whether or not QuerySurge uses a comparison algorithm to
manage duplicate rows in your data. (Note: this is not a test for duplicates)
o The ‘Design-Time Run’ tab contains
▪ Detailed results for each QueryPair. This tab allows you to execute a QueryPair test run to
make sure that it behaves as you expect
o The ‘History’ tab shows the history of changes to the QueryPair
o The ‘DTR History’ tab shows pass/fail information from previous ‘Design-Time Runs’ (currently
empty as no runs have been executed yet)
3. Click the ‘Design-Time Run’ tab
Points of interest:
o The ‘Design-Time Run’ tab allows you to execute a test run, to make sure that the QueryPair behaves as
you expect (not for actual testing execution purposes)
o The first time clicking on the ’Design-Time Run’ will indicate that a run has not occurred previously for a
QueryPair
o A specific Agent, if desired, can be selected in the drop down menu (not required )
o Once you perform a ‘Design-Time Run’, the most recent results will always display here
4. Click the ‘Run’ button to execute the QueryPair
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
24
Points of interest:
o When executing a ‘Design-Time Run’, QuerySurge™ goes through the following phases:
▪ Loading – QuerySurge™ is loading the SQL pairs onto the Agent for execution
▪ Running – The Agent is running the target and source queries
▪ Analyzing – QuerySurge™ is comparing the results
o QuerySurge™ displays the following information about the last ‘Design-Time Run’
▪ Source Rows – number of source rows returned
▪ Target Rows – number of target rows returned
▪ Row Count Difference – number of rows different between source and target
▪ Failed Row Count – number of rows with data differences
▪ Non-Matching Source Rows – number of source rows not found in the target (based on key
column(s))
▪ Non-Matching Target Rows – number of target rows not found in the source (based on key
column(s))
o The Connections section displays the source and target data sources utilized.
o The Query Performance section shows metrics on query timing and analysis execution
o The Details section displays the following information
▪ Agent – Agent used for test
▪ Scheduled By – User who executed the run
▪ Scheduled Time – Time which the test was initiated
▪ Actual Start Time – Time at which the test executed. This may be different from scheduled
time if agents are currently busy.
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
25
5. Click the ‘View Query Results’ button to bring up the results window
Points of interest:
o The ‘QueryPair Results’ window contains Six tabs
▪ Source Tab – displays the source result rows
▪ Target Tab – displays the target result rows
▪ Failures Tab – displays data failures (not populated in this example as no rows failed)
▪ Source Query Tab – displays the source query
▪ Target Query Tab – displays the target query
▪ Query Performance –Displays metrics on source/target queries as well as analysis
For more information on QueryPairs, please visit Design Library→Working with QueryPairs in the Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
26
Create a Reusable Query Snippet
A query Snippet is a reusable piece of SQL code that can be embedded in one or many queries. The purpose of a Snippet
is to minimize the number of places you need to make changes on the same code in different SQL calls. A Snippet does
not have to be a syntactically intact query (for example, it might just be a WHERE clause) but there is no reason why it
can’t be a complete query (e.g. a reusable sub-query). This feature lets you develop libraries of ‘Reusable Query
Snippets’ to be reused in multiple queries. If a Snippet shared by multiple queries needs to change, you can make the
change once and all of the queries using the Snippet are changed automatically.
To create a ‘Reusable Query Snippet’:
1. Click the ‘Reusable Query Snippets’ folder in the ‘Design Library’
2. Click the ‘Create New Reusable Query Snippet’ button
3. Enter “My Test Snippet” in the ‘Reusable Query Snippet Name’ field and enter “My first reusable query snippet”
in the ‘Description’ field
4. Click the ‘Save’ button on the ‘Create New Reusable Query Snippet’ dialog
5. Enter your SQL in the ‘Reusable Query Snippet’ text ‘Editor’ (copy/paste will work)
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
27
Points of interest:
o A ‘Reusable Query Snippet’ has the following tabs:
▪ Reusable Query – where the SQL resides
▪ Properties – for additional descriptive information and metadata
▪ History – shows the history of changes made to the Snippet
▪ Appearances – shows which QueryPairs contain the Snippet
6. Click the ‘Save’ button to save your ‘Reusable Query Snippet’
7. The newly created ‘Reusable Query Snippet’ is added to the ‘Design Library’ and is now available for use
Adding a ‘Reusable Query Snippet’ to a QueryPair:
1. Create a new QueryPair named “My Test QueryPair2”
2. Place your cursor in the source query.
3. Click the ‘Add Reusable Query Snippet’ button
4. Click the ‘Reusable Query Snippets’ folder on the left panel
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
28
5. Select ‘My Test Snippet’ in the top right panel
Points of interest:
o The left panel utilizes a folder structure similar to Microsoft Windows Explorer (your Snippet is saved
in the root folder, but can be grouped by subfolders manually)
o The top right pane displays the ‘Reusable Query Snippets’ including the one you created earlier
o The bottom right panel displays the SQL of the selected Snippet
6. Click the ‘OK’ button
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
29
Points of interest:
o QuerySurge™ indicates a Snippet reference using the following syntax: ${...}
o The ‘Source’ panel above is in the ‘Editor’ view and displays the Snippet as a reference
7. Hover over the snippet to see the underlying snippet text
For more information on Snippets, please visit Design Library→Working with Reusable Query Snippets in
the Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
30
Review of a failed QueryPair
QuerySurge™ ensures that the data extracted from sources remains intact in the target by analyzing and pinpointing any
differences. The following is an example of when ETL data differences are discovered:
1. In the ‘QueryPair’ view:
Points of interest:
o Both queries bring back five columns
o In the properties tab the column ‘Customer ID’ has been set as the key
2. In the ‘Design-Time Run’ tab (after running a QueryPair)
Points of interest:
o One additional row showed up on the target side as compared to the source (Row Count Difference)
o Five data errors occurred (Failed Row Count)
o One Key from the source was not found on the target and two keys from the target were not found
on the source (Non-Matching Rows)
3. After clicking the ‘View Query Results’ button, go to the ‘Failures’ tab
http://www.querysurge.com/http://www.querysurge.com/product-tour/defects-we-findhttp://www.querysurge.com/product-tour/defects-we-find
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
31
Points of interest:
o Customer Last Name for Customer ID 00B56A has been mistranslated from Mickelsen to Smith. This
may be due to incorrect order of ETL jobs
o Customer First Name for Customer ID 00B574 has been truncated. In the source it’s William on the
target its Willa
o Credit Card Numbers for all failing rows have been altered
o QuerySurge™ uses the key column to flag which rows are non-matching
and which are data failures
o Failures are shown with a red background
For more information on QueryPairs, please visit Design Library→Working with QueryPairs in the Help
guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
32
Creating a Test Suite
The Test Suites feature of QuerySurge™ lets you organize your QueryPairs in Test Suites - collections of QueryPairs for
execution. This feature allows you a different level of organization for execution purposes that is independent of your
‘Design Library’ organization.
1. Click the ‘Scheduling’ icon located on the bottom panel
Points of interest:
o Left Panel – this area displays all the available Test Suites that can be run
o Middle Panel – displays test associated with a Test Suite (currently no Test Suite is selected)
o Right Panel – displays the ‘QueryPair Library’ tree
2. Click the ‘Create Suite’ button
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
33
Points of interest:
o The ‘Create New Test Suite’ dialog contains:
▪ Test Suite Name – a name for your suite
▪ Description – a description for your suite
3. Enter “My Suite” in the ‘Test Suite Name’ field and click the ‘Save’ button
Points of interest:
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
34
o Notice the new Test Suite on the left panel is selected
o The new Test Suite is currently empty
4. Open the ‘QueryPairs’ folder from the ‘QueryPair Library’ panel on the right and drag the QueryPair ‘ZCITY –
CITY‘ to the ‘My Suite’ panel in the middle
Points of interest:
o You can also drag an entire folder into your Test Suite
o The middle panel now shows all the QueryPairs contained within the Test Suite
o You can remove a QueryPair by selecting it and clicking the red icon
o The ‘Properties’ tab at the bottom of the center panel includes additional information and allows for
overriding of the connections designated on the QueryPair itself
5. Repeat step 4 for additional QueryPairs to be added to the Test Suite
6. Click the ‘Save’ button in the upper left corner of the middle panel to save your Test Suite
For more information on Test Suites, please visit Scheduling→Working with Test Suites in the Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
35
Creating a Scheduled Execution Scenario
QuerySurge™ Scenarios are collections of Test Suites that are scheduled for execution. Scenarios can be run
immediately after creation, or scheduled for a future date/time, and are viewable in the ‘Run Dashboard’
1. Click the ‘Schedule Scenario’ button
Points of interest:
o The ‘Schedule Scenario’ window contains:
▪ Scenario Name field – the name of the Scenario
▪ All Dates to field – sets all Test Suites to run on a particular date and time
▪ All Agents as field – sets all Test Suites to run on a particular Agent
▪ A Test Suite schedule area with columns containing:
• Test Suite – Test Suites for this Scenario
• Agent – allows you to select a particular Agent
• Scheduled Date & Time of Run – for selecting a specific date and time for a run
o Useful for executing tests, e.g. during non-working hours
2. Enter “My Scenario” into the ‘Scenario Name’ field
3. Click the ‘Add Test Suite’ button
4. In the ‘Test Suite’ column, click the drop down list and select the ‘My Suite’ Test Suite
5. Repeat Step 3 if you want to add additional Test Suites
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
36
Points of interest:
o In the screenshot above, the ‘My Suite’ Test Suite has been added to the ‘My Scenario’ Scenario
o The Test Suite is set to run on any Agent
o The Test Suite is scheduled to run now
6. Click the ‘Save’ button on the ‘Schedule Scenario’ window
7. Navigate to the ‘Run Dashboard’ by clicking the ‘Run Dashboard’ icon
8. Click on ‘My Scenario’ in the ‘Scenario Queue’ (note: it may take a few seconds for the Scenario to appear)
Points of interest:
o Left Panel – ‘Scenario Queue’ which includes all Scenarios including those previously run.
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
37
o Upper Middle Panel – the currently selected Scenario’s Test Suites and their progress
o Upper Right Panel – additional information and metrics
o Lower Middle/Right Panel – graphs of progress
o After execution has completed, review historical data by selecting a Scenario in the left panel.
o Double click on any Test Suite in the upper middle panel to see your detailed data.
9. Note the Scenario metrics on the far right
Points of interest:
o ‘QueryPair Metrics’ on the right panel contains:
▪ Queued – current QueryPairs waiting on an Agent
▪ Running – current QueryPairs running
▪ Passed – number of passed QueryPairs
▪ Failed – number of failed QueryPairs
▪ Errors – number of QueryPairs with SQL or connection errors
▪ Killed – number of QueryPairs that were killed by cancelling the run
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
38
10. Double click a Test Suite to open the ‘QueryPairs’ window
11. Select a QueryPair to view its results
Points of interest:
o Lower Panel
▪ Source tab – shows the rows returned by the source query
▪ Target tab – shows the rows returned by the target query
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
39
▪ Failures tab – shows failures resulting from the source and target comparison
o Right Panel
▪ Source Row Count – displays number of source rows
▪ Target Row Count – displays number of target rows
▪ Row Count Difference – displays number of extra rows in source or target
▪ Failed Row Count – displays number of data failures
12. Example of a ‘Failures’ tab in lower panel
Points of interest:
o You can export results to Excel, CSV file, or an XML document using the ‘Export to’ drop-down menu
located below the tabs on the lower panel
For more information on Execution, please visit Scheduling→Running a Test Suite in the Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
40
Running Reports
The ‘Data Intelligence Reporting Module’ shows the formal reports offered by QuerySurge™. Some reports have
configurable options which are found once the report type has been selected and opened. Once executed, reports can
be saved as a PDF or exported to Excel.
1. Click the ‘Data Intelligence Reporting’ icon located on the bottom panel
Points of interest:
o A list of reports is shown in the ‘Data Intelligence Reporting Center’ (left panel)
2. Select the ‘Scenario Summary’ report
3. Click the ‘Open Report’ button
4. Select ‘My Scenario’ in the ‘Select a Scenario:’ drop-down menu
5. Click the ‘Run Report’ button
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
41
Points of interest:
o In the screenshot above the ‘Scenario Status:’ is PASSED because no issues were identified with any
QueryPairs in this scenario.
o The ‘QueryPair Results‘ displays a breakdown of all QueryPair outcomes
o Additional information is displayed in the ‘Overview’ section
For more information on Reports, please visit the QuerySurge Knowledge Base
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
42
Query Wizard
The Query Wizard is a tool that allows you to generate QueryPairs automatically. This is great for those with limited or
no SQL experience, as well as for experts who are looking for a fast and easy way to create QueryPairs for data
migrations, database upgrades, and other database comparisons that do not have transformations. The Query Wizard
can generate QueryPairs for Row Count Comparison, Table-Level Comparison, and Column-Level Comparison validations.
A folder can be created that contains all of the QueryPairs generated. These QueryPairs can also be added to a new Test
Suite so they can be easily run together.
To add a QueryPair using the ‘Query Wizard’:
1. In the ‘Design Menu’ drop-down menu on the top toolbar select ‘Launch Query Wizard’
2. Click the ‘Next’ button on the Query Wizard welcome screen
3. Select a source DB from the ‘Source Connection’ drop-down menu
Points of interest:
o Metadata such as ‘Date Refreshed’, ‘Table Count’ pre-populate for the selected DB
4. Select a target DB from the ‘Target Connection’ drop-down menu and click the ‘Next’ button
5. Select the ‘Row Count Comparison’ radio button in the ‘Comparison Type’ section and click the ‘Next’ button
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
43
Points of interest:
o Column-Level Comparison validates data points in the selected columns and allows for the addition
of Filtering (WHERE Clause) and Sorting (ORDER BY)
o Table-Level Comparison validates each data point in the source table to its corresponding data point
in the target table
o Row Count Comparison validates the number of rows In each of the selected tables
6. Select the ‘Source Schemas’ and ‘Target Schemas’ from which you will be choosing the tables for comparison
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
44
Points of interest:
o Schemas available for selection are retrieved from the source and target databases that you
previously selected
o One, many, or all schemas can be selected
7. Click the ‘Next’ button
8. Drag individual source tables and drop them onto its coresponding target table, scroll down in the ‘Source
Tables’ and ‘Target Tables’ windows if needed
Points of interest:
o As each individual source table is dropped onto its corresponding target table it’s Query Mapping
appears in the left hand column and can be renamed if desired
o Mapped tables show a line connecting the source and target tables with the selected Query
Mapping line highlighted green
o Auto generated SQL appears in the ‘Source Query’ and ‘Target Query’ panes at the bottom of the
Query Wizard window
9. Click the ‘Next’ button
10. Select the ‘Create a New Folder’ radio button in the ‘Design Library’ section of the Query Wizard window
11. In the ‘Parent Folder’ drop down menu, select the ‘QueryPairs’ folder
12. Enter ‘WizardQueryPairs’ in the ‘Folder Name’ field
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
45
13. Select the ‘Yes’ radio button in the ‘Scheduling’ section of the Query Wizard window
14. Enter ‘WizardQueryPairs’ in the ‘Suite Name’ field
Points of interest:
o The Query Wizard will automatically create the test assets:
• A new folder in the ‘Design Library’ with the name entered in the ‘Folder Name’ field
• All QueryPair(s) for testing the tables selected
• A new Test Suite in the ‘Scheduling’ module with all of the generated QueryPairs
15. Click the ‘Next’ button
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
46
Points of interest:
o A review screen appears with the details for your Query Wizard execution
16. Click the ‘Create’ button
Points of interest:
o A test folder named ‘WizardQueryPairs’ was created in the ‘Design Library’ module
o A Test Suite named ‘WizardQueryPair’ was created in the ‘Scheduling’ module
o Three QueryPairs were created (one for each of the source and target tables mapped)
17. Click the ‘OK’ button
18. Newly created folder with your QueryPairs is added to the ‘Design Library’ and are now available for use
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
47
Points of interest:
o The name of the folder is the name entered into the ‘Folder Name’ field on the Query Wizard
o The name of a QueryPairs are in the following format
• Validation Type: source schema.source table - target schema.target table
For more information on Query Wizards, please visit Design Library→Using the Query Wizard in the Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
48
Review of Data Health Dashboard
The Data Health Dashboard gives you a real-time view into your project progress at all levels, from QueryPair
development to execution and results. Data Widgets are configurable, so you can see the slice of your project that you
want to see, in the way you want to see it.
1. Click the ‘Design Library’ icon located on the bottom panel
2. Click the ‘Welcome’ tab if it’s not already in view
Note: If the available widgets panel is not displayed, then click the ‘Add Widget’ Button
Points of interest:
o The ‘Welcome’ tab defaults to one panel containing four Widgets (center panel)
o Click the ‘Add Widget’ button for a list of additional ‘Available Widgets’ (right panel)
o Panels can be configured by dragging and dropping Widgets as desired
3. Click the maximize button on the ‘Scenario Outcome / Data Reliability’ Widget for a closer view
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
49
Points of interest:
o Pass/Fail Verifications of your recent Scenario Runs displayed as a bar graph by Pass/Fail Rate
o Data Reliability per Scenario metric displayed as a blue line
o The vertical axis for the bar graph is on the left, while the vertical axis for the blue line is on the right
4. Click the ‘Scenario Outcome / Data Reliability’ Widget title to make it editable, type “Tutorial” at the beginning
of the existing title and hit enter
5. Turn off the ‘Total Verifications Passed’ data in the Widget by clicking on its legend
6. Zoom in on the data by clicking on the ‘SCENARIO’ bar in the graph and dragging your mouse across to the ‘ZCITY
– CU’ bar. Zoom occurs upon the release of the mouse button
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
50
Points of interest:
o Title changes are reflected above the graph and in the title bar
o ‘Total Verifications Passed’ are no longer reflected in the graph, add the data back by clicking on the
greyed-out legend
o The graph is zoomed in on the two bars that were highlighted in the previous step and a ‘Reset
zoom’ button now appears to revert your zoom selections
o You can point many of the Widgets at specific data by clicking on the ‘View Settings’ icon
o You can have multiple panels of Widgets by clicking on the ‘Add Panel’ button
For more information on Widgets, please visit Reporting→ Project Widgets in the Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
51
Automated Email Notifications
The notification feature of QuerySurge™ allows a user to create custom email notifications that will be automatically
generated when certain criteria are met. These notifications are highly customizable and can be adjusted to provide
alerts for a wide range of situations.
To add an email notification:
1. Navigate to the ‘Administration’ section of QuerySurge™
2. In the ‘Administration Tree’ click on ‘Project Notifications’ in the ‘Email Notifications’ folder to open the tab
3. Click the ‘Add’ button
4. Specify a name for the notification, such as “My Scenario Failed”
5. In the ‘Event’ drop-down menu select ‘Scenario Ended’
6. Refine the notification by adding two new criteria:
• Click the ‘Add New Criteria’ button
• Data Field = ‘Outcome’
• Comparison Type = ‘Equals’
• Value = ‘Failed’
• Click the ‘Add New Criteria’ button
• Data Field = ‘Owner’
• Comparison Type = ‘Equals’
• Value =
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
52
Points of interest:
o This email notification triggers when a Scenario ends, the Scenario fails and you are the owner
o The available options for ‘Event Criteria’ are determined by the ‘Event’ chosen
o If there are multiple ‘Event Criteria’ specified, all must be satisfied to send out the notification
o If no ‘Event Criteria’ are selected, the notification will be triggered by any start or end of a Scenario,
depending on the ‘Event’ chosen
7. Define the ‘Email’ template that the notification will use:
• Add a ‘Subject’
• Add a ‘Body’
• Data fields can be added into the template using the ‘Insert Field’ button
Points of interest:
o Inserted data fields are represented in the ‘Subject’ and ‘Body’ as ${field name}
o Fields will be replaced with their actual values when a notification is delivered
o The HTML of the body can be edited directly, allowing, for example, the addition of a previously
created table
8. Specify who will receive the notification. Choose either or both:
• ‘Users:’ QuerySurge™ will use the email address from the user’s details to deliver the notification
• ‘Roles:’ This action will send an email to every member assigned the ‘Roles’ selected
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
53
Points of interest:
o ‘Users’ and ‘Roles’ are added by clicking their associated add button
o ‘Users’ and’ Roles’ can be deleted by clicking their associated remove button
9. Click the ‘Save’ button
For more information on Email Notifications, please visit Administration→Email Notifications in the Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
54
Command Line Integration
The command line interface makes it very easy to run Test Suites in QuerySurge™ through automated batch or shell
scripts. This can be useful in many different Scenarios, including the ability to schedule Test Suites to run using Windows
Task Scheduler, CRON Jobs or integrate with a continuous build system.
1. Launch the Windows command line interface or Linux Shell
2. Navigate to the QuerySurge CLI folder. On Windows this defaults "C:\Program Files\QuerySurge\cli\qscli.bat"
and on Linux this defaults to “/opt/QuerySurge/CLI/qscli.sh”
Example commands (Full list can be found at https://querysurge.zendesk.com/hc/en-
us/articles/360026353732-QuerySurge-API-Reference):
1. qscli runTestSuiteByName – Runs an available Test Suite in QuerySurge™, specified by name. The following arguments are required:
a. --hostname
b. --port
c. --username
d. --password
e. –scenarioName
f. –projectId
g.
Returns:
h.
2. qscli runTestSuiteById – Runs an available Test Suite in QuerySurge™, specified by Test Suite id.
The following arguments are required:
a. --hostname
b. --port
c. --username
d. --password
e. –scenarioName
f. –projectId
g.
Returns:
http://www.querysurge.com/https://querysurge.zendesk.com/hc/en-us/articles/360026353732-QuerySurge-API-Referencehttps://querysurge.zendesk.com/hc/en-us/articles/360026353732-QuerySurge-API-Reference
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
55
h.
3. qscli getScenarioOutcome – Returns the outcome of a Scenario, specified by Scenario id (which is
returned by either of the above commands).
The following arguments are required:
a. --hostname
b. --port
c. --username
d. --password
e. –projectId
f.
Returns:
g.
4. qscli help – Prints the arguments for the specified command
a.
5. qscli – Prints the list of available commands
Note: The command arguments can also be specified using their short-code values:
• -h = hostname
• -P = port
• -u = username
• -p = password
Example usage:
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
56
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
57
Example batch script:
For more information on Command Line Integration, please visit Scheduling→Using the Command Line in the
Help guide
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
58
Troubleshooting Common Issues
Below are the 5 most common issues that users see when performing a trial. If you have an issue that is not listed here,
feel free to contact us through our online chat, the ‘Contact Us’ form or by email.
Issue # Issue Summary
Issue 1 QueryPairs are not running or get stuck on ‘LOADING’
Issue 2 Driver class not found error when testing connection
Issue 3 SQL Server with Windows Authentication error when testing
Connection
Issue 4 Data types do not match error
Issue 1:
QueryPairs are not running or get stuck on ‘LOADING’
Resolution:
• If a QueryPair or Scenario is not running, it is most likely unable to find an available Agent. A
QuerySurge™ Agent is responsible for actually establishing contact with your connections and
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
59
executing the queries. If all of your Agents are busy or unavailable, your QueryPairs will not run
and will wait for an Agent to become available.
• To check if an Agent is available:
o Hover over the ‘Agent Status’ icon in the bottom panel to see a quick view of the
Agents’ status (for more info on the ‘Agent Status’ icon see the icon glossary below)
o Click on the ‘Agent Status’ icon in the bottom panel within QuerySurge™ to bring up the
‘Agent Activity’ window
o Click on the ‘Administration’ menu then choose ‘View Agents’ to open the Agents grid
o Agent Status Icons:
Description Icons
No Agent(s) online.
Agent icon appears gray
on bottom when offline.
Idle Agent(s).
Agent icon appears yellow
on bottom when idle.
Agent(s) Executing Scenario
or ‘Design-Time Run’.
Agent icon appears red on
bottom when busy.
Issue 2:
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
60
Driver class not found error when testing connection
Resolution:
• This message will usually be shown if the JDBC driver is not installed or installed incorrectly. See
the document below for instructions on installing drivers:
o Windows: https://querysurge.zendesk.com/hc/en-us/articles/206073053-Adding-a-
JDBC-Driver-to-a-QuerySurge-Agent-on-Windows
o Linux: https://querysurge.zendesk.com/hc/en-us/articles/206073873-Adding-a-JDBC-
Driver-to-a-QuerySurge-Agent-on-Linux
Issue 3:
SQL Server with Windows Authentication error when testing connection
Resolution:
• Follow the guide to deploy the authentication dll file:
• https://querysurge.zendesk.com/hc/en-us/articles/205766836-Setup-for-SQL-Server-Windows-
Authentication
• Run Agent service as desired user:
o Stop the Agent Service by opening QuerySurgeAgentw.exe in the QuerySurge™ Agent
install directory. In the dialog, use the ‘Stop’ button near the bottom of the dialog. (You
can also access this interface from the Windows Services Control Panel.)
http://www.querysurge.com/https://querysurge.zendesk.com/hc/en-us/articles/206073053-Adding-a-JDBC-Driver-to-a-QuerySurge-Agent-on-Windowshttps://querysurge.zendesk.com/hc/en-us/articles/206073053-Adding-a-JDBC-Driver-to-a-QuerySurge-Agent-on-Windowshttps://querysurge.zendesk.com/hc/en-us/articles/206073873-Adding-a-JDBC-Driver-to-a-QuerySurge-Agent-on-Linuxhttps://querysurge.zendesk.com/hc/en-us/articles/206073873-Adding-a-JDBC-Driver-to-a-QuerySurge-Agent-on-Linuxhttps://querysurge.zendesk.com/hc/en-us/articles/205766836-Setup-for-SQL-Server-Windows-Authenticationhttps://querysurge.zendesk.com/hc/en-us/articles/205766836-Setup-for-SQL-Server-Windows-Authentication
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
61
o Click on the ‘Log On’ tab. Next, click on the ‘This account’ radio button and enter a user
name that has appropriate domain permissions. Use the format
‘mydomain\myusername’ for the user name, and then enter the account credentials.
Press the ‘Apply’ button.
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
62
o Return to the ‘General’ tab, and re-start the Agent Service using the ‘Start’ button. Press
the ‘OK’ button to close the dialog.
o Your Agent Service should have access to network resources.
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
63
Issue 5:
Data types do not match error
Resolution:
• If the data types of the source and target columns do not match, QuerySurge™ will return an
error. This error message should display which columns are affected. This is especially common
in situations where the source and target connections use different database technologies. In
order to resolve this, you will need to cast your columns in either your source query or target
query. For more information on casting, please refer to the documentation for the specific
database technologies that you are using.
http://www.querysurge.com/
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
64
Things to do next
• Run additional reports
• Create and execute additional Scenarios
• Take a look at the Help Section
• View our video tutorials
• Request a Proof of Concept
• Contact Us
http://www.querysurge.com/http://www.querysurge.com/product-tour/video-libraryhttp://www.querysurge.com/get-started/proof-of-concepthttp://www.querysurge.com/company/contact-us
© 2020 Real-Time Technology Solutions, Inc. 22 West 38th Street, 11th Floor • New York, NY 10018
www.querysurge.com • (212) 240-9050
65
About RTTS (developers of QuerySurge™)
RTTS is the premier professional services organization that specializes in
providing software quality for critical business applications. We offer the most
comprehensive suite of quality assurance services, and we've helped 400+
organizations drive positive results from their software development projects.
RTTS was founded in 1996, and has cultivated partnerships with the world's
leading test tool vendors, including IBM, Microsoft, and HP. We are headquartered in New York, NY and our satellite locations are in
Philadelphia, Atlanta, and Phoenix. Many of our consulting and education services are also offered through the cloud, so that no
matter where you are, RTTS will ensure application functionality, performance, scalability, and security for your organization. For
more information, please visit www.rttsweb.com
About QuerySurgeTM
RTTS’ team of test experts developed QuerySurge™ to address the unique testing needs
in the data warehousing and data migration spaces. It has been implemented on
projects ranging from large data warehousing and ETL processes to data migrations,
database upgrades, integration testing, data load testing and system patch testing.
QuerySurge™ is the only automated software tool built specifically for ETL testing. It can
verify as much as 100% of all data from source systems, through the ETL process, to the
target data warehouse and data marts. QuerySurge™ has increased test coverage and
reduced test cycle time for numerous Fortune 500 organizations, helping them to
mitigate risk and meet business requirements. For more information, please visit
www.QuerySurge.com
Click here to contact us for more information
mailto:[email protected]?subject=QuerySurge%20QuickStart%252http://www.querysurge.com/mailto:[email protected]?subject=QuerySurge%20QuickStart%252http://www.rttsweb.com/http://www.querysurge.com/http://www.querysurge.com/company/contact-ushttp://www.querysurge.com/company/contact-usmailto:[email protected]?subject=QuerySurge%20QuickStart%252mailto:[email protected]?subject=QuerySurge%20QuickStart%252mailto:[email protected]?subject=QuerySurge%20QuickStart%252mailto:[email protected]?subject=QuerySurge%20QuickStart%252mailto:[email protected]?subject=QuerySurge%20QuickStart%252mailto:[email protected]?subject=QuerySurge%20QuickStart%252