QATrack+
stable
Contents:
Welcome to QATrack+’s documentation!
Glossary
Release Notes
QATrack+ v3.1.1.3 Release Notes
QATrack+ v3.1.1.2 Release Notes
QATrack+ v3.1.1.1 Release Notes
QATrack+ v3.1.1 Release Notes
QA
Service Log
Faults
Parts
API
Reports
Miscellaneous
QATrack+ v3.1.0.1 Release Notes
QATrack+ v3.1.0 Release Notes
Acknowledgements
Details of the v3.1.0 release
New version numbering
Moving to GitHub
Deprecations & Discontinuations
Major Features
Non backwards compatible changes
Tests & Test Lists
Review & Approval
Units & Unit Types
UI Changes
Admin Changes
API Changes
Service Log & Parts
Authentication
Other Minor Features & Bugs Fixed
What didn’t make it into this release?
QATrack+ v0.3.0.18 Release Notes
QATrack+ v0.3.0.18 Release Notes
QATrack+ v0.3.0.16 Release Notes
QATrack+ v0.3.0.15 Release Notes
Upgrading to v0.3.0.15 from v0.3.0
QATrack+ v0.3.0.14 Release Notes
QATrack+ v0.3.0.13 Release Notes
Upgrading to v0.3.0.13 from v0.3.0
QATrack+ v0.3.0 Release Notes
Acknowledgements
Details of the v0.3.0 release
Upgrading to v0.3.0
QATrack+ v0.2.9 Release Notes
Deprecation Notices
Upgrade Instructions
QATrack+ v0.2.8 Release Notes
Upgrading to v0.2.8
QATrack+ v0.2.7 Release Notes
New Features & Bugs Fixed
Upgrading to v0.2.7
QATrack+ v0.2.6 Release Notes
New Features
Bug Fixes
To upgrade from v0.2.5
QATrack+ v0.2.5 Release Notes
QATrack+ v0.2.4 Release Notes
New Features
Bug Fixes and Clean Up
QATrack+ v0.2.3 Release Notes
New Features
Bug Fixes
Installation and Deployment Options
Selecting a platform for QATrack+
New Installation of QATrack+ v3.1.1 on Ubuntu Linux
Prerequisites
Installing and configuring Git and checking out the QATrack+ Source Code
Check out the QATrack+ source code from GitHub
Installing a Database System
Installing PostgreSQL
Installing MySQL (only required if you prefer to use MySQL over Postgres)
Setting up our Python environment (including virtualenv)
Check your Python version
Creating our virtual environment
Making sure everything is working up to this point
Configuration of QATrack+
Setting up Django Q
Installing Apache web server and mod_wsgi
Next Steps
Last Word
Upgrading an existing Linux v3.X.Y installation to v3.1.1.3
Take a snapshot
Backup your database
Make sure your existing packages are up to date
Check out version 3.1.1.3
Updating our Python environment
Performing the migration
Restart QATrack+
Upgrading an existing Linux v0.3.0 installation to v3.1.1.3
Prerequisites
Take a snapshot
Backup your database
Copy your database
Check your Python version
Make sure your existing packages are up to date
Check out the latest version of QATrack+
Setting up our Python environment (including virtualenv)
Configuration of QATrack+
Setting up Django Q
Setting File Permissions for Apache
What Next
Last Word
Upgrading an existing Linux v0.2.X installation to v3.1.1.3
On your old server
Backup your QATrack+ install data
On your new server
Prerequisites
Installing a Database System
Installing PostgreSQL (Only required if you were previously using Postgres)
Installing MySQL (Only required if you were previously using MySQL)
Restoring your previous database
Installing and configuring Git and checking out the QATrack+ Source Code
Check out the QATrack+ source code from GitHub
Restore your upload files
Setting up our Python environment (including virtualenv)
Migrating 0.2.X (where X < 9) to v0.2.9
Migrating 0.2.9 to 0.3.0
Check out QATrack+ version 0.3.0
Creating our virtual environment
Migrating the 0.2.9 database to 0.3.0
Installing Apache web server and mod_wsgi
Next Steps
Installing and Deploying QATrack+ on Windows Server
New Installation
Install Google Chrome
Installing Python 3
Installing git and checking out the QATrack+ Source Code
Checkout the latest release of QATrack+ source code from GitHub
Setting up our Python environment
Creating a database with SQL Server
Ensure ODBC Driver 17 (or 13.1) is installed
Ensure
SQL Server Authentication
is enabled
Create a new database
Configuring QATrack+ to use your new database
Configuring CherryPy to Serve QATrack+
Setting up IIS
Enabling Proxy in Application Request Routing
Enabling Static Content Serving in IIS
Setting up the site and URL rewrite rules
Setting up Django Q
What Next
Wrap Up
Upgrading an existing Windows v3.X.Y installation to v3.1.1.3
Take a snapshot
Backing up your database
Checking out version 3.1.1.3
Updating our Python environment
Performing the migration
Restart QATrack+
Upgrading an existing Windows v0.3.0 installation to v3.1.1.3
Prerequisites
Take a snapshot
Ensure ODBC Driver 17 (or 13.1) is installed
Install Google Chrome
Stop your CherryPy Service to Serve QATrack+
Backing up your database
Copy your database
Add A Readonly User to Your New Database
Check your Python version
Checking out version 3.1.1
Setting up our Python environment (including virtualenv)
Configuration of QATrack+
Update your CherryPy Service to Serve QATrack+
Setting up Django Q
What Next
Last Word
Upgrading an existing Windows v0.2.X installation to v3.1.1.3
On your old server
Backup your QATrack+ install data
On your new server
Install Python 2.7 (Only required for QATrack+ 0.2.8 and below. Not required for 0.2.9)
Installing Python 3 (required for all)
Ensure
SQL Server Authentication
is enabled
Restoring your previous database
Installing git and checking out the QATrack+ Source Code
Checkout the latest release of QATrack+ source code from GitHub
Restore your upload files
Setting up our Python environment (including virtualenv)
Migrating 0.2.X (where X < 9) to v0.2.9
Migrating 0.2.9 to 0.3.0
Check out QATrack+ version 0.3.0
Creating our virtual environment
Migrating the 0.2.9 database to 0.3.0
Setting up IIS
Enabling Proxy in Application Request Routing
Enabling Static Content Serving in IIS
Setting up the site and URL rewrite rules
Next Steps
Installing & Deploying QATrack+ with Docker
Prerequisites by OS
Windows 10 Professional or Enterprise with Hyper-V
Ensure Virtualisation is enabled
Chocolatey
Docker for Windows, and Git
Enable shared drives within Docker for Windows
Ubuntu 18.04
Docker and Docker-Compose
Make docker work without sudo on Linux
Git
Installing QATrack+
Changing to the directory where all server files will be stored
Downloading
Installation
Setting up copying backups from local machine to remote server on Windows
Advanced usage tips
Accessing the Django shell
Making QATrack+ start on boot and run in the background
Setting up SSL
Changing from port 80 to a different port
Making the backup management store its files on a network share
Shutdown the server
Update server
Backup management
Delete docker data
Configuring your QATrack+ Instance
Configuring a QATrack+ Installation
QATrack+ Local Settings
After configuration changes
Restarting QATrack+ on Linux
Restarting QATrack+ on Windows
Mandatory Settings
DEBUG Setting
Allowed Host Setting
HTTP or HTTPS Setting
DATABASES Setting
Cache Settings
Time Zone Settings
Icon Settings
Tolerance Naming Settings
Other Settings
ACCOUNTS_SELF_REGISTER
ACCOUNTS_CLEAN_USERNAME
CHROME_PATH
CATEGORY_FIRST_OF_GROUP_ONLY
COMPOSITE_AUTO_FORMAT
CONSTANT_PRECISION (deprecated. Use DEFAULT_NUMBER_FORMAT instead)
DEFAULT_NUMBER_FORMAT
DEFAULT_WARNING_MESSAGE
FORCE_SCRIPT_NAME, LOGIN_REDIRECT_URL, LOGIN_URL, STATIC_URL, MEDIA_URL, UPLOADS_URL
MAX_TESTS_PER_TESTLIST
NHIST
ORDER_UNITS_BY
PING_INTERVAL_S
REVIEW_DIFF_COL
REVIEW_BULK
SL_ALLOW_BLANK_SERVICE_AREA
SL_ALLOW_BLANK_SERVICE_TYPE
TESTPACK_TIMEOUT
USE_SQL_REPORTS
USE_X_FORWARDED_HOST
SESSION Settings
Configuring Email for QATrack+
Admin Email
Email host settings
Notification specific settings
Email & Subject templates
Active Directory Settings
AUTHENTICATION_BACKENDS
General AD Settings
Non-SSL AD Connection Settings
SSL AD Connection Settings
Authentication Backends
Active Directory
Installation of python-ldap
Windows
Linux
Configuring QATrack+ to use your Active Directory Server
Active Directory Federation Services (ADFS)
Configuring your ADFS Server
Configuring ADFS 2016 (ADFS 4.0)
Adding an ADFS Application Group
Add New Application Group
Set Client Identifier & Redirect URI
Configuring ADFS 2012 (ADFS 3.0)
Adding an ADFS Relying Party Trust
Configuring QATrack+ to use ADFS
Mapping Active Directory Groups to QATrack+ Groups
Backing up QATrack+
Backing up QATrack+ on Linux
Backing up QATrack+ on Windows
Using Django to Dump The Database To JSON
Dumping your database
Loading your database
Administrators Guide
Introduction
Accessing the admin site
Initial Configuration
Admin Guide Contents
Changing The Site Name Displayed at the Top of Pages
Managing Users and Groups
User Groups
Active Directory Group to QATrack+ Groups Map
Qualifying Groups for Membership
Users
Creating a new user
Permissions
Minimal set of permissions
Permissions for performing and viewing test history
Fairly complete set of permissions
Email Notifications
Configuring Notifications
Recipient Groups
Unit Groups
Test List Groups
Part Category Groups
QC Completed Notices
QC Review Notices
QC Scheduling Notices
Service Event Notices
Service Event Scheduling Notices
Service Event Review Notices
Part Notices
Fault Logged Notices
Fault Review Notices
Editing a Notification
Deleting a Notification
Units
Creating A New Unit
Defining a treatment or imaging modality
Defining a new unit class
Defining a new unit type
Defining a Site
Defining a new unit
Tests and Other QC
Test Categories
Frequencies & Scheduling
How Frequencies work
Due Dates in the User Interface
Example Frequencies
Test Statuses
Tests
Name
Display Name (Optional)
Macro Name
Description
Procedure
Category
Type
Choices (multiple choice test type only)
Constant Value (constant test type only)
Hidden (composite & constant test types only)
Display image (upload test types only)
Test Item Visible In Charts
Auto Review Rules
Skip Without Comment
Require Comment
Calculation Procedure
Formatting
Attachments
Tests with Calculated Results
Composite Tests
The composite calculation environment
Composite tests made up of other composite tests
A note about division for people familiar with Python
String Composite/JSON Tests
Upload Tests
Example Text File Upload
Example Binary File Upload
Setting Default Initial Values for Non-Calculated Tests
Configuring Test Lists
Name
Slug
Description
Warning Message
Javascript
Test List Members
Reordering Tests and Sublists within a Test List
Attachments
Configuring Test List Cycles
Creating a new Test List Cycle
Name
Slug
Description
Drop Down Label
Day Option Text
Test list cycle memberships
Removing a list from a test list cycle
Attachments
Assigning A Test List Or Test List Cycle To A Unit
Unit
Frequency
Due Date & Auto Schedule
Assigned To
Visible To
Active
Test List or Test List Cycle
Tests collection
An example
Test Tolerances
Creating a new tolerance
Editing a tolerance after it has been created
Numerical Tolerances
Multiple Choice Tolerances
Setting Reference & Tolerance Values
Numerical References & Tolerances
Boolean References
Multiple Choice References
History
Setting multiple References & Tolerances at the same time
Copying References & Tolerances between units
Managing Users and Groups
User Groups
Active Directory Group to QATrack+ Groups Map
Qualifying Groups for Membership
Users
Creating a new user
Permissions
Minimal set of permissions
Permissions for performing and viewing test history
Fairly complete set of permissions
Adding Contacts
Auto Review
Auto Review Rule Sets
Email notifications
Configuring Auto-Schedule for all currently assigned test lists
Test Packs (Experimental feature)
Exporting a test pack
Importing a test pack
Initial Configuration
Admin Tutorials
Service Log & Parts
Group Linkers
Service Areas
Associating Service Areas with Units
Service Event Statuses
Examples
Service Types
Service Event Templates & Schedules
Service Event Templates
Service Event Schedules
Unit Service Area
Frequency
Due Date & Auto Schedule
Assigned To
Visible To
Active
Configuring the Parts App
Parts Categories
Parts Rooms
Parts Suppliers
Adding new Parts
Initial Configuration
Fault Log Administration
Fault Types
Faults
Fault Review Groups
Users Guide
Managing Users and Groups
Accessing the Groups & Permissions Page
Adding a new group
Editing Group Name and Members
Changing Group Permissions
Performing and reviewing QC
Performing a Test List
Selecting a test list
Tree Views
Performing a test list
Viewing test procedures
Adding comments
Skipping a test
Performing a subset of a test list
Attaching Files to your session
Keyboard Shortcuts
Saving a test list to complete it later
Auto Save
Test List Cycles
Manually Choosing A Test List From A Test List Cycle
Viewing The History Of A Test List
Editing Previously Entered Data
Review and Approval of Test List Instances
Reviewing QC Data
Changing the status of test data
Bulk Review of Test List Instances
Deleting A QC Session (Test List Instance)
Overseeing The State Of Your QC Program
Viewing Test Lists Which are Coming Due Soon
Overview of All Units
Plotting your data
Notes on Control Charts
Service Log and Parts Apps
Using Service Log
Service Events
Initiating a new Service Event
Enter a new Service Event
Initiating a Service Event from A Test List
Initiating a Service Event from A Test List Instance
Using a Service Event Template
Performing a Scheduled Service Event
Service Log Dashboard
Return To Service QC
Reviewing Service Events
Service and Lost Time Report
Using the Parts App
Adding Parts To Your Inventory
Editing Existing Parts
Low Inventory Report
A Complete Service Log Example
Scenario
Resolution
After The Adjustment
Reviewing The RTSQC and Service Event
Machine Fault Log
Entering a new fault
Entering a new fault while performing QC
Reviewing Faults
Fault Notifications
Units
Setting Unit Available Time
1. Modifying available times for specific days
2. Modify available times for all days after a specfic day
Deleting a schedule modification
Reporting & SQL Queries
Reports
Permissions Required
Available Report Types
Creating a New Report
Report Filters
Adding Notes to Reports
Previewing, Saving, or Downloading a Report
Loading a Saved Report
Scheduling a Report
Editing or Clearing the Schedule and/or recipients for a Report
Deleting a Saved Report
Report Type Descriptions & Options
QC
QC Assignment Summary
QC Assignment Details
Test List Instance Summary (formerly QC Performed Summary)
Test List Instance Details
Test Instance Details
QC Backup Forms
QC Paper Backup Forms
Scheduling
Next Due Dates for QC
Due and Overdue
Service Log
Service Event Summary
Service Event Details
Service Event Personnel Summary
Service Log Assignment Summary
Service Event Times
Service Event Scheduling
Next Due Dates for Scheduled Service Events
Due and Overdue Scheduled Service Events
Query Tool
Permissions Required
Creating a new Query
Adding parameters
Exporting the query
Viewing the DB Schema
Pivot Tables
Deleting a Query
Using the QATrack+ API
Getting an API Token
Viewing the API online
Retrieving Data
Getting a list of available units
Getting a specific units details
Getting a list of Test Lists
Getting a specific test lists details
Pagination of data
Filtering and Ordering data
Uploading Data
Performing A Test List Cycle
Upload test types
Attachments
Preventing Duplicate Entries with the user_key field
FAQ
API Tutorial Example
Developers Guide
Developers Guide
QATrack+ v0.3.0 Database Schema
Generating the schema diagram
Ubuntu
Windows
Schema for Older Versions
Installing QATrack+ For Development
Python 3.6+
Git
GitHub
Creating a fork of QATrack+
Cloning your fork to your local system
Setting up your development environment
Creating your development database
Running the development server
Next Steps
QATrack+ Development Guidelines
Internationalization & Translation
Tool Tips And User Hints
Formatting & Style Guide
General formatting
Import Order
Indentation
Running The Test Suite
Writing Documentation
Copyright & Licensing
I’m not a developer, how can I help out?
Tutorials
Setting up, performing, and reviewing your first test list step-by-step
Logging in and accessing the admin interface
Setting up the name of your QATrack+ website
Creating a new Unit
Creating a New User Group
Creating Test Statuses
Creating a new Test List
Creating the required Tests
Creating the Test List
Assigning the test list
Performing the Test List
Reviewing the Data
Wrapping Up
Visualizing Data with Composite Tests
Configuring the Tests
Settting up the Test List
Assigning the Test List to a Unit
Performing the Test List
Image Analysis Using pylinac and the QATrack+ API
Setting up the Test List
Performing the Test List via the web UI
Performing the Test List via the API
Obtain an API token
Find the Unit Test Collection we want to perform
Acknowledgements
A Complete Service Log Example
Scenario
Resolution
After The Adjustment
Reviewing The RTSQC and Service Event
Screenshots
QATrack+
Docs
»
Users Guide
»
Performing and reviewing QC
Edit on GitHub
Performing and reviewing QC
¶
Contents:
Performing a Test List
Selecting a test list
Performing a test list
Test List Cycles
Manually Choosing A Test List From A Test List Cycle
Viewing The History Of A Test List
Editing Previously Entered Data
Review and Approval of Test List Instances
Reviewing QC Data
Changing the status of test data
Bulk Review of Test List Instances
Deleting A QC Session (Test List Instance)
Overseeing The State Of Your QC Program
Viewing Test Lists Which are Coming Due Soon
Overview of All Units
Plotting your data
Notes on Control Charts
Read the Docs
v: stable
Versions
stable
3.1.1
v3.1.0rc3
0.3.1
v0.3.0.20
Downloads
html
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.