Table of Contents

Preface

Intended audience

Using this manual

Where to go for more information

Questions or suggestions? Contact us

1 Understanding ClearDDTS Operation

What is ClearDDTS?

How defects are classified

Understanding the defect life cycle

Distributed operation

UNIX mail for flexible communication

How ClearDDTS handles its mail

Naming conventions

The ClearDDTS network

Communication between local and remote installations

Providing project subscriptions

When the mail system goes down

How information is stored

2 Using Administration Utilities

Basic ClearDDTS utilities

Using adminbug

Entering commands

Set up maintenance mode (smnt)

Exit maintenance mode (emnt)

Quit adminbug (quit)

More administrative utilities

ddtsclean

ddtsversion

newduser

patchbug

batchbug

projck

projstat

refreshbug

rdtest

rmbug

tmpltest

3 Maintaining the Network

Install machine on ClearDDTS network (inst)

Disable ClearDDTS machine (dsbl)

Modify ClearDDTS installation parameters (mins)

Build ClearDDTS database (dbms)

Change database (chdb)

Establish connection between sites (conn)

Remove connection between sites (dcon)

List other sites connected to this system (lsit)

List ClearDDTS administrator names (ladm)

Add licenses (alic)

4 Managing Remote Access Between Multiple Installations

How the import and export files are used

The export file

Examining a sample file

How the file is read

Further examples

Importance of project naming conventions

Applying changes to the export file

The import file

5 Maintaining Classes and Projects

Maintaining classes

Add a new class (clas)

Delete a class (dcls)

Rename a class (rcls)

Create a meta-class (meta)

Modify a meta-class (mmta)

Maintaining projects

Add a new project (aprj)

Close a project (cprj)

Delete a project and project data (dprj)

Open a closed project (oprj)

Modify project parameters (mprj)

Broadcast project parameters (bprj)

Save a project (sprj)

Restore a project (rprj)

Rename a project (renm)

Ask to subscribe to a project (asub)

Delete subscription to a project (dsub)

Modify subscription parameters (msub)

List all project parameters (lprj)

List project names and descriptions (lbug)

List projects owned on this machine (lown)

List projects being subscribed to on this machine (lsub)

6 Reconfiguring a ClearDDTS Network

Moving a project

Physically moving the machine to a new location

If e-mail addresses are not valid after moving

If e-mail addresses are still valid

Checking addresses after the move

Moving the ClearDDTS database

7 Understanding the Master Template File

Example master.tmpl file

Understanding the "Begin" field derivation section

Other field derivations

Understanding OPERATION and STATE

How OPERATION and STATE are used

Most common derivation

A closer look at derivation lines

Setting default values

How webddts pages are generated

Web page generation-the big picture

Updating the database

Restrictions-what is not interpreted

8 Customizing ClearDDTS

Before making changes

Locating files to customize

Adding new fields

Adding defect states

Editing the state names file (statenames)

Editing the state transitions file (states)

Editing the master template file (master.tmpl)

Editing administrative template files

Modifying the information in a query index

Editing the three-line summary template file

Changing the reporting system for new states

Further template customization

Creating field dependencies

Prompting for and requiring enclosures

Customizing enclosures, prompts, and e-mail

Creating custom filter commands

Specific webddts customizations

Label and type modification via the "www" filter

Web layout using field grouping

Web display options via the web_conf file

Maintaining the cache directory

Specific xddts customizations

Adding new pages

Debugging a custom template file

Setting up a dummy class

Testing a template file

9 Creating Custom ClearDDTS Reports

Understanding how reports work

The report_conf file

Report scripts

xddts

webddts

Creating Reports

Integrating a report into the xddts and webddts interfaces

10 Customizing Link Actions

What is defect linking?

Configuring links

Defining link actions

11 Handling ClearDDTS Mail

Why use electronic mail?

How ClearDDTS handles mail

Types of ClearDDTS mail

Looking at an example

Determining who receives mail

Notification list

Customizing notification mail

Mail Domain

Debugging Tool

Notification Options

Mail for changed sites

Sending mail to ClearDDTS

12 Managing ClearDDTS Security

HTTP (web) security

Identifying the user

What happens when HTTP security is not implemented

Controlling access to web pages

Controlling access to data across the network

Monitoring access to webddts pages

Write access control

Read access control

Per-project read access control (adminbug)

Per-defect read access control

xddts specific security

Controlling field access by customizing the master.tmpl file

Field read access control

13 Managing and Customizing the ClearDDTS Database

How information is posted to the database

Backing up and restoring the database

Reviewing the database schema

Modifying the database

Editing the schema file

Editing the database configuration file

Rebuilding the database

14 Using the ClearDDTS SQL Interface

Learning SQL

Starting the SQL command line interface

Writing Queries

Using dates with the Oracle database

Formatting query output

Using SQL in a Script

Retrieving Information from Multiple Tables

ClearDDTS and standard SQL

Date conversion

Aggregate comparisons

Table and column aliases

Supported SQL statements

Unsupported SQL statements

Recommended reading

15 Creating a Change Management System

Understanding Release/Configuration Problems

Providing an Integrated Solution

Version Control Integration

Configuration Integration

Process Integration

Setting Up ClearDDTS for Change Management

Providing Access Control

Installing CMCS

A Closer Look at CM Scripts and Utilities

The cm.tty.sh Script

CM Macro Files

The cmsetuser Utility

Convenience Shell Scripts

CM Access Control Process

How ClearDDTS Supports Roles

A Contents of a Defect Record

Sample file

Field descriptions

Fields required by ClearDDTS utilities

Fields with special significance

B Converting to ClearDDTS

Ensuring a successful conversion

Identifying your projects

Creating projects and classes

Creating ClearDDTS defect records

Format of a ClearDDTS record

Filling in some special fields

Assigning states to defects

Running the conversion utility

Incorporating defects into the database

C Sample Filter Command Script

Script example

D E-mail Submission API

E Creating Graphs with Graphbug

Using Graphbug

Command line options

Description

Defining graph contents

Header section

Graph titles

Vertical axis

Horizontal axis

Graph types

Margin definitions

Legend parameters

Data section

Notes section

Graphbug configuration file

Color definitions

Textual notations

F Database Reference

Defect information table (defects)

Enclosures table (enclosures)

History table (change_history)

G Using an Oracle Database

Identifying the database vendor

Working with an ORACLE database

Creating tablespaces

Creating rollback segments

Creating database users

Creating tables

Searching enclosures

H Information Resources on the Web

HTTP servers

Apache

Netscape

General

FastCGI

HTML

CGI scripts