Getting Started Guide

Table of Contents

Typographical Conventions
Acronyms and Abbreviations
1. Introduction
Foreword
About This Document
Contacting Squoring Technologies Product Support
Responsabilities
Getting the Latest Version of this Manual
2. The Tools at Your Disposal
Default Users and Sample Projects
Getting More Help
Online Help
User Guides and Support Wiki
Review Log Files and Download Debug Data
3. Accessing Squore
Understanding Profiles and Roles
User Profiles
User Roles
How Do I log into Squore?
Where Do I Go From Here?
How Do I log out of Squore?
Can I Tweak the Squore Look and Feel?
Using a Different Theme
User Interface Language
4. Creating Projects and Versions
How Do I Create a Project in Squore?
Creating Version 2 of My Project
Working with Draft and Baseline Versions
Drafts and Baseline: The Basic Concepts
Baselining at Version Creation
Baselining After Review
Handling Manual Modifications
Can I Make Changes to My Project?
Can I Create a Project Via the Command Line?
How Do I Connect Squore to My Continuous Integration System?
Can Squore Pull Source From My Version Control System?
Can I Create Projects with Sources From Multiple Locations?
Where Are My Analysis Results?
The Tree Pane
The Dashboards
Creating Meta-Projects
5. Understanding Analysis Results
Has the Quality of My Project Decreased Since the Previous Analysis?
Finding Artefacts Using Filters and Search
Advanced Filtering
Finding Artefacts Using Highlights
Creating Highlight Categories
How Do I Find and Keep Track of Artefacts?
How can I Understand and Enhance My Model?
Viewer
Validator
Dashboard Editor
Analysis Model Editor
Using Ruleset Templates
Managing Ruleset Templates
Reviewing Multiple Projects
6. Managing Your To-Do List With Squore
How do I understand and Improve My Ratings?
Relaxing Findings
Relaxing Violations in Code
Suspicious Findings
Relaxing and Excluding Artefacts
Adding Findings Manually
Working with Forms and Checklists
What Does This Measure Mean Exactly?
How Do I Review And Manage Action Items Flagged by Squore?
Can I Perform Advanced Data Mining?
7. Going Beyond Source Code
Test Management
Ticket Management
8. Track Your Favourite Indicators
Building a cross-project Dashboard in Favourites
Managing Favourites
Squore Mobile
9. Focus on Your Milestones
Setting up Goals
Milestones on your Dashboard
10. Communicating With Squore
Comments and Notifications
Commenting Charts
Commenting Action Items
Commenting Findings
Commenting From the Artefact Tree
Following Discussions
Linking to Projects
Adding and Removing Artefacts Manually
Reporting Project Status
Providing Access to Collaborators
Finding Other Projects
E-mail Notifications
Usage Statistics
Statistics for Project Managers
Statistics for Model Developers
11. Keep it Tidy: Project Maintenance in Squore
Managing Previous Analyses
Deleting a Project
Squore Server Administration
What About Server Maintenance?
12. Repository Connectors
Folder Path
Description
Usage
Zip Upload
Description
Usage
CVS
Description
Usage
ClearCase
Description
Usage
Perforce
Description
Usage
Git
Description
Usage
PTC Integrity
Description
Usage
TFS
Description
Usage
Synergy
Description
Usage
SVN
Description
Usage
Folder (use GNATHub)
Description
Usage
Using Multiple Nodes
13. Data Providers
AntiC
Description
Usage
Automotive Coverage Import
Description
Usage
Automotive Tag Import
Description
Usage
BullseyeCoverage Code Coverage Analyzer
Description
Usage
CPD
Description
Usage
Cppcheck
Description
Usage
Cppcheck (plugin)
Description
Usage
CPPTest
Description
Usage
Cantata
Description
Usage
CheckStyle
Description
Usage
CheckStyle (plugin)
Description
Usage
CheckStyle for SQALE (plugin)
Description
Usage
Cobertura format
Description
Usage
CodeSonar
Description
Usage
Compiler
Description
Usage
Coverity
Description
Usage
ESLint
Description
Usage
FindBugs
Description
Usage
FindBugs (plugin)
Description
Usage
Function Relaxer
Description
Usage
FxCop
Description
Usage
GCov
Description
Usage
GNATcheck
Description
Usage
GNATCompiler
Description
Usage
JSHint
Description
Usage
JUnit Format
Description
Usage
JaCoCo
Description
Usage
Klocwork
Description
Usage
Rational Logiscope
Description
Usage
MSTest
Description
Usage
MemUsage
Description
Usage
NCover
Description
Usage
Oracle PLSQL compiler Warning checker
Description
Usage
MISRA Rule Checking using PC-lint
Description
Usage
PMD
Description
Usage
PMD (plugin)
Description
Usage
Polyspace
Description
Usage
MISRA Rule Checking with QAC
Description
Usage
Unit Test Status from Rational Test RealTime
Description
Usage
ReqIF
Description
Usage
SQL Code Guard
Description
Usage
Squan Sources
Description
Usage
Squore Import
Description
Usage
Squore Virtual Project
Description
Usage
StyleCop
Description
Usage
StyleCop (plugin)
Description
Usage
Tessy
Description
Usage
VectorCAST
Description
Usage
CodeSniffer
Description
Usage
Configuration Checker
Description
Usage
Csv Coverage Import
Description
Usage
CSV Findings
Description
Usage
CSV Import
Description
Usage
Csv Tag Import
Description
Usage
CPU Data Import
Description
Usage
Memory Data Import
Description
Usage
Stack Data Import
Description
Usage
Ticket Data Import
Description
Usage
Jira
Description
Usage
Mantis
Description
Usage
OSLC
Description
Usage
pep8
Description
Usage
pycodestyle / pep8 (plugin)
Description
Usage
PHP Code Coverage
Description
Usage
pylint
Description
Usage
pylint (plugin)
Description
Usage
Qac_8_2
Description
Usage
Qac_8_2 CERT Import
Description
Usage
SonarQube
Description
Usage
Adding More Languages to Squan Sources
Advanced COBOL Parsing
Using Data Provider Input Files From Version Control
Providing a catalog file to a Data Provider for Offline XSL Transformations
Creating your own Data Providers and Repository Connectors
Data Provider Parameters
Localising your Data Provider
Running your Data Provider
Built-in Data Provider Frameworks
A. Data Provider Frameworks
Current Frameworks
csv_import Reference
xml Reference
Legacy Frameworks
Csv Reference
csv_findings Reference
CsvPerl Reference
Generic Reference
GenericPerl Reference
FindingsPerl Reference
ExcelMetrics Reference
B. Squore XML Schemas
input-data-2.xsd
form.xsd
properties-1.2.xsd
config-1.3.xsd
analysis.xsd
decision.xsd
description.xsd
exports.xsd
highlights.xsd
properties.xsd
tutorials.xsd
wizards.xsd
C. Milestones Tutorial
Index