Workflow Extensions User Guide

Workflow Extensions User Guide

Introduction

Contacting Support

StarTeam Workflow Extensions Features

StarTeam Extensions

StarTeam Workflow Designer

StarTeam Notification Agent

Repository Customization

Workflow Roadmap

Using StarTeam Extensions

Creating and Configuring the StarFlow Extensions Project

Creating StarFlow Extensions Projects

Adding Access to a Server Configuration

Adding Files to the StarFlow Extensions Project

Understanding Locator

Adding Folders to the StarFlow Extensions Project

Setting Access Rights

Creating and Deploying APEs

Using Modal or Embedded APEs

Understanding Property Editors

Sample Change Request APEs

Sample LayoutDesigner APE

Sample Requirement APEs

Configuring JBuilder to use StarTeam JavaBeans

Using JBuilder Personal Edition

Editing StarTeam APEs

Configuring StarTeam Projects to Use APEs

Using the propertyeditor.xml File

Using a Property Other Than Usr_StarFlowStatus

Using the Form Server

Using the Custom Toolbar

Using the JavaBeans in guicomponents.jar

Subclassing the ItemWrapper Class

Using the StarTeam Workflow Designer

Planning a Workflow

General Workflow Information

Understanding Steps

Understanding Links

Starting Workflow Designer

Using the Menu

Displaying a Workflow in the Workspace

Creating a Workflow

Understanding the "0. Entered" Entry Step

Opening a Workflow Stored in a Server Configuration

Importing a Workflow File

Viewing and Editing Workflow Properties

Creating and Linking Steps

Creating Steps

To Create All Steps at Once

To Create One Step at a Time

Linking Two Steps Manually

Creating and Linking Steps Automatically

Conditionally Linking Steps

Displaying Link Conditions as Text

Repositioning Links

Changing the Default Link Colors

Changing the Color of Individual Links

Controlling the Contents of the APE Form

Controlling What Properties the Form Displays

Controlling Dynamic Changes to Forms

Limiting the Users Listed in a User Selection Field

Controlling the Behavior of an Item in a Step

Listing the Participants

Specifying a Notification Message and Interval

Understanding Notification List Operation

Limiting the Time Allowed to Complete the Task

Specifying an Initial Value for an Empty Text Field

Monitoring an Item’s Status

Managing Exceptions

Extending the Workflow’s XML

Adding and Modifying Custom Properties

Creating an Enumerated Property

Adding a Value to an Enumerated Property

Changing the Name of a Step

Checking for Errors

Saving and Exporting Workflows

Saving a New Revision of an Existing Workflow

Saving a Workflow to a New Location

Disabling a Workflow

Exporting a Workflow

Changing Workflow Control Property Values Automatically

Walking Through a Workflow

Workflow Roadmap

Setting Up Projects and Files

Setting Up Users and Groups

Understanding the Example Use Case

Deciding Which Properties to Use

Numbering the Example Steps

Creating a Custom Property to be the Workflow Control Property

Creating the Custom APE Form

Creating a Workflow

Creating the Steps and Links

Drawing the 1. New Step

Linking the Two Steps Manually

Editing the 0. Entered Step

To Edit the Step

Editing the 1. New Step

Creating Next Steps for 1. New

Drawing the Rest of the Steps

Summary of Other Step Properties

2. PM Evaluation

3. EM Processing

4a. R and D Implementation

4b. Maintenance Fix

6a. Not Implemented

7. Customer Letter

Testing the Workflow

Deploying the Workflow

Using StarTeam Notification Agent

Getting Ready to Use StarTeam Notification Agent

Setting Access Rights for StarTeam Notification Agent

Starting StarTeam Notification Agent and Notification Setup

Identifying a Server Configuration

Setting Up StarTeam Notification Agent to Monitor a Server Configuration

Running StarTeam Notification Agent

Running StarTeam Notification Agent Manually

Running StarTeam Notification Agent as a Service

Changing the Http Server Port Number

Message Sending and Exception Processing

Files Created by StarTeam Notification Agent

StarTeam Extensions Samples

Sample Workflows

Notification Tags and Messages

Tag Syntax Overview

Tag Reference

{{part-boundary}}

{{project-name}}

{{property-style}}

{{property-table}}

{{request-timing}}

{{responsibility-assignment}}

{{step-timing}}

Default Notification Messages

Status Notification Message

Responsibility Request Message

Confirmation Messages

Request Exception Message

Step Exception Message