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 and Repository Connectors
Data Provider Parameters
Localising your Data Provider
Running your Data Provider
Built-in Data Provider Frameworks
3. Analysis Models
Understanding Analysis Models
Artefact Types
Measures
Rules
Overriding Default 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. Expression Syntax
Computation Syntax
Operands
Operators
Functions
Queries
Counting Artefacts
Mathematical Queries
Counting Rules and Rule Occurrences
6. Configuring Dashboards
Understanding Dashboards
Model/Group Dashboards
Artefact Type Dashboards
The Scorecard Area
Dashboard Templates
The Charts Area
7. Charts Reference
Choosing a Chart
Common Attributes for chart
Common Attributes for measure and indicator
Common Attributes for info
Filtering Artefacts in Distributed Charts
Working With Colours
Datasets and Renderers
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
Charts for Single-Version Data Visualisation
Artefact Pie
Artefact Series
Artefact Table
Artefact Time Series
Cell Artefact Table
Dial
Distribution Table
Histogram
Key Performance Indicator
Kiviat
Indicator
Optimised Bar
Optimised Pie
Pivot Table
Quadrant
Artefact Scrumboard
Simple Bar
Simple Pie
SQALE Pyramid
Stacked Bar Chart
Text Values
Treemap
X/Y-Cloud
Y-Cloud
Charts for Trend Visualisation
Temporal Evolution
Simple Temporal Evolution Stacked Bar Chart
Temporal Optimised Stacked Bar
Special Charts
Control Flow Chart
View Source Chart
8. Understanding Project Wizards
Wizard Contept
Attributes
Repository Connector Selection
Data Provider Selection
Project Selection in Meta-Projects
Source Code Configuration
Project Milestones
9. Configuring Reports
Report Configuration
Report Bundle
Defining Your Own Logo
Defining Roles and Artefact Types
Including Charts
Including Tables
Including measures, indicators and textual information
Including Action Items, Findings, Highlights and Artefacts
Including Information from Child Artefacts
Modifying The Report Template
10. Defining Exports
Supplied Export Scripts
Using Runtime Variables
11. Creating Custom Export Format for Action Items
12. Defining Highlights
Understanding Highlights
Highlights Syntax Reference
13. Building Tutorials
Getting Started
Tutorial Syntax Reference
help
phase
item
preAction
Element Selectors
14. UI Configuration Options
Explorer Tabs Settings
Customising the Help Menu
Hiding Certain Models From Squore
Ignoring Obsolescence
Hiding Specific Measures
Tweaking the Analysis Model Editor Screen
Sort Order for Action Items and Findings
Hide columns in Action Items and Findings
External Tools
Links to External Resources
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. External Tools Reference
Generic
D. Export Script Reference
sqexport.pl — Squore export utility
E. Milestones Tutorial
Index
Index of Functions
Index of Charts
Index of XML Elements
Index of XML Attributes

List of Tables

5.1. Operator Precedence
7.1. Charts for Single-Version Data Visualisation
7.2. Charts for Trend-Based Visualisation
7.3. Special Charts
13.1. Available element selectors for tutorials in Squore