Configuration Guide

Table of Contents

1. Introduction
Foreword
About This Document
Contacting Squoring Technologies Product Support
Responsabilities
Getting the Latest Version of this Manual
2. The Squore Configuration
Understanding the Squore Configuration
Default Models and the Shared Folder
Customising the Squore Configuration
Creating a New Model
Building your Model
Bundle Files
Descriptions
Overriding Default Descriptions
Creating your own Data Providers
Choosing the Right Data Provider Framework
Extending a Framework
Data Provider Parameters
Localising your Data Provider
3. Analysis Models
Understanding Analysis Models
Artefact Types
Measures
Rules
Scales
Indicators
Root Indicators
Configuring Artefact Relaxation
Artefact Links
Constants
Dynamic Scales
4. Decision Models
Understanding Decision Models
Dynamic Action Plans
Trigger-Based Action Plans
5. Computation Syntax
Operands
Simple Calculation Syntax
Functions
Mathematical Functions
Conditional and Level-Related Functions
Temporal Functions
Date Functions
Milestone Functions
String Matching Functions
Queries
Computing Values
Query Scope
Query Conditions
Examples
6. Configuring Dashboards
Understanding Dashboards
Analysis Model Dashboards
Artefact Type Dashboards
The Scorecard Area
Dashboard Templates
The Charts Area
7. Charts Reference
Common Attributes for chart
Common Attributes for measure and indicator
Working With Colours
Datasets
Using Tooltips
Using Markers
Parameters for Temporal Charts
Time Axis Configuration
Displaying Planned Versions
Working with Goals
Displaying Data From Milestones
Displaying Goals
Displaying Goal History
Displaying Milestone Date Changes
Milestone-Based Markers
Using Textual Information From Artefacts
Charts for Single-Version Data Visualisation
Optimised Pie Chart
Optimised Bar Chart
Key Performance Indicator
Dial Chart
Meter Chart
Kiviat Chart
SQALE Pyramid Chart
Histogram Chart
Y-Cloud Chart
Treemap
Artefact Pie
X/Y-Cloud Chart
The Quadrant Chart
Simple Pie Chart
Simple Bar Chart
Stacked Bar Chart
Artefact Series
Charts for Trend Visualisation
Temporal Evolution Chart
Temporal Optimised Stacked Bar Chart
Temporal Evolution Line Chart Including Goal
Temporal Evolution Bar Chart Including Goal
Simple Temporal Evolution Stacked Bar Chart
Table Charts
Artefact Table
Distribution Table
Special Charts
Control Flow Chart
Source Code Viewer
Scrum Board
8. Project Wizards
Understanding Wizards
Attributes
Repository Connector Selection
Data Provider Selection
Project Selection in Meta-Projects
Source Code Configuration
Project Milestones
9. Configuring Reports and Exports
Configuring Reports
Understanding Reports
Template Files
Defining Your Own Logo
Defining Roles and Artefact Types
Including Charts
Including Tables
Including Action Items, Findings, Highlights and Artefacts
Configuring Exports
Supplied Export Scripts
Using Runtime Variables
10. Custom Export Formats
Creating Custom Export Format for Action Items
11. Defining Highlights
Understanding Highlights
Highlights Syntax Reference
12. Tutorials
Getting Started
Tutorial Syntax Reference
help
phase
item
preAction
Element Selectors
13. UI Configuration Options
Explorer Tabs Settings
Customising the Help Menu
Hiding Certain Models From Squore
Ignoring Obsolescence
Hiding Specific Measures
Hiding Filters on the Findings Tab
Tweaking the Analysis Model Editor Screen
Sort Order for Action Items and Findings
Hide columns in Action Items and Findings
Advanced Finding Filtering
External Tools
Links to External Resources
14. References
External References
A. Data Provider Frameworks
Csv Reference
csv_findings Reference
CsvPerl Reference
Generic Reference
GenericPerl Reference
FindingsPerl Reference
ExcelMetrics Reference
B. External Tools Reference
Generic
C. Export Script Reference
sqexport.pl — Squore export utility
D. Milestones Tutorial
Index
Index of Functions
Index of Charts
Index of XML Elements
Index of XML Attributes

List of Tables

6.1. Charts for Single-Version Data Visualisation
6.2. Charts for Trend-Based Visualisation
6.3. Table Charts
6.4. Special Charts
12.1. Available element selectors for tutorials in Squore