wfm_1001_user_v01_en

Interwoven®

Workflow ModelerUser’s GuideRelease 1.0.0.1

© 2006-2007 Interwoven, Inc. All rights reserved.

No part of this publication (hardcopy or electronic form) may be reproduced or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of Interwoven. Information in this manual is furnished under license by Interwoven, Inc. and may only be used in accordance with the terms of the license agreement. If this software or documentation directs you to copy materials, you must first have permission from the copyright owner of the materials to avoid violating the law which could result in damages or other remedies.

Interwoven, ConfirmSite, ContentServices, ControlHub, DataDeploy, DeskSite, FileSite, iManage, LiveSite, MediaBin, MetaCode, MetaTagger, OffSite, OpenDeploy, Primera, Scrittura, TeamPortal, TeamSite, VisualAnnotate, WorkDocs, WorkPortal, WorkRoute, WorkSite, WorkTeam, the respective taglines, logos and service marks are trademarks of Interwoven, Inc., which may be registered in certain jurisdictions. All other trademarks are owned by their respective owners. Some or all of the information contained herein may be protected by patent numbers: US # 6,505,212, GBRI # 1053523, US # 6,480,944, US# 5,845,270, US #5,430,812, US #5,754,704, US #5,347,600, AUS #735365, AU 7830068, GB #GB2333619, US #5,845,067, US #6,675,299, US #5,835,037, AUS #632333, CAN #2,062,965, FRAN / GRBI / SPAI / SWED #480941, GERM #69020564.3, KORS 10-0576487, JAPA #2968582, MX #219522, NZ #516340, SING #109524, SG #89006, SG #89086, SG #74973, SG #85502 US #5,065,447, US #6,609,184, US #6,141,017, US #5,990,950, US #5,821,999, US #5,805,217, US #5,838,832, US #5,867,221, US #5,923,376, US #6,434,273, US #5,867,603, US #4,941,193, US #5,822,721, US #5,923,785, US #5,982,938, US #5,790,131, US #5,721,543, US #5,982,441, US #5,857,036, US #6,697,532, US #6,792, 454, US #6,928,149, US #7,092,969 or other patents pending application for Interwoven, Inc.

Interwoven, Inc.160 East Tasman DriveSan Jose, CA 95134

http://www.interwoven.comPrinted in the United States of America

Interwoven Workflow Modeler User’s GuidePart 14-001-01-ENAugust 2007

Table of Contents

List of Tables 9List of Figures 11About This Guide 13

Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13Notation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13Manual Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14New or Changed Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Chapter 1: Introduction 17Workflow Lifecycle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17Workflow Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Workflow Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

Creating Workflow Models with Interwoven Workflow Modeler . . . . . . . . . . . . . . .20Adding Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20Assigning Element Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21Publishing Workflow Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

TeamSite and Workflow Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Chapter 2: Installing the Interwoven Workflow Modeler 23System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23Installing the Interwoven Workflow Modeler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23Post-Installation Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27Uninstalling the Interwoven Workflow Modeler . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Chapter 3: Using the Interwoven Workflow Modeler 31Starting the Interwoven Workflow Modeler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31Interwoven Workflow Modeler GUI Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

Standard Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34Links Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34Tasks Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36Display Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37Options Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Configuring Application Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40Project Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43Tree Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44Properties Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45Overview Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46Errors Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Creating a New Workflow Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49Editing an Existing Workflow Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51Publishing Workflow Models to TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52Retrieving Workflow Models from TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

Interwoven Workflow Modeler User’s Guide 3

Contents

Upgrading to the Latest Workflow Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

Chapter 4: Working with Element Attributes 57Interwoven Workflow Modeler Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57

Configurable Variables ($IW_CV). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58Datasource Variables ($IW_DS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60Script Variables ($IW_SCRIPT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62TeamSite System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65TeamSite Macro Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65Variable Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

Local Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

Assigning Common Task Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67Area V Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68Brief Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69Owner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70Read Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70Transfer Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71EA Finish Op . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72EA Start Op . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73WF Variables Finish Op . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74WF Variables Start Op . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76Y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

Assigning Workflow-Specific Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78Assigning Task-Specific Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82

CGI Task Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83Deploy Task Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83Email Task Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85External Task Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88Group Task Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89Metadata Task Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90Nested Workflow Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90Review Task Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91Submit Task Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93Update Task Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94URL Task Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95

Assigning Common Link Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96

Assigning Link-Specific Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96Timeout Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96Conditional Links. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98

Working with Logical Nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98

Interwoven, Inc. 4

Contents

Logical Node Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99GatewayType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99Y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100

Chapter 5: Predefined Workflow Models 101Author Submit with Deploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102Author Submit with Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103Author Submit with Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104Configurable Author Assignment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105Configurable Author Submit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106Configurable Default Submit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107

Configurable Workflow Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107Workflow-Specific Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108

Workflow.cfg File Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108configurable_author_submit_config.xml . . . . . . . . . . . . . . . . . . . . . . . . . . .108configurable_default_submit_config.xml . . . . . . . . . . . . . . . . . . . . . . . . . . .108configurable_author_assignment_config.xml . . . . . . . . . . . . . . . . . . . . . . . .108

VisualAnnotate and Configurable Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108

Chapter 6: Managing and Configuring Workflow Models 111Understanding Workflow Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

WorkflowUser Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111WorkflowAdmin Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112Operations Summary for Workflow Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113

Published Workflow Models in TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113WorkflowModels Branch Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

Managing Workflow Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116The available_models.xml File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116

Specifying Workflow Model Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117Combining Access Categories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120

Managing Workflow Models Using the Administration Tab . . . . . . . . . . . . . . .122Managing Workflow Models Using the Content Tab . . . . . . . . . . . . . . . . . . . . .123

Configuring Workflow Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123Configuring Workflow Models Using the Administration Tab. . . . . . . . . . . . . .123Configuring Workflow Models Using the Content Tab . . . . . . . . . . . . . . . . . . .126Selection Order for Custom Workflow Configuration . . . . . . . . . . . . . . . . . . . .127Working with Outdated Custom Configurations . . . . . . . . . . . . . . . . . . . . . . . .127

Chapter 7: Instantiating Workflows 129Instantiating Workflows in ContentCenter Professional . . . . . . . . . . . . . . . . . . . . .129

Instantiating Workflow Models With the New Job Option. . . . . . . . . . . . . . . . .130Instantiating Workflow Models With the Submit Option . . . . . . . . . . . . . . . . . .132Instantiating Workflow Models With the Assign Option . . . . . . . . . . . . . . . . . .134

Viewing Workflow Models in ContentCenter Professional . . . . . . . . . . . . . . . . . . .136Viewing Workflow Models Before Instantiation . . . . . . . . . . . . . . . . . . . . . . . .136Viewing Workflow Models After Instantiation . . . . . . . . . . . . . . . . . . . . . . . . .137

Instantiating Workflow Models in ContentCenter Standard . . . . . . . . . . . . . . . . . .140Instantiating Workflow Models from the TeamSite Front Office . . . . . . . . . . . . . .142


Contents

Instantiating Workflow Models from the Command Line . . . . . . . . . . . . . . . . . . . .143Creating Custom Job Instantiation Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143

Selection Order for Custom Job Instantiation Form . . . . . . . . . . . . . . . . . . . . . .144

Chapter 8: Using Datasource Framework 145Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145Creating a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145

Implementing Datasource Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145SimpleDataSource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146ArrayDataSource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146Arguments for SimpleDataSource and ArrayDataSource . . . . . . . . . . . . . . .147ListDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147MapDataSource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147Arguments for ListDataSource and MapDataSource . . . . . . . . . . . . . . . .148

Registering a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148Deploying a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149

Using Datasources in Job Instantiation Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . .149Static Calls for Datasources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150

getDatasourceNames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150executeComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150An Example for Static Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151

Dynamic Calls for Datasources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152IWDatasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152IWMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153An Example for Dynamic Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154

Chapter 9: Using Custom Code 157Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157Creating Custom Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158

Implementing the InProcessJavaCommand Interface. . . . . . . . . . . . . . . . . . . . .158Additional Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159An Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159

Deploying Custom Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160

Appendix A: Interwoven Workflow Modeler Tutorial 163Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163Tutorial Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164

Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165Instantiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165

Creating a New Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166Variables Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168Specifying Workflow Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168Specifying Task Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170

Dummy Task (Dummy Task) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170Metadata Capture (Metadata Task) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170Submit (Submit Task) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171Deploy Task (Deploy Task) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172Notify Deploy (Email Task) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172

Specifying Link Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174Create Metadata (Conditional Link) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174

Interwoven, Inc. 6

Contents

No Metadata (Conditional Link) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174Submit After Timeout (Timeout Link) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175No Deploy (Conditional Link) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175Deploy Content (Conditional Link). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .176Notify (Conditional Link) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177Resolve Problems (Conditional Link) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178Other Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178

Saving Your Workflow Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178Publishing Your Workflow Model to TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . .179Testing Your Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180

Appendix B: Datasource Example 181Appendix C: Workflow Schemas 189

available_models.xsd (Subscription schema) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189DataSourceConfig.xsd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192

Appendix D: Troubleshooting 195Index 199


Contents

Interwoven, Inc. 8

List of Tables

Table 1 Notation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Table 2 Installation shortcut location options . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Table 3 Standard toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Table 4 Links toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Table 5 Tasks toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Table 6 Display toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Table 7 The Options menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Table 8 TeamSite System variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Table 9 TeamSite Macro variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Table 10 Workflow-specific attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Table 11 CGI task attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Table 12 Deploy task attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Table 13 Email task attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Table 14 External task attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Table 15 Group task attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Table 16 Metadata task attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Table 17 Nested Workflow task attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Table 18 Review task attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Table 19 Submit task attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Table 20 Update task attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Table 21 URL task attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Table 22 Operations summary for workflow roles . . . . . . . . . . . . . . . . . . . . . . . 113Table 23 Tutorial–list of workflow elements . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Table 24 Tutorial–Workflow attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Table 25 Tutorial–Dummy task attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Table 26 Tutorial–Metadata task attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Table 27 Tutorial–Submit task attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Table 28 Tutorial–Deploy task attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Table 29 Tutorial–Notify Deploy task attributes. . . . . . . . . . . . . . . . . . . . . . . . . 172Table 30 Tutorial–Create Metadata link attributes . . . . . . . . . . . . . . . . . . . . . . . 174Table 31 Tutorial–No Metadata link attributes . . . . . . . . . . . . . . . . . . . . . . . . . . 175Table 32 Tutorial–Submit After Timeout link attributes . . . . . . . . . . . . . . . . . . . 175Table 33 Tutorial–No Deploy link attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Table 34 Tutorial–Deploy Content link attributes. . . . . . . . . . . . . . . . . . . . . . . . 176Table 35 Tutorial–Notify link attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Table 36 Tutorial–Resolve Problems link attributes . . . . . . . . . . . . . . . . . . . . . . 178Table 37 Error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195


List of Tables

Interwoven, Inc. 10

List of Figures

Figure 1 Workflow model lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18Figure 2 Sample workflow model diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19Figure 3 Introduction screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24Figure 4 License Agreement screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24Figure 5 Product Files screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25Figure 6 Choose Shortcut Folder screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25Figure 7 Install Complete screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27Figure 8 Uninstallation program screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29Figure 9 Uninstall Complete screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29Figure 10 Login dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32Figure 11 Interwoven Workflow Modeler user interface (UI) . . . . . . . . . . . . . . . . . .33Figure 12 Options menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39Figure 13 Preference dialog box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40Figure 14 Preference dialog box - General node . . . . . . . . . . . . . . . . . . . . . . . . . . . .41Figure 15 Preference dialog box - Appearance node . . . . . . . . . . . . . . . . . . . . . . . . .42Figure 16 Preference dialog box - Shortcut Keys node . . . . . . . . . . . . . . . . . . . . . . .42Figure 17 Project pane with workflow model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43Figure 18 Tree pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44Figure 19 Properties pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45Figure 20 Overview pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46Figure 21 Errors pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48Figure 22 Errors pane details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48Figure 23 Project pane Title bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49Figure 24 Workflow model properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50Figure 25 Server Login dialog box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53Figure 26 Retrieve from Server dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54Figure 27 Configurable variable dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59Figure 28 User-defined configurable variable available for reuse . . . . . . . . . . . . . . .59Figure 29 Datasource variable dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61Figure 30 User-defined Datasource variable available for reuse . . . . . . . . . . . . . . . .61Figure 31 Script variable dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62Figure 32 User-defined Script variable available for reuse . . . . . . . . . . . . . . . . . . . .63Figure 33 Description dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69Figure 34 Variables dialog box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71Figure 35 EA Finish Op dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72Figure 36 EA Start Op dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73Figure 37 WF Variables Finish Op dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74Figure 38 WF Variables Start Op dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76Figure 39 Due Date dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78Figure 40 Global Variables dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79Figure 41 VA Variables dialog box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80Figure 42 PostProcessor dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81Figure 43 Deploy task–Variables dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84


List of Figures

Figure 44 OD Variables dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85Figure 45 Email task–Variables dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86Figure 46 Shared By dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89Figure 47 Reviewers dialog box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92Figure 48 Timeout Duration dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97Figure 49 AND node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99Figure 50 Diagram of the Author Submit with Deploy solution workflow . . . . . . .102Figure 51 Diagram of the Author Submit with Email solution workflow. . . . . . . . .103Figure 52 Diagram of the Author Submit with Metadata solution workflow . . . . . .104Figure 53 Diagram of the Configurable Author Assignment solution workflow . . .105Figure 54 Diagram of the Configurable Author Submit solution workflow . . . . . . .106Figure 55 Diagram of the Configurable Default Submit solution workflow . . . . . .107Figure 56 workflowModels branch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114Figure 57 Content tab of WorkflowModels branch . . . . . . . . . . . . . . . . . . . . . . . . .114Figure 58 Workflow model icon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115Figure 59 available_models.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122Figure 60 Subscribed workflow models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124Figure 61 Branch information in available_models.xml. . . . . . . . . . . . . . . . . . . . . .124Figure 62 Configure Workflow screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125Figure 63 Workflow Instantiation form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126Figure 64 Outdated Custom Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128Figure 65 New Job menu option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130Figure 66 Select a Workflow dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130Figure 67 Instantiate Workflow form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131Figure 68 Jobs listed on the Workflow tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132Figure 69 Submit menu option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132Figure 70 Select a Workflow dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133Figure 71 Instantiate Workflow form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133Figure 72 New job listed on the workflow tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134Figure 73 Assign menu option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134Figure 74 Select a Workflow dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135Figure 75 Select a Workflow dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135Figure 76 New job listed on the Workflow tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . .136Figure 77 Selected workflow model on the Content tab. . . . . . . . . . . . . . . . . . . . . .137Figure 78 Jobs and Tasks links on the Workflow tab . . . . . . . . . . . . . . . . . . . . . . . .138Figure 79 Viewing workflow instance – View Jobs . . . . . . . . . . . . . . . . . . . . . . . . .138Figure 80 Viewing workflow instance – Jobs Details. . . . . . . . . . . . . . . . . . . . . . . .138Figure 81 Web view of instantiated workflow model . . . . . . . . . . . . . . . . . . . . . . . .139Figure 82 New Job link in ContentCenter Standard . . . . . . . . . . . . . . . . . . . . . . . . .140Figure 83 Select A Workflow screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141Figure 84 Instantiate Workflow form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141Figure 85 Check In option in TeamSite Front Office . . . . . . . . . . . . . . . . . . . . . . . .142Figure 86 Custom code workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157Figure 87 Tutorial: Creating a new workflow model . . . . . . . . . . . . . . . . . . . . . . . .167

Interwoven, Inc. 12

About This Guide

Interwoven Workflow Modeler User’s Guide describes how to install Interwoven Workflow Modeler, how to use Interwoven Workflow Modeler, and how to troubleshoot Interwoven Workflow Modeler problems.

Intended AudienceThis guide is intended for workflow developers and administrators who create, implement, or maintain workflow models. Workflow administrators must be familiar with TeamSite Server administration, or work together with your organization’s TeamSite administrator.

Notation ConventionsThis manual uses the following notation conventions:

Table 1 Notation Conventions

Convention Definition and UsageBold Text that appears in a GUI element such as, a menu item, button, or

element of a dialog box, and command names are shown in bold. For example:Click Edit File in the Button Bar.

Italic Book titles appear in italics. Terms are italicized the first time they are introduced.Important information may be italicized for emphasis.

Monospace Commands, command-line output, and file names are in monospace type. For example:The iwextattr command-line tool allows you to set and look up extended attributes on a file.

Monospaced italic

Monospaced italics are used for command-line variables.For example:iwckrole role user

This means that you must replace role and user with your values.

Interwoven Workflow Modeler User’s Guide 13Interwoven Workflow Modeler User’s Guide 13

Chapter :

This guide also uses the following conventions:

The term “Windows” indicates any supported version of the Microsoft Windows operating system, such as Windows® 2000.

For TeamSite server, directory paths use UNIX conventions. These conventions mandate using forward slashes (/) in path names. (Windows systems use backward slashes.) The Windows convention is used when referring to a Windows-specific directory. For example: UNIX: docroot/news/front.html

Windows: docroot\news\front.html

Manual OrganizationThe following chapters are included in this manual:

Chapter 1, “Introduction.” Provides an introduction to the process and tools involved in planning, building, testing, and implementing a workflow model.

Chapter 2, “Installing the Interwoven Workflow Modeler.” Describes the system requirements and procedures for installing and uninstalling the Interwoven Workflow Modeler.

Chapter 3, “Using the Interwoven Workflow Modeler.” Provides an introduction to the Interwoven Workflow Modeler user interface (UI) including drawing tools, activity panes, toolbars and menus. It also describes the procedures for logging into, and publishing your workflow models to your TeamSite Server.

Chapter 4, “Working with Element Attributes.” Describes the attributes (also known as properties) that can be assigned for each type of workflow element (Tasks, Links,

Monospaced bold Monospaced bold represents information you enter in response to system prompts. The character that appears before a line of user input represents the command prompt, and should not be typed. For example:iwextattr -s project=proj1 //IWSERVER/default/main/dev/WORKAREA/andre/products/index.html

Monospaced bold italic

Monospaced bold italic text is used to indicate a variable in user input. For example:iwextattr -s project=projectname workareavpath

means that you must insert the values of projectname and workareavpath when you enter this command.

[] Square brackets surrounding a command-line argument mean that the argument is optional.

| Vertical bars separating command-line arguments mean that only one of the arguments can be used.

Table 1 Notation Conventions

Convention Definition and Usage

Interwoven, Inc. 14

Chapter :

and Nodes). Also describes the variable types (CONFIGURATION, SCRIPTING, DATASOURCE, and System) available in the Interwoven Workflow Modeler.

Chapter 5, “Predefined Workflow Models.” Describes the predefined workflow models that are installed with the Interwoven Workflow Modeler. You can use these workflow models in your production environment, or modify them to better fit your organization’s needs.

Chapter 6, “Managing and Configuring Workflow Models.” Describes the procedures for managing and configuring workflow models that have been published to your TeamSite server.

Chapter 7, “Instantiating Workflows.” Describes the procedure for instantiating workflow models in the TeamSite UI. Workflow models are typically instantiated as New Jobs, Submit and Assign operations, and other places within TeamSite.

Chapter 8, “Using Datasource Framework.” Provides an introduction to the Datasource framework. In addition, includes information on creating Datasources.

Chapter 9, “Using Custom Code.” Provides information on developing custom code that you can execute during the workflow instantiation. You can use this custom code to modify the workflow properties, add files to the workflow, and/or remove files from the workflow.

Appendix A, “Interwoven Workflow Modeler Tutorial.” Describes how to create a workflow model and make it available to end-users logged in to your TeamSite server. Use this tutorial to learn the basic skills you will need to develop workflow models, and to learn about some of the features available in Interwoven Workflow Modeler.

Appendix B, “Datasource Example.” Provides information on creating a sample Datasource.

Appendix C, “Workflow Schemas.” Provides information on the configuration files used by workflow models.

Appendix D, “Troubleshooting.” Provides a list of error messages (and possible solutions) you may encounter while working in the Interwoven Workflow Modeler. These errors listed here are ones that must be resolved before the workflow model can be published to TeamSite.

New or Changed InformationInterwoven Workflow Modeler 1.0.0.1 includes the following key changes:

Datasource Framework has been enhanced and can now be accessed through FormAPI (FormsPublisher). For more information, see Chapter 8, “Using Datasource Framework.”

A new feature called Custom Code has been added. It enables you to call external programs during the workflow instantiation. Using these programs, you can modify the workflow properties at runtime. For more information, see Chapter 9, “Using Custom Code.”


Chapter :

The Subscription schema (available_models.xsd) has been modified. For more information, see “The available_models.xml File” on page 116.

Workflow roles (WorkflowAdmin and WorkflowUser) have been modified. For more information, see “Understanding Workflow Roles” on page 111.

Deploy and Email tasks have been converted to URL tasks. For more information, see “Email Task Attributes” on page 85 and “Deploy Task Attributes” on page 83.

You can change the application settings (for example, the application theme) using the new Preference feature. For more information, see “Configuring Application Settings” on page 40.

You can upgrade old workflow models to the latest schema. For more information, see “Upgrading to the Latest Workflow Schema” on page 55.

Additions and corrections to this document (when available) can be downloaded in the PDF format from the following web site: https://support.interwoven.com.

Interwoven, Inc. 16

https://support.interwoven.com

https://support.interwoven.com

Chapter 1

Introduction

Workflow encompasses the procedures, tasks, people, and rules that define business practices and processes within an organization. Using Interwoven Workflow Modeler to define workflow models—and TeamSite to automate them—ensures that the business practices associated with your content are performed in a logical and consistent manner.

This chapter provides an introduction to general workflow models, the Interwoven Workflow Modeler functionality, and TeamSite integration. The following sections are included:

Workflow Lifecycle

Workflow Terminology

Creating Workflow Models with Interwoven Workflow Modeler

TeamSite and Workflow Models

Workflow Lifecycle Conceptually, workflow development consists of the following sequential phases:

Design. Understanding the business process being modeled and breaking it down into logical tasks. The output from the design phase is a generic workflow model created outside of the Interwoven Workflow Modeler.

Development. Using the Interwoven Workflow Modeler to create a TeamSite workflow model.

Publishing. Transferring the completed workflow model to the TeamSite server making it available to TeamSite users.

Managing workflows. You can control which workflow models are available to each branch. Workflows can be subscribed to from the Manage Workflows link on the Administration tab in ContentCenter Professional.

Configuring workflows. For different branches or folders, workflow models which contain variables can be configured to behave differently at instantiation.

Execution. Instantiating and executing a job that uses the workflow model.

In practice, the phases typically occur iteratively as the underlying business process is better understood and as development and testing occur.


Chapter 1: Introduction

The following graphic shows the various stages of a workflow model from development through publishing, managing, and instantiation. It also notes the different users associated with the workflow model’s lifecycle.

Figure 1 Workflow model lifecycle

Workflow TerminologyThis section defines workflow terminology as it relates to the Interwoven Workflow Modeler and TeamSite. Many of these terms have more general definitions outside of the context of TeamSite. It includes information on the following terms:

Workflow Models

Tasks

Jobs

Workflow Models

A workflow model is a general description of a recurring business process. Each workflow model describes a job consisting of a series of tasks, or units of work, and can be represented by a flow diagram, illustrating the series of tasks and the links (or transitions) between them.

The following graphic shows a simple assign-edit-approve-deploy workflow model. Email is sent to the participants at each stage of the process, and an automated content deployment task is performed at the end.

Interwoven, Inc. 18


Figure 2 Sample workflow model diagram

Tasks

Depending on the context, a task can be two different things:

A logical unit of work when describing business processes or workflow models.

An actual unit of work performed by a single user or process during the execution of a specific job.

Each task is associated with a TeamSite branch and workarea and, possibly, one or more files. The user or process owning a task can modify, add files to, or remove files from the task (provided the task is not a read-only task for content approval).

Tasks have two possible states:

Active. A task becomes active when its predecessor task signals it to do so (predecessor tasks and conditions for activation are all configured as part of the workflow model). After a task has been activated, users or external programs can work on it.

Inactive. Tasks that have been completed, or that have not yet been activated.



Jobs

A job is a specific instance of a workflow model. The previous graphic depicts a generic workflow model that could be transformed into a job instance by defining specific TeamSite users. For example, Bob could be defined as the editor and Jerry as the author. Additionally, the specific files that need to be edited could be defined as press_release.html and banner.gif.

Because jobs follow predefined workflow models, tasks cannot be added to or removed from individual jobs after jobs have been instantiated. In TeamSite, when a job is created, the job creator supplies all the specific information for that job, effectively “filling out” the workflow model to create a job specification. When a job specification is loaded into the workflow subsystem, it becomes a job.

Creating Workflow Models with Interwoven Workflow Modeler

You have likely seen or created flowcharts like the graphic on page 19 to represent a business model or process in your organization. These graphic representations are typically created using word processor programs, general graphics programs, or specialized flowchart programs.

The Interwoven Workflow Modeler incorporates many of the same easy-to-use drawing tools included in these programs, and adds sophisticated workflow rules that are automated and enforced by the TeamSite workflow engine. The result is that workflow models are easy to create and implement for workflow model developers, and easy to understand and respond to for TeamSite administrators and end-users.

Creating a workflow model typically includes:

Adding Elements

Assigning Element Properties

Publishing Workflow Models

Adding Elements

TeamSite workflow models (as opposed to the generic workflow models) are constructed using the Interwoven Workflow Modeler and contain the following elements:

One Start node

One End node

One or more tasks

Interwoven, Inc. 20


Links between the Start node and a task, between a task and other tasks, and between the final task and the End node.

Optional logical nodes for the Boolean operators AND, OR, and NOT.

Workflow elements are described in detail in “Interwoven Workflow Modeler GUI Elements” on page 33.

Assigning Element Properties

Workflow elements must be assigned properties. Properties include:

Attributes. Changeable characteristics that can be set to different values that describe or define an element. Different task types have different possible attributes. Some attributes are mandatory and some are optional. For example, in a Review task, the associated file could be assigned a read-only attribute to ensure the contents are not altered by a reviewer.

Variables. Attributes that are subject to change. For example, a person who is the owner of a task is defined later when the job is run. When the workflow model is created, the $IW_USER variable is used to represent the user who is assigned the task, until the variable substitution can be made at runtime.

Attributes and variables are described in detail in “Assigning Common Task Attributes” on page 67.

Publishing Workflow Models

Completed workflow models can be published to a TeamSite server from the Interwoven Workflow Modeler, provided the user has appropriate permissions in TeamSite. For detailed information, see “Publishing Workflow Models to TeamSite” on page 52.

TeamSite and Workflow ModelsThe Interwoven Workflow Modeler is included with TeamSite 6.7.1 (and later versions) and cannot be used with earlier TeamSite versions. The following TeamSite features have been added or modified to accommodate the Interwoven Workflow Modeler:

Admin store (iwadmin)

Default workflowModels branch under //TS_Server/iwadmin/main

Workflow model icon ( ) that differentiates workflow models from workflow templates (.wft) when they are displayed together (for example, in the New Job window or the Workflow tab)



In general, the activities associated with administering and using workflow models in TeamSite are as follows:

Workflow model approval cycle. Workflow models are actually content stored in TeamSite. Therefore, they may be subject to an approval process like any other content that is managed in TeamSite.

Managing workflows. The available_models.xml file controls which workflow models are available to each branch. Workflows can be subscribed to from the Manage Workflows link on the Admin tab in ContentCenter Professional.

Customize workflows. For different branches or folders, workflow models which contain variables can be configured to behave differently at instantiation.

Instantiate workflows. Instantiation of a workflow is the creation of an instance (job) of an abstraction (the workflow model). Workflows can be instantiated by clicking the following buttons or links anywhere they appear in TeamSite:

New Job

Submit

Assign

In addition, workflows can be instantiated in TeamSite using the following commands:

tfo_workflow (new job, in TeamSite FrontOffice)

tt_data (saving FormsPublisher data records)

tt_deletedcr (deleting FormsPublisher data records in ContentCenter Standard only)

After selecting a listed workflow model, the instantiation screen appears. Depending on your customization, the variables are displayed. Clicking Submit on the instantiation screen creates a job spec and a new workflow job is created.

For detailed information about using TeamSite with workflow models, see Chapter 6, “Managing and Configuring Workflow Models” and Chapter 7, “Instantiating Workflows” later in this document, and the TeamSite Administration Guide for general Administrator information.

Interwoven, Inc. 22

Chapter 2

Installing the Interwoven Workflow Modeler

This chapter contains the following sections:

System Requirements

Installing the Interwoven Workflow Modeler

Post-Installation Task

Uninstalling the Interwoven Workflow Modeler

System RequirementsEnsure that you install Interwoven Workflow Modeler on one of the following operating systems:

Windows XP SP1, XP SP2, or 2000 SP4

Linux AS 4.0

Solaris 2.9 or 10

Installing the Interwoven Workflow ModelerAfter ensuring that you have satisfied the system requirements, complete the following procedure to install the Interwoven Workflow Modeler on your system.

NOTEIf you encounter any error during the installation, see Appendix D, “Troubleshooting”.

1. Download or locate the Interwoven Workflow Modeler package.

2. Extract the package contents.

A new folder Wfm is created, and the package files are extracted into this folder.

3. Navigate to the Wfm folder, and run the install.bat file.


Chapter 2: Installing the Interwoven Workflow Modeler

The Introduction screen appears.

Figure 3 Introduction screen

4. Click Next.

The License Agreement screen appears.

Figure 4 License Agreement screen

5. Read the license agreement, and if you agree to its terms, select the I accept the terms of the License Agreement option, and click Next.

You must accept the terms of the license agreement to install and use the Interwoven Workflow Modeler. If you accepted the terms and clicked Next, the Product Files screen appears.

Interwoven, Inc. 24


Figure 5 Product Files screen

6. Do one of the following:

Click Install to accept the default installation folder (for Windows: C:\Program Files\Interwoven\WorkflowModeler).

Click Choose to navigate to the folder you want to use as the installation folder. After confirming the installation folder, click Next.

The Choose Shortcut Folder screen appears.

NOTEThis screen varies based on the operating system you are using. For Windows, the following screen appears.

Figure 6 Choose Shortcut Folder screen



7. Select the location for the Interwoven Workflow Modeler startup and uninstall shortcuts and click Install.

By default, in Windows, the installation program creates the shortcut to start the Interwoven Workflow Modeler in: C:\Program Files\Interwoven\iwinstall\modules\wfm.

The other shortcut location options are:

The Install Complete screen appears.

Table 2 Installation shortcut location options

Option Shortcut LocationIn a new Program Group

Creates a program group on the Start > All Programs menu. By default, this group is called Interwoven WFM. After selecting this option, you can rename the group.

In an existing Program Group

Creates shortcuts to start the Interwoven Workflow Modeler in an existing program group on the Start > All Programs menu. After selecting this option, you can select the existing group from the list.

In the Start Menu Creates shortcuts to start the Interwoven Workflow Modeler on the Start menu.

On the Desktop Creates shortcuts to start the Interwoven Workflow Modeler on the Windows desktop.

In the Quick Launch Bar

Creates a shortcut to start the Interwoven Workflow Modeler on the Quick Launch bar.To display the Quick Launch bar:1. Right-click the task bar near the Start button.2. Select Toolbars > Quick Launch.Depending on how many programs you have configured to display on the Quick Launch bar, you may need to click the Show All icon (>>) to see the shortcut.

Other This is the default option. It is set to create shortcuts to start the Interwoven Workflow Modeler in: C:\Program Files\Interwoven\iwinstall\modules\wfm. You can click Choose to specify a different location for the shortcut.

Don’t create icons No shortcut icon is created. If you select this option, you must complete the following procedure to start the Interwoven Workflow Modeler:1. Go to the installation folder selected in step 6.2. Double-click the WorkflowModeler.exe file.

Interwoven, Inc. 26


Figure 7 Install Complete screen

3. Click Done to complete the installation and exit the installer.

Proceed to Chapter 3, “Using the Interwoven Workflow Modeler” for information about starting and using the Interwoven Workflow Modeler.

Post-Installation TaskIf the TeamSite server is running in a secure mode, you need to set up the Secure Sockets Layer (SSL) communications between Interwoven Workflow Modeler and the TeamSite server.

To set up the SSL communication:

NOTEThis procedure is applicable only for Apache Tomcat.

1. On the TeamSite server, generate the keystore file by running the following command. The command should include the location to the SSL certificate file pointed to by iwwebd.conf (the SSLCertificateFile key).iw-home/tools/java/bin/keytool -import -v -trustcacerts -alias tomcat -file <CERT location> -keystore <keystore file>

For example:/Interwoven/TeamSite/tools/java/bin/keytool -import -v -trustcacerts -alias tomcat -file /Interwoven/TeamSite/iw-webd/conf/ssl.crt/server.crt -keystore keyfile

To find the SSL certificate file location (<CERT location>), complete the following steps:



a. Open the iw-home/iw-webd/conf/iwwebd.conf file.

b. Search for the SSLCertificateFile key. The location specified for this key is the SSL certificate file location.

2. Place the generated keystore file in any directory of the machine on which Interwoven Workflow Modeler is installed.

3. Open the <Interwoven Workflow Modeler installation folder>\resources\samples.properties file, and do the following:

a. Add a value for the serviceBaseURL variable.

For example, serviceBaseURL=https://MyTeamSiteServer:443

a. Add a value for the keystore.location variable.

For example, keystore.location=C:\\MyFolder\\KeyStore\\sampleKey.key

NOTEYou need to use two backslashes (\\), instead of one, in the keystore location path.

Now you can log in to the TeamSite server using the Secure Communication option.

Uninstalling the Interwoven Workflow ModelerWhen you install the Interwoven Workflow Modeler, an uninstallation program called WorkflowModeler.bat is installed on your system.

In Windows, if you selected the default installation folder, the uninstallation program is installed at: C:\Program Files\Interwoven\iwinstall\modules\wfm\UninstallerData

To uninstall the Interwoven Workflow Modeler:

1. Run the wfm.exe file. The uninstallation program’s screen appears.

Interwoven, Inc. 28


Figure 8 Uninstallation program screen

2. Click Uninstall to remove the Interwoven Workflow Modeler program files (files created using the Interwoven Workflow Modeler are not removed).

The Uninstall Complete screen appears.

Figure 9 Uninstall Complete screen

3. Click Done to complete the uninstallation procedure.



Interwoven, Inc. 30

Chapter 3

Using the Interwoven Workflow Modeler

This chapter contains the following sections:

Starting the Interwoven Workflow Modeler

Interwoven Workflow Modeler GUI Elements

Creating a New Workflow Model

Editing an Existing Workflow Model

Publishing Workflow Models to TeamSite

Retrieving Workflow Models from TeamSite

Upgrading to the Latest Workflow Schema

Starting the Interwoven Workflow ModelerTo start Interwoven Workflow Modeler:

1. In Windows, double-click the shortcut placed on your system by the Interwoven Workflow Modeler installation program.

Depending on your response to the installation prompt (step 7 on page 26), the shortcut ( ) can be located in one of the following locations:

In a user-specified Program Group on the Start menu.

On the Start Menu.

On the Desktop.

On the Quick Launch bar.

You could also have specified that no shortcut be created during installation. In this case, you must start the Interwoven Workflow Modeler by running WorkflowModler.exe from the installation folder you specified in step 5, on page 26.

In Windows, if you accepted the default option, WorkflowModeler.exe is located in C:\Program Files\Interwoven\WorkflowModeler.

The Login dialog box appears.


Chapter 3: Using the Interwoven Workflow Modeler

Figure 10 Login dialog box


Click Work Offline to work in the Interwoven Workflow Modeler without connecting to a TeamSite server. If you work offline, you will need to connect to the TeamSite server to publish your Workflow Model by selecting Options > Login to Server in the Interwoven Workflow Modeler GUI.

Enter the following account information and click OK to log in to a TeamSite server.

• Username. Your TeamSite user name.

• Password. Your TeamSite password.

• Domain. The domain where the TeamSite sever you are accessing resides, for example, myCompany.com. If you do not know the domain where your TeamSite server resides, contact your TeamSite administrator.

NOTEFor a UNIX server, the domain name is the same as the server name. For example, if your server name is myServer, the domain name, too, is myServer.

• Server. The name of the TeamSite server.

• Port. The Interwoven Web daemon (iwwebd) port number. By default, the port no is 80.

After the initial TeamSite login, the same domain, server, and port information is used for future logins. If you need to change any of these settings, click Options to display the corresponding fields.

Interwoven, Inc. 32


Interwoven Workflow Modeler appears. The elements contained in the user interface are described in the next section.

NOTEYou can invoke more than one instance of Interwoven Workflow Modeler. However, Interwoven does not recommend or support this operation.

Interwoven Workflow Modeler GUI ElementsThe following graphic shows the major areas of the Interwoven Workflow Modeler that are displayed after the first startup (there is also an Error pane that is not displayed by default; it is described in “Errors Pane” on page 47).There are a number of ways you can modify which panes and toolbars are displayed to customize the look of the Interwoven Workflow Modeler.

Figure 11 Interwoven Workflow Modeler user interface (UI)

Each of these areas is described in detail in the following sections:

Standard Toolbar

Links Toolbar

Tasks Toolbar

Display Toolbar

Links toolbarTasks toolbarTree pane

Project paneProperties paneDisplay toolbar

Standard toolbar



Project Pane

Tree Pane

Properties Pane

Standard Toolbar

The Standard toolbar includes icons for standard operations such as creating, opening, and saving files. In addition, it includes a few Interwoven Workflow Modeler-specific operations such as aligning workflow elements, grouping workflow elements, validating workflows, and so on.

The key operations are introduced in the following table.

Links Toolbar

The Links toolbar contains six link icons and six node icons.

Table 3 Standard toolbar

Icon Name DescriptionDuplicate Selection Duplicates the selected workflow elements.

Group Selection Groups the selected workflow elements and creates a subprocess. You can expand or collapse the subprocess.

Ungroup Selection Ungroups the selected subprocess.

Layout All Nodes Arranges all the connected workflow elements horizontally and disconnected workflow elements vertically.

Layout Selected Nodes Arranges the selected workflow elements horizontally if they are connected and vertically if they are disconnected.

Automatic Link Layout

Improves the presentation of links.

Hide/Show Property Sheet

Hides/displays the Properties pane.

Validate Workflow Validates the workflow. If the workflow contains error(s), the Error pane appears.

Sticky Actions When enabled, repeats a Project pane drawing operation (for example, adding a User task). You do not have to reselect the same workflow element from the Create menu or the Tasks toolbar.

Interwoven, Inc. 34


Links are placed between tasks and define the transition to the next task.

Nodes define the start and end of the workflow model and also include the Boolean operators AND, OR, and NOT.

The links and nodes are introduced in the following table.

Table 4 Links toolbar

Icon Name DescriptionStart Event node Defines the start of all workflow models. This node

is required and must come first. You should add only one Start node for any workflow model.

End Event node Defines the end of a workflow model. This node is required, must come last, and must be preceded by a Default Link, Success Link or a Timeout Link. You should add only one End node for any workflow model.

Default link Defines a simple transition from one workflow element to another. Use this link type when there is no need for special logic or conditions.

Reset link Defines a link that restarts the workflow by an event that precedes it.

Inactivate link Defines a link that can be rendered inactive by an event that proceeds it.

Timeout link Defines a link that pauses the workflow for a user-specified period of time. For more information about configuring Timeout Links, see “Timeout Links” on page 96.

Success link Defines the workflow path on which to continue after an event has been successfully completed.

Failure link Defines the workflow path on which to continue after an event has not been successfully completed.

Conditional link Defines the workflow path on which to continue only if a condition evaluates to True. Two tasks can be linked with any number of Conditional links, but should also be linked by a Default link, so that if all Conditional links evaluate to False, the workflow can continue using the Default link.

AND node All tasks linked to this element must be completed before activating a successor task.

OR node One of the tasks linked to this element must be completed before activating a successor task.

NOT node None of the tasks linked to this element must be completed before activating a successor task.



NOTEThe links and nodes listed in this table are also available from the Create > Other Elements menu.

Tasks Toolbar

The Tasks toolbar contains 14 task icons. A task is both a logical unit of work, when describing business processes, and an actual unit of work performed by a single user or process during the execution of a specific job.

The tasks are introduced in the following table. For more information on their attributes, see Chapter 4, “Working with Element Attributes”.

Text Annotation node Enables you to add text to explain any task or link in a workflow model. It has no bearing on the functionality of the workflow model.

Table 5 Tasks toolbar

Icon Name DescriptionUser task Defines a task that is assigned to a user. It appears on

a user’s task list in the TeamSite ContentCenter GUI.

Review task Defines a task that specifies one or more users must review assigned work (typically files associated with the task) before the job can continue.

Group task Defines a task that is assigned to a group of users. It appears in the task list of each member of the group of users specified in the task. A group task becomes identical in behavior to a user task when one member of the group takes ownership of the task using ContentCenter.

Email task Sends email to specified users. You can send emails by specifying a URL (pointing to a class) for the Email Command attribute and by specifying values for the variables using the Variables attribute.

External task Specifies that an external program is run using the command element.

CGI task Enables you to run a CGI script.

Metadata task Enables the task owner to create metadata for the files associated with the task.

Update task Performs a TeamSite Get Latest or Copy to Area operation on files associated with the task.

Table 4 Links toolbar

Icon Name Description

Interwoven, Inc. 36


NOTEThe tasks listed in this table are also available from the Create > Tasks menu.

Display Toolbar

The Display toolbar contains seven icons that control the view of the elements displayed in the Project pane. Additionally, three icons show or hide panes in the Interwoven Workflow Modeler GUI. The display tools are introduced in the following table:

Submit task Performs a TeamSite Submit operation on files associated with the task.

Deploy task Performs a deploy operation on files associated with the task. This operation is performed by specifying a URL (pointing to a class) for the Deploy Command attribute. A Deploy task must have a Success outgoing link.For more information on OpenDeploy, see the OpenDeploy documentation.

Lock task Attempts to acquire locks on files it owns. If it succeeds, it transitions to the successors specified in its success link. If it fails, it transitions to the successors specified by its failure link. This provides users with a way to continue in a job that cannot acquire its locks.

Nested Workflow task Represents a workflow that can be a job specification file, a workflow model, or a workflow template file. Nested workflows are considered child workflows and the workflow that triggers them is considered the parent workflow.

URL task Specifies a URL to be invoked.

Dummy task Acts as a placeholder for time delays, task resets, or gate transition tasks. A dummy task has no owner or areavpath.

Table 6 Display toolbar

Icon Name DescriptionMake Selection Active Selects an element in the Project pane. The selected

element is outlined in red in the Project pane, and any associated properties are displayed in the Properties pane.

Zoom In* Increases the magnification of the area of the Project pane where you click.

Table 5 Tasks toolbar




NOTEThe features marked with an asterisk (*) are also available from the View menu. The View menu also includes an option to display an alignment grid in the Project pane, and to display the Error pane (described on page 47).

Options Menu

The Options menu contains a number of drawing tool options that determine how Tasks, Links, and Nodes are edited, added, and viewed in the Project pane. It also contains the Validate Workflow option, the options for logging into and out of TeamSite, and the options for changing the application settings.

Zoom Out* Decreases the magnification of the area of the Project pane where you click.

Zoom Box Defines a rectangular area of the Project pane to display.

Reset Zoom* Resets the magnification of the Project pane to the default setting. This option is not active when the default magnification is selected.

Fit to Contents* Displays all elements in the Project pane as large as possible without cropping out any element.

Pan Moves the view displayed in the Project pane by dragging all the elements equally up, down, left, right, or diagonally in the pane. The magnification is not changed by panning.

Hide/Show Tree* Hides or displays the Tree pane. For information about the Tree pane, see “Tree Pane” on page 44.

Hide/Show Overview* Displays either the Properties pane or the Overview pane. For information about the Properties pane, see “Properties Pane” on page 45.The Overview pane enables you to modify the display of the elements in the Project pane by dragging the border of the Project pane relative to the elements displayed within it. From the Overview pane, you can click a tab to return to the Properties pane.

Table 6 Display toolbar


Interwoven, Inc. 38


Figure 12 Options menu

A checkmark next to a menu option shows that it is enabled.

The Options menu features are introduced in the following table.

Table 7 The Options menu

Option DescriptionAllow Editing When enabled, unlocks the Project pane so that the

elements can be added, edited, or deleted from the workflow model. Note: • When this option is not selected, the editing options

throughout the application are disabled.• When enabled, this option does not prevent you from

selecting an element in the Tree pane, and editing it in the Properties pane.

Sticky Actions When enabled, you can repeat a Project pane drawing operation (for example, adding a link) without returning to the Create menu or the Tasks toolbar to reselect it.

Grid Spacing Displays the Grid Spacing dialog box where you can specify the Project pane’s grid size (in points). The grid is displayed or hidden by selecting the Grid option in the View menu.

Validate Workflow Validates the current workflow against an included schema to ensure the workflow model contains the required elements. There is also a toolbar button for this option. For more validation information, see “Errors Pane” on page 47.

Login to Server Displays the server Login dialog box if you are currently using the Interwoven Workflow Modeler in the offline mode.

Logout from Server Logs you out of the TeamSite server if you are using the Interwoven Workflow Modeler in the online mode.

Preference Enables you to configure the application settings, for example, you can select the desired shortcut key for displaying global variables in the Script editor.For more information, see “Configuring Application Settings” on page 40.



Configuring Application Settings

You can configure the application settings using the Preference dialog box. To display the dialog box, select Options > Preference.

Figure 13 Preference dialog box

You can configure the following options using the Preference dialog box:

General

Appearance

Shortcut Keys

NOTEAll these options are enabled in the online mode only. If you are using the Interwoven Workflow Modeler in the offline mode, some of the options are disabled.

General

Enables you to configure generic settings of the application. To display the General tab of the Preference dialog box, select Options > Preference > General.

Interwoven, Inc. 40


Figure 14 Preference dialog box - General node

You can configure the following:

Whether a confirmation message should appear after you publish (upload) a workflow model.

Whether the application should prompt you to validate a workflow model before saving it.

Whether the login screen should appear when you invoke the application.

NOTEIn the offline mode, the first two options are disabled.

Appearance

Enables you to change the theme of the application. A theme determines the overall appearance of the application.

To display the Appearance tab of the Preference dialog box, select Options > Preference > Appearance.



Figure 15 Preference dialog box - Appearance node

You can set the theme to Windows (default), CDE/Motif, or Metal.

Shortcut Keys

Enables you to set or modify shortcut keys for various actions in the application. To display the Shortcut Keys tab of the Preference dialog box, select Options > Preference > Shortcut Keys.

Figure 16 Preference dialog box - Shortcut Keys node

You can assign a shortcut key for displaying global variables in the script editor, which is used while creating SCRIPT variables. For more information on SCRIPT variables, see “Script Variables ($IW_SCRIPT)” on page 62.

NOTEIn the offline mode, the Shortcut Keys option is disabled.

Interwoven, Inc. 42


Project Pane

The Project pane is displayed by default as a blank project labeled Unnamed (1). The Project pane is used as the drawing area where you add and arrange visual elements that compose your workflow models. These elements include the Tasks, Links, and Nodes described in “Links Toolbar” on page 34 and “Tasks Toolbar” on page 36.

The following graphic shows the Project pane containing a simple workflow model.

Figure 17 Project pane with workflow model

Note the following in the graphic:

The project has been saved in the default location (C:\Documents and Settings\user_name\My Documents), in a file named test1 using the default extension .ipm.

The alignment grid has been activated from the View menu.

The project contains the required Start and End nodes.

All the tasks and links are displayed with their default labels. These can be modified to be more descriptive as described in “Assigning Common Task Attributes” on page 67 and “Assigning Common Link Attributes” on page 95.

In general, the model describes a simple workflow where:

A user performs some work—authoring a Press Release for example—then sends it to a reviewer.

If the reviewer approves the work, it is submitted to a TeamSite workarea. If it is rejected, it is sent back to the author who must revise it and resubmit it for approval and submittal.

After it is submitted to TeamSite, it is deployed—for example, to a website.



The mechanisms for passing the document and notifications in the workflow are not specified. They could be any number of system notifications, typically email.

Continue to the next section where the test1.ipm workflow model is used to introduce you to the Tree pane.

Tree Pane

The Tree pane lists the elements in a workflow model in a tree view list. The elements are listed in the order they were added to the project.

By default, all projects begin with a Workflow Model node and a Workflow Properties sub-node. These nodes are shown at the top of the following Tree view of the test1.ipm workflow model shown in Figure 17 on page 43.

Figure 18 Tree pane


The task elements in the tree view are listed in the order they were added to the workflow model. Therefore, the six tasks (Start through End) are listed before seven links (Flow8 through Flow 14).

The seventh element that was added to the project was deleted during development. There is not an element labeled Task7 or Flow7. Therefore, this element was added to the project after the End8 node, and then deleted before the first link (Flow8) was added.

Each link contains a label that states the tasks that it links. For example, the first of the three Success links comes between ReviewTask3 and SubmitTask4.

The links are color-coded to identify the type of link:

Interwoven, Inc. 44


Black. Default link

Blue. Reset link

Light Brown. Inactivate link

Dark Brown. Timeout link

Green. Success link

Red. Failure link

Gray. Conditional link

Continue to the next section where the test1.ipm workflow model (shown in Figure 17 on page 43) is used to introduce you to the Properties pane.

Properties Pane

The Properties pane is used to assign and display values and descriptions of the selected element in a workflow model. An element may be selected by clicking it in the Project pane (in which case it is outlined in red) or in the tree view.

NOTEThe Properties pane is displayed by default, but can be hidden if Hide/Show Overview is clicked (see “Hide/Show Overview*” on page 38).

The following graphic shows the Properties pane for the Workflow Properties element from the test1.ipm workflow model (shown in Figure 17 on page 43).

Figure 19 Properties pane




All of the General properties have been assigned.

The test1 project is:

Described as an Approve/deploy workflow model.

Due to be completed (that is, successfully deployed) by September 04, 2006. Dates are displayed using the YYYY-MM-DD format where Y is year, M is month, and D is day.

Owned by $IW_USER. This variable represents the user currently logged in to TeamSite.

A Medium priority (0 is Very High, 1 is High, 2 is Medium, 3 is Low, and 4 is Very Low).

The minus sign (-) next to the General, Flags, System Variables, and System headings can be clicked to collapse the corresponding property group. If a group is collapsed, a plus sign (+) appears.

Continue to the next section where the test1.ipm workflow model (shown in Figure 17 on page 43) is used to introduce you to the Overview pane.

Overview Pane

The Overview pane is similar to the Project pane in that it shows a graphical representation of a workflow model. It differs in that it always shows the entire workflow model, and superimposes a rectangular outline over the graphic to represent the area that is currently shown in the Project pane.

Figure 20 Overview pane


One of the Zoom tools has been used to magnify the image in the Project pane.

Interwoven, Inc. 46


The Overview pane shows the entire workflow model and outlines the area currently shown in the Project pane.

The Flow11(ReviewTask3->SubmitTask4) link is selected (in the Tree pane) and displayed in red in all three panes. Because it is a Success link, it appears in green when not selected.

You can drag the black outline rectangle, or click within the Overview pane to move the rectangle, to change what is displayed in the Project pane. You cannot select elements in the Overview pane.

When you use the Pan tool ( ) in the Project pane to display a different area of the workflow model, the Overview pane is updated.

A tab to display the Properties pane is included at the top of the Overview pane.

Continue to the next section where the test1.ipm workflow model (shown in Figure 17 on page 43) is used to introduce you to the Error pane.

Errors Pane

The Interwoven Workflow Modeler includes a validation feature (click Options > Validate Model or click the Validate Current Workflow toolbar button) that ensures your workflow models are valid by comparing them to an included XML schema.

If the model you created is not valid, the errors are displayed in the Error Pane at the bottom of the GUI. If you select any of the rows in the Error Pane, then the appropriate element is highlighted (the element appears gray with red border) and its corresponding properties are displayed in the Properties pane.

The following graphic shows that the test1.ipm workflow model used to illustrate this section of this manual contains some errors.



Figure 21 Errors pane


The yellow task boxes in the Project pane show that the validation check was run on this workflow model and the elements that are yellow contain—or are linked with links that contain—errors.

The Errors pane appears below the Project pane after you attempt to validate a workflow model.

The three errors in the workflow model are listed in the errors table in red text.

The error details are shown in the following graphic:

Figure 22 Errors pane details

To resolve the errors in the test1 workflow model, you must:

Specify at least one user or group name for the Review task. In addition, specify the number of reviewers. Use the Available Groups, Available Users, and Reviewers properties. For more information, see “Review Task Attributes” on page 91.

Interwoven, Inc. 48


Specify a valid deployment name. Use the Variables property. For more information, see “Deploy Task Attributes” on page 83.

This concludes the introduction to the GUI elements. Continue to the next section where the procedure for creating a new workflow model is described.

Creating a New Workflow ModelTo create a new workflow model:

1. Start the Interwoven Workflow Modeler and log in as described on page 31.

A workflow model labeled Unnamed (#) (where # is the total number of workflow models you have created) is displayed by default.

2. Select File > Save As.

NOTEYou can also create new models by selecting File > New or clicking New Diagram ( ).

3. Specify a name and location for the file and click Save.

Do not change the file type. Workflow models must be saved with the default .ipm extension.

The Project pane displays the name and location in the Title bar.

Figure 23 Project pane Title bar

By default, workflow models are saved to:



C:\Documents and Settings\user_name\My Documents on the local system if you are working in the offline mode.

The current user’s TeamSite workarea on the //TS_Server/iwadmin/main/workflowModels/WORKAREA/iw-wa/Models branch if you logged in to TeamSite using the Interwoven Workflow Modeler.

4. Click the Start Event node icon, move your cursor to the place in the Project pane where you want to add this element, and then click to add it.

The element is displayed in the Project pane and is listed in the Tree pane as Start (Start1) below Workflow Properties.

5. Click Workflow Properties in the Tree pane.

The Properties pane displays the properties for the current workflow model (Sample).

Figure 24 Workflow model properties

6. Click next to any of the attributes (ID and Name attributes always have same values) to assign a value or enter a description.

Each task, link, and node has its own set of attributes; required properties use bold labels. For more information on setting Flags and System Variables, see Chapter 4, “Working with Element Attributes.”

7. Click a task icon, move your cursor to the place in the Project pane where you want to add this element, and then click to add it.

Interwoven, Inc. 50


8. Add a link:

a. Click a link icon in the Links toolbar (for information on link types, see “Links Toolbar” on page 34).

b. Click the Start node in the Project pane.

c. Click the task icon you added in step 7. The link is drawn between the two elements.

d. Click the link in either the Task pane or the Project pane. The link appears in red (to show it is selected), and its default properties are displayed in the properties pane.

e. Depending on the type of link you added, you may be able to click next to any undefined properties and assign a value. For example, if you added a Timeout link, you must set the timeout duration in the Properties pane.

9. Continue adding tasks, links, and nodes (also located on the Links toolbar) and define their associated properties as described previously in this procedure.

10. Add an End node—and a link to it—to complete the workflow model.

11. Click Save, or select File > Save to save the project.

NOTEWhen you save a workflow model, .ipm and .xml files are created. Both these are XML files. The .ipm file is the actual workflow XML. It contains information on the workflow elements that form the workflow model. The .xml file contains information on CONFIG, DATASOURCE, and SCRIPT variables that you added in your workflow model. Both these files are needed for the workflow model to work.

Editing an Existing Workflow ModelTo edit an existing workflow model:

1. Start the Interwoven Workflow Modeler, and log in as described on page 31.

A workflow model labeled Unnamed (#) is displayed by default. You can either close it or leave it open.

2. Select File > Open, or click Open Diagram.

3. Double-click the workflow model file you want to edit (they have .ipm extensions).

By default, workflow models are saved to:

C:\Documents and Settings\user_name\My Documents on the local system if you are working in Offline mode.

Current user’s TeamSite workarea on the //TS_Server/iwadmin/main/workflowModels/WORKAREA/iw-wa/Models branch if you logged in to TeamSite when you started Interwoven Workflow Modeler.



The file is displayed in the Interwoven Workflow Modeler Project pane.

4. Edit any of the elements already contained in the project, or add new elements.

Publishing Workflow Models to TeamSiteAfter completing a workflow model you can publish it to the TeamSite server, if your role has the required permissions in TeamSite. Note that workflow models can be treated like any other content that you manage in TeamSite. Therefore, they may also be subject to a workflow model where, for example, they are subject to an approval process before they can be made available for subscription.

When you publish a workflow model, it is submitted to a branch called workflowModels in the iwadmin store:

//TS_Server/iwadmin/main/workflowModels/STAGING/Models

Before submitting the workflow model, a copy is also stored in the following Workarea:

//TS_Server/iwadmin/main/workflowModels/WORKAREA/iw-wa/Models

All files submitted to this branch are subject to a default workflow that:

Submits the workflow model (the .ipm file).

Validates the workflow model against a schema (BPMNModel.xsd).

To publish a workflow model to your TeamSite server, complete the following steps:

1. If you are not logged into your TeamSite server, select Options > Login to Server. The Login dialog box appears.

Interwoven, Inc. 52


Figure 25 Server Login dialog box

NOTEIf the Domain, Server, and Port fields are not displayed, click Server Info and ensure that the TeamSite server information is correct.

2. Enter your TeamSite credentials to log into TeamSite, and click OK.

3. Select File > Publish Workflow.

A message is displayed confirming the workflow model was published, or that there are errors that must be resolved before it can be published.

Retrieving Workflow Models from TeamSiteUsing Interwoven Workflow Modeler, you can retrieve workflow models from TeamSite. This feature is useful if you want to update your draft workflow model (located in the iw-wa workarea of TeamSite) or a published workflow model (located in the Staging area of the workflowModels branch).

To retrieve a workflow model:

1. Select File > Retrieve from Server. The Retrieve from Server dialog box appears.



Figure 26 Retrieve from Server dialog box

2. Identify the workflow model you want to retrieve, select its state (Draft or Published) from the State column, and click OK.

If you select the Draft state, the workflow model is retrieved from //TS_Server/iwadmin/main/workflowModels/WORKAREA/iw-wa/Models and is by default stored (for Windows) in C:\Program Files\Interwoven\WorkflowModeler\data\examples\drafts.

However, if you select the Published state, the workflow model is retrieved from //TS_Server/iwadmin/main/workflowModels/STAGING/Models and is by default stored (for Windows) in C:\Program Files\Interwoven\WorkflowModeler\data\examples\published.

NOTEAfter upgrading your TeamSite server, if you retrieve a workflow model using the Published state, you are prompted to overwrite the workflow model in the iw-wa workarea with the one you retrieve from Staging. This happens because the workarea files are marked as modified when the branch and workarea permissions are changed during the upgrade process. You can select any option, because the files have not been actually modified.

Interwoven, Inc. 54


Upgrading to the Latest Workflow SchemaWhen you open a workflow model developed using an older version of Interwoven Workflow Modeler, you will be prompted to convert the workflow model to the latest version of the workflow schema.

If you click Yes, the workflow model is converted to the latest version. Any new workflow element that you add to the converted workflow model conforms to the latest workflow schema. However, the existing workflow elements do not conform automatically. You can identify and resolve the non-conformance by validating the workflow model and fixing the errors listed in the Error pane.

If you click No, the workflow model is not converted to the latest version, and any new workflow element that you add to this workflow model continue to conform to the old version.

Alternatively, you can upgrade your workflow models to the latest workflow schema by selecting Create > Convert Workflow.

The workflow schema has undergone the following changes:

The workflow property sheet includes two new attributes: PreProcessor Command and PostProcessor Command.

For the Nested task, the following attributes have been replaced with the Workflow attribute: Job Spec File, Workflow Model, and Workflow Template.

Deploy task includes a new attribute, OD Variables. In addition, the default value of the Deploy Command attribute has been modified.

For the Email task, the default value of the Email Command attribute has been modified.



Interwoven, Inc. 56

Chapter 4

Working with Element Attributes

Workflow elements—tasks, transition links, and nodes—all have special attributes that you must configure when you create a workflow model or job. Attributes (also known as properties) are changeable characteristics of a workflow element that can be set to different values. Each workflow element has a different set of possible attributes. Some attributes are required, some are optional, and some can be set using variables. Variables are values that change depending on unknown conditions or information determined when a job is instantiated, or after a workflow is in process.

If attributes are set using variables, the workflow model can be considered a form or template that must be completed when invoked through the New Job menu item or the Submit button in TeamSite. If user variables are not used to set attributes, the workflow model describes a specific job.

This chapter includes the following sections:

Interwoven Workflow Modeler Variables

Assigning Common Task Attributes

Assigning Workflow-Specific Attributes

Assigning Task-Specific Attributes

Assigning Common Link Attributes

Assigning Link-Specific Attributes

Working with Logical Nodes

Interwoven Workflow Modeler VariablesThe Interwoven Workflow Modeler includes three new variables in addition to the TeamSite System and Macro variables already supported by the TeamSite workflow engine. The new variables are:

Configurable variable (see “Configurable Variables ($IW_CV)” on page 58)

Datasource variable (see “Datasource Variables ($IW_DS)” on page 60)

Script variable (see “Script Variables ($IW_SCRIPT)” on page 62)


Chapter 4: Working with Element Attributes

These variables are available for most attributes of the workflow model elements. Their values are resolved just before instantiation. Therefore, they appear as strings or Boolean values in the final job specification file. These variables are automatically assigned an ID. You can change the default ID to a more intuitive value (for example, MyVar). However, ensure that the ID:

Is unique

Begins with a character

Does not contain just numbers

Does not contain just space(s)

Configurable Variables ($IW_CV)

The $IW_CV Configurable variable enables you to create a workflow model that contains elements whose values do not need to be assigned until the workflow is customized or instantiated in TeamSite.

Any property, except Name and coordinates (X, Y), of a task, transition link, or node can be exposed as a Configurable variable. For example, if you have an AreaVPath property set as a configurable variable, you do not need to provide the value when you are creating the workflow model. Instead, its value can be assigned by end-users in TeamSite.

NOTEYou can define a default value when creating the workflow model and allow that it be changed during customization or instantiation of workflows.

Configurable variables are defined in the dialog box displayed by clicking next to a property in the Interwoven Workflow Modeler Property pane. The following graphic shows the dialog box for creating a Configurable variable associated with a task’s Brief Description.

Interwoven, Inc. 58


Figure 27 Configurable variable dialog box

After creating the variable, it is available for reuse (identified by the variable type, and the ID) from the Properties pane:

Figure 28 User-defined configurable variable available for reuse

In addition to assigning an ID, the configurable variable dialog box prompts you for the following information:

Label. This value is displayed in the TeamSite instantiation and configuration forms. Labels are used to identify the variable (required field).

Default Value. This is the default value for the property (optional field).

Description. This value is displayed in TeamSite instantiation and configuration forms. It provides detailed information about the property than the Label can (optional field).



Readonly. Specifies whether this property should be read-only or writable during instantiation.

Hidden. Specifies whether this property should be hidden or visible during instantiation.

Datasource Variables ($IW_DS)

TeamSite now includes a framework called Datasource framework. It enables you to write Java classes that implement a specific predefined interface. These classes can retrieve data from any location, including—but not limited to—a database, TeamSite, a user-defined class, or a computer’s file system. This data is stored in the $IW_DS Datasource variable.

For more information on the Datasource framework, see Chapter 8, “Using Datasource Framework”.

Before creating Datasource variables, the Java classes must be registered with TeamSite. The Datasource is available to workflow model developers the next time they log in to TeamSite from within the Interwoven Workflow Modeler. The value returned by the Datasource can be used to set the value for any property of a task, workflow model, transition link, or node.

For example, if you define UserPicker as a Datasource variable, you need to specify the name of the Datasource it uses and select one of the values returned by that Datasource as the default value.

NOTEWhile Datasource variables are more useful for some properties than others, they are included for all the properties.

Datasource variables are defined in the dialog box displayed by clicking next to a property in the Interwoven Workflow Modeler Property pane. The following graphic shows the dialog box for creating a Datasource variable associated with a task’s Brief Description.

Interwoven, Inc. 60


Figure 29 Datasource variable dialog box

After creating the variable, it is available for reuse (identified by the variable type, and the ID) from the Properties pane:

Figure 30 User-defined Datasource variable available for reuse

The Datasource variable dialog box prompts you for the following information:

ID. Unique system-generated identifier for the variable. You can modify it to a more intuitive value.

Component Name. Drop-down menu lists all the Datasources registered with your TeamSite server (required field).

Label. This value is displayed in the TeamSite instantiation and configuration forms. Labels are used to identify the variable (required field).

Default Value. This is the default value for the property.



NOTEThis field is automatically populated with the return value of the selected Datasource component.

Description. This value is displayed in TeamSite instantiation and configuration forms. It provides more detailed information about the property than the Label can (optional field).

Readonly. Specifies whether this property should be read-only during instantiation.

Hidden. Specifies whether this property should be hidden during instantiation.

Script Variables ($IW_SCRIPT)

Script variables are defined in a script editor located on the Source tab of the SCRIPT dialog box. You can display the dialog box by clicking next to a property in the Interwoven Workflow Modeler Property pane.

NOTEIn the script editor, you can display a list of global variables using the shortcut key assigned in the Preference dialog box. For more information on global variables, see “Global Variables” on page 66.

The following graphic shows the dialog box for creating a Scripting variable associated with a task’s Owner.

Figure 31 Script variable dialog box

Interwoven, Inc. 62


After creating the Script variable, it is available for reuse (identified by the variable type, and the ID) from the Properties pane:

Figure 32 User-defined Script variable available for reuse

The Script variable enables you to write JavaScript for any task, transition link, or node property and have the value returned by the script determine the value assigned to that property.

For example, if you create a Script variable for the property MDCaptureUI, you could create the following script to determine which metadata capture screen is displayed to end-users:if("$IW_CV(notify)" == "true")

{"iwmetadataWithEmail.cgi";

}

else{

"iwmetadata.cgi";

}

In this example, $IW_CV(Notify) is a global Configurable variable.

If $IW_CV(Notify) is evaluated as true, iwmetadataWithEmail.cgi is set as the value for MDCaptureUI.

If $IW_CV(Notify) is evaluated as anything other than true, iwmetadata.cgi is set as the value for MDCaptureUI.

The Metadata capture UI that is displayed is determined by which of the two CGI programs (iwmetadataWithEmail.cgi or iwmetadata.cgi) is run.

Do not use the return keyword for a statement that directly returns the script result. For example, do not use the following:



if("$IW_WFNAME" == "MyWorkflow"){

return "$IW_WFNAME";

}else

{

"false";

}

where $IW_WFNAME evaluates to the current workflow’s name. The valid script is as follows:if("$IW_WFNAME" == "MyWorkflow"){

"$IW_WFNAME";

}else

{

"false";}

You can, however, use the return keyword within a function of your script, because the result of a script containing a function is returned using a function call statement. For example:function myFunction()

{return("Have a nice day!")

}

myFunction();

The Script variable supports:

Dynamic value assignment. Expressions can be defined using global variables and string constants. These expressions are evaluated during runtime and the result is assigned to the appropriate property.

NOTEExpressions can involve more than one global variable. For example, you could define two global variables named editor and domain. You could then form an expression using these two variables and string constants, and the result can be assigned to the owner of the User task. These two global variables can be used in the expression: domain+“\”+editor.

Conditional task transitions. Tasks can be linked with any number of conditional transitions. If the condition evaluates to True, then that particular transition is used in the workflow model.

A Default transition should also be attached to the tasks linked by conditional transitions. If all conditional transitions evaluate to False, the default transition is used.

Interwoven, Inc. 64


Script verification. The SCRIPT dialog boxes contain an Evaluate tab where you can simulate the execution of the script and verify the results.

Previously declared variables.

TeamSite System Variables

You can use the following list of TeamSite System variables in any Interwoven Workflow Modeler task, transition link, or node property or in conjunction with other Script variable scripts.

System variables are identified by the icon.

TeamSite Macro Variables

You can use the following list of TeamSite Macro variables in any Interwoven Workflow Modeler task, transition link, or node property. These variables are of the form %name, and are expanded before being set as an extended attribute. They are identified by the icon.

Table 8 TeamSite System variables

Variable Name Description$IW_HOME TeamSite installation directory$IW_STORE Current VPath’s store$IW_SERVER TeamSite server name$IW_SESSION Current user’s session ID$IW_USER Current user’s TeamSite user name$IW_WORKAREA Current VPath’s workarea$IW_AREAOWNER Current workarea’s owner$IW_BRANCH Current VPath’s branch$IW_TIME Current time in milliseconds$IW_WFNAME Current workflow’s name

Table 9 TeamSite Macro variables

Variable Name Description%workflow; Name of the job%workflowid; ID of the job%task; Name of the task%taskid; ID of the task%taskowner; Owner of the task



NOTEMacro variables are available to EA Finish Op and EA Start Op only.

Variable Scope

Interwoven Workflow Modeler enables you to define variables with the following scopes:

Local

Global

Local Variables

Variables declared for a task, transition link, or node property can be reused only within that task, transition link, or node. Such variables are called local variables.

For example, a configurable variable created for one of the attributes of a task can be used by other attributes of the same task. However, it cannot be used by attributes of other tasks, transition links, or nodes.

Global Variables

Variables declared using the Global Variables attribute of a workflow model are called global variables. These variables are available for reuse across that workflow model. All the elements (tasks, transition links, and nodes) of that workflow model can use these variables.

For example, a configurable variable created using the Global Variables attribute for a workflow model can be used by all the elements of that workflow model. However, it cannot be used by attributes of other workflow model elements.

%time; The current wall clock time%area; VPATH of the task's area%path; Path of the file from area root%fullpath; Full path of the file from server root%taskcomment; Task-specific comment added to the

extended attribute%filecomment; File-specific comment added to the

extended attribute

Table 9 TeamSite Macro variables

Variable Name Description

Interwoven, Inc. 66


NOTEDo not include the “|” symbol for a global variable’s value, because it is used as a delimiter internally.

For more information on Workflow attributes, refer to “Assigning Workflow-Specific Attributes” on page 78.

Continue to the next section for details about creating variables in the Interwoven Workflow Modeler’s Properties pane.

Assigning Common Task AttributesThis section describes the attributes that you can assign in the Properties pane of each task type. It begins with a section about the attributes that are common to most tasks, then describes the remaining attributes for each task type.

You can assign the following attributes for most Interwoven Workflow Modeler tasks (exceptions are noted where appropriate):

Area V Path

Brief Description

Description

Name

Owner

Lock

Read Only

Transfer Only

Variables

EA Finish Op

EA Start Op

WF Variables Finish Op

WF Variables Start Op

X

Y

ID



Area V Path

Specifies the TeamSite area associated with this task. This attribute is not available for Dummy tasks.

In the Properties pane, click the field next to AreaVPath, and then select one of the following values:

$IW_WORKAREA. Variable that is set to the TeamSite workarea associated with the task, for example: /default/main/WORKAREA/pattismith.

CONFIGURABLE. See “Configurable Variables ($IW_CV)” on page 58.

DATASOURCE. See “Datasource Variables ($IW_DS)” on page 60.

SCRIPT. See “Script Variables ($IW_SCRIPT)” on page 62.

Brief Description

A brief description of what the task does.

In the Properties pane, click the blank field next to Brief Description, and then either type a value or select one of the following values:




Description

A description of what the task does.

1. In the Properties pane, click the blank field next to Description to display the Description dialog box.

Interwoven, Inc. 68


Figure 33 Description dialog box

2. Type a value in the text box below the Variable Type drop-down list.

Alternatively, click the Variable Type drop-down list, and select one of the following values:




Name

The name of the task. Each task in a job must have a unique name. By default:

The Tree pane displays task names using the following convention: task_typeTask(task_type#)

For example: GroupTask(Group Task 4).

The Properties pane displays only the task_type.

Click the Name field in the Property pane to edit the name.

For example, if you edited the previous example GroupTask(Group Task 4) name to rename it LogoUpdate, the Tree pane would show LogoUpdate(Group Task 4). The Project pane also displays the updated name.

Owner

Username of the task’s owner. This is the person who is responsible for performing the task. This attribute is not available for Group, Review, and Dummy tasks.



In the Properties pane, click the field next to Owner (in some tasks the field is blank, in others $IW_USER is the default value), and then select one of the following values:

$IW_USER. Name of the current user, typically the job creator. When a job is created, all its associated tasks are also created. Therefore, any task or attributes that were specified as $IW_USER have their value set to the job creator's user ID.

$IW_AREAOWNER. Name of the current workarea (if you create the job from the workarea view or by using Submit).




Lock

Specifies whether the task attempts to acquire TeamSite locks on all the files it contains when it becomes active. If the task cannot acquire locks for one or more of the files it contains, it releases any locks it has already acquired and tries again every five minutes until it successfully acquires all locks.

The Lock attribute is not available on the Submit, Lock, Nested Workflow, URL, and Dummy tasks.

The value can be True, False (this is the default), or set using one of the following variables:




Read Only

Prevents users from adding, removing, or modifying files.

The Read Only attribute is not available for the Update, Submit, Lock, Nested Workflow, URL, and Dummy tasks.

The value can be True, False (this is the default), or set using one of the following variables:




Interwoven, Inc. 70


Transfer Only

When set to True and the Lock attribute is also set to True, files that were locked by a predecessor task will have the lock modified when a task becomes active.

The Transfer Only attribute is not available on the Submit, Lock, Nested Workflow, and Dummy tasks.

The value can be True, False, or set using one of the following variables:




Variables

Variables define a key/value pair that can be stored in and retrieved from job instances. They are used to allow separate CGI tasks and external tasks to communicate with each other during job execution.

1. In the Properties pane, click the blank field next to Variables to display the Variables dialog box:

Figure 34 Variables dialog box

2. Enter a name for this Task variable in the Name field.

3. Enter a value, or select a value for the variable from the Value drop-down list. The options are:






System Variables. See “TeamSite System Variables” on page 65.

4. Click Add.

A variable ID is created using the name you entered in the Name field and the variable name from the Value field. The variable ID takes the form Name=Value(system_generated_ID) and is displayed in the text field. For example: reviewStart=CONFIGURABLE(1145748077956).

NOTEVariable IDs containing the $time value do not include the system-generated ID.

5. Click OK.

EA Finish Op

Defines how you can set, append, or delete TeamSite extended attributes on the files associated with a task when the task becomes inactive.

1. In the Properties pane, click the blank field next to EA Finish Op to display the EA Finish Op dialog box:

Figure 35 EA Finish Op dialog box

2. Select the operation you want to perform on the extended attributes when the task becomes inactive from the Operation drop-down list. The options are:

Set

Append (this is the default operation)

Delete

Interwoven, Inc. 72


3. Enter a name for the operation in the Name field.

4. Enter a value, or select a value for the operation from the Value drop-down list.

The options are:




5. Click Add.

A variable ID is created using the operation you entered in the Operation field, the name you entered in the Name field, and the variable name from the Value field.

The variable ID takes the form Operation:Name=Value(system_generated_ID) and is displayed in the text field. For example:

append:test=CONFIGURABLE(1145749393194).

6. Click OK.

EA Start Op

Defines how you can set, append, or delete TeamSite extended attributes on the files associated with a task when the task becomes active.

1. In the Properties pane, click the blank field next to EA Start Op to display the EA Start Op dialog box:

Figure 36 EA Start Op dialog box

2. Select the operation you want to perform on the extended attributes when the task becomes active from the Operation drop-down list.



The options are:

Set


Delete



The options are:




5. Click Add.




6. Click OK.

WF Variables Finish Op

Defines how you can set, append, or delete TeamSite workflow variables on the job properties when the task becomes inactive.

1. In the Properties pane, click the blank field next to WF Variables Finish Op to display the WF Variables Finish Op dialog box:

Figure 37 WF Variables Finish Op dialog box

Interwoven, Inc. 74


2. Select the operation you want to perform on the variable when the task becomes inactive from the Operation drop-down list.

The options are:

Set


Delete



The options are:




5. Click Add.




6. Click OK.

WF Variables Start Op

Defines how you can set, append, or delete TeamSite workflow variables on the job properties when the task becomes active.

1. In the Properties pane, click the blank field next to WF Variables Start Op to display the WF Variables Start Op dialog box:



Figure 38 WF Variables Start Op dialog box

2. Select the operation you want to perform on the variable when the task becomes active from the Operation drop-down list.

The options are:

Set


Delete



The options are:




5. Click Add.


The variable ID takes the form Operation:Name=Value(system_generated_ID) and is displayed in the text field. For example:append:test=CONFIGURABLE(1145749393194).

6. Click OK.

X

X axis coordinate in the Project pane of the selected element.

Interwoven, Inc. 76


Click the current value to edit it, or click and drag the corresponding element in the Project pane to change this value.

Y

Y axis coordinate in the Project pane of the selected element.

Click the current value to edit it, or drag the corresponding element in the Project pane to change this value.

ID

Unique identifier for the selected element. The ID is same as element name and is a read-only value. If you edit the element name, the ID is updated to reflect the change.



Assigning Workflow-Specific AttributesIn addition to some of the common attributes (described in the beginning on page 57), you can assign the following attributes for a workflow model:

Table 10 Workflow-specific attributes

Property DescriptionDue Date Due date of the workflow model. That is, the date when the workflow

model should be successfully deployed.The date can be set using the Date control available in the Due Date dialog box.

Figure 39 Due Date dialog box

Priority Sets the priority level for the workflow model. The priority level helps users in identifying the importance level of a job.The value can be set to 0 - Very High, 1 - High, 2 - Medium, 3 - Low, 4 - Very Low.

File Comments

Specifies whether a text area should be displayed for each of the attached files during instantiation of a new job in TeamSite.The value can be True or False (this is the default).

Interwoven, Inc. 78


Global Variables

Variables that are available across the workflow model. All the workflow model elements can use these variables. You can add more than one variable using the Global Variables dialog box.

Figure 40 Global Variables dialog box


Property Description



VA Variables VisualAnnotate variables that determine the functionality and appearance of the VisualAnnotate toolbar of the VisualAnnotate tool. VisualAnnotate is a review tool that enables reviewers to annotate HTML pages using tools installed on their web browsers.For more information on the VisualAnnotate tool, see TeamSite Workflow Developer’s Guide.In the VA Variables dialog box, you can either enter a value or set these variables to a predefined value.

Figure 41 VA Variables dialog box



Interwoven, Inc. 80


For both PreProcessor Command and PostProcessor Command properties, you can specify in-process and out-of-process commands.

NOTEInterwoven recommends you to use in-process commands, as you can have better control over the properties of all the workflow elements.

For an in-process command, the syntax is as follows:

PostProcessor Command

Specifies commands that are sequentially executed just before the workflow job is created, that is, before the job spec XML is generated. After adding the commands, you can specify the order in which they should be executed using the Up and Down buttons.

You can use the post-processor commands to perform a variety of tasks. For example, you can:• Modify the properties of a workflow model’s task.• Remove a file attached to a workflow job.

Figure 42 PostProcessor dialog box

PreProcessor Command

Specifies commands that are sequentially executed just before the instantiation screen is rendered. You can use the pre-processor commands to perform a variety of tasks. For example, you can:• Modify the properties of a workflow model’s task.• Attach an additional file to a workflow job for submission.The dialog box for the PreProcessor Command property is similar to the PostProcessor Command property.





inprocess:<fully-qualified-classname>:[additional parameter]

For example:

inprocess:com.interwoven.processtest.CustomCodeDemo:role=author

For an out-of-process command, the syntax is as follows:

<path to the program that can execute your custom code> <path to your custom code (executable/script)>

For example:

//TS_Server/iw-home/bin/perl c:/test.ipl

For information on developing custom code for in-process commands, see Chapter 9, “Using Custom Code”.

Besides PreProcessor Command and PostProcessor Command properties, you can set values for all the workflow properties using one of the following variables too:




Assigning Task-Specific AttributesThe following sections list tasks that have properties that are unique to them or are shared between only a few task types:

CGI Task Attributes

Deploy Task Attributes

Email Task Attributes

External Task Attributes

Group Task Attributes

Metadata Task Attributes

Nested Workflow Attributes

Review Task Attributes

Submit Task Attributes

Update Task Attributes

URL Task Attributes

Interwoven, Inc. 82


CGI Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attributes for CGI tasks:

Alternatively, you can set the values for all these attributes using one of the following variables:




Deploy Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attributes for Deploy tasks:

Table 11 CGI task attributes

Property DescriptionCGI Script Name Name of the CGI script to be run. When you specify the name

of the CGI script, the TeamSite server automatically locates it because, by default, the script is placed in the following location: iw-home/httpd/iw-bin.

Immediate Specifies whether a CGI task script can run immediately upon the CGI task becoming activated under the situations listed in the description of the CGI task element.The value can be True or False (this is the default).

Table 12 Deploy task attributes

Property DescriptionDeploy Command

URL for the class that includes implementation for invoking a deployment process on files associated with the task and for processing the variables specified using the Variables attribute. By default, the value for Deploy Command is:http://$IW_SERVER/iw-cc/urlexternaltask

You can retain this value or specify the URL to your custom class.



Retry Specifies whether a failure to execute a task results in a subsequent attempt.You can control the frequency of subsequent attempts using the external_task_retry_wait parameter available in the TeamSite server configuration file, iw.cfg. The iw.cfg file is located in iw-home/etc.Set external_task_retry_wait to the number of minutes you want the workflow engine to wait before it re-attempts to run an external task after failing. Defaults to 1 minute.The value can be True or False (this is the default).

Variables Specifies variables used by the Deploy Command attribute to invoke a deployment process using the specified values.

Figure 43 Deploy task–Variables dialog box

You can specify values for the following variables:• odDeploymentName (required). A valid deployment name in the

OpenDeploy server. Do NOT include the file extension. For example, the deployment name should be test, not test.xml.

• ClassName (optional). Fully qualified class that contains custom implementation. If you do not specify a class, the following default class is used: com.interwoven.ui.teamsite.workflow.task.urltask.DeployURLExternalTask

• odHost (optional). Name of the server where OpenDeploy is running. It is optional if OpenDeploy and TeamSite are running on the same server.

• odPort (optional). Port where OpenDeploy is running. The default value is 9173. If left blank, the default value is used. It is optional if OpenDeploy and TeamSite are running on the same server.



Interwoven, Inc. 84


Email Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attributes for Email tasks:

OD Variables Key-value pairs that are added to the task as task variables.The keys of these variables will be prefixed with the keyword odSubst_. For example, if you add a variable with the name test, then it will be changed to odSubst_test.These variables are used to pass additional information to Deploy Command.

Figure 44 OD Variables dialog box

Table 13 Email task attributes

Property DescriptionEmail Command

URL for the class that includes implementation for generating an email and for processing the variables specified using the Variables attribute.By default, the value for the Email Command property is:http://$IW_SERVER/iw-cc/urlexternaltask

You can retain this value and use default email templates, which can be specified using the Variables attribute.Alternatively, you can develop your own class and specify its URL.





Variables Specifies variables used by the Email Command attribute to format the email and to transfer control to the specified task after completing the Email task execution.

Figure 45 Email task–Variables dialog box

You must specify values for the following variables:• mail_template. Template (XSL) to be used for generating emails.

Include the path too. For example, /iwadmin/main/config/STAGING/workflow/email/configurableAuthorNotification.xsl

• ClassName. Fully qualified class that contains implementation for processing the specified email template. For example, com.interwoven.ui.teamsite.workflow.task.urltask.AuthorMailNotificationTask

• target_task_name. Name of the workflow model task that should be activated after the Email task is executed. For example, ReviewTask3

If you are using default mail templates and classes, use the following combination: • For authorNotification.xsl or

configurableAuthorNotification.xsl, use the AuthorMailNotificationTask class.

• For reviewerNotification.xsl or configurableReviewerNotification.xsl, use the ReviewerMailNotificationTask class.



Interwoven, Inc. 86






After setting these values, modify the iw.cfg file, which is the main TeamSite server configuration file. By default, the file is located in /etc (Solaris) or iw-home/etc (Windows).

Under the [iwsend_mail] section of the iw.cfg file, assign appropriate values to the maildomain and mailserver variables. See the following example:...

...[iwsend_mail]

maildomain=mycompany.com

mailserver=mail.mycompany.com...

...

In addition, ensure that correct email IDs are specified for TeamSite users (author, reviewer, and so on) who will receive emails.

For information on editing TeamSite user details, see ContentCenter Professional User’s Guide or the online documentation for ContentCenter Professional.

Retry Specifies whether a failure to execute a task results in a subsequent attempt.You can control the frequency of subsequent attempts using the external_task_retry_wait parameter available in the TeamSite server configuration file, iw.cfg. The iw.cfg file is located in iw-home/etc.Set external_task_retry_wait to the number of minutes you want the workflow engine to wait before it re-attempts to run an external task after failing. Defaults to 1 minute.The value can be True (this is the default) or False.





External Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attributes for External tasks:





For an External task example, see TeamSite Workflow Developer’s Guide.

Table 14 External task attribute

Property DescriptionCommand Defines the command to be run in conjunction with a task. For

example, it may run an anti-virus software to check attachments to an email message in an Email task.You need to specify the full path of the command or program to be run, optionally followed by any initial arguments. You can use variables (for example, $IW_HOME) within the path specification.

Retry Specifies whether a failure to execute a task results in a subsequent attempt.You can control the frequency of subsequent attempts using the external_task_retry_wait parameter available in the TeamSite server configuration file, iw.cfg. The iw.cfg file is located in iw-home/etc.Set external_task_retry_wait to the number of minutes you want the workflow engine to wait before it re-attempts to run an external task after failing. Defaults to 1 minute.The value can be True or False.

Interwoven, Inc. 88


Group Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attributes for Group tasks:





Table 15 Group task attributes

Property DescriptionShared by Specifies a set of users or set of groups who share this group task.

Clicking the Shared by text field displays a dialog box where you can add TeamSite users and groups.You can enter the User and Group values directly.

Figure 46 Shared By dialog box

Retain Owner Specifies whether the owner of a Group task retains the ownership of the task upon subsequent activations (for example, during a looping process).The value can be True or False (this is the default).



Metadata Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attributes for Metadata tasks:





Nested Workflow Attributes

A nested workflow is a workflow that is contained within a job. It is initiated by one of the tasks of the job. The implementation of a nested workflow is similar to External and CGI tasks, where the activation of tasks is either automatically or manually instantiated, causing an association of a new job with the workflow task. The nesting process creates a parent/child relationship with the task as the parent and the job as the child.

The relationship between a workflow task and its nested workflow includes:

The ability to pass variables and file lists from the parent task to the child job.

The ability for nested jobs to pass some or all variables and file lists to the parent job upon the child job’s completion.

The ability for the child job to cause a transition to occur in the parent task upon the child job’s completion.

The lifetime of a nested job is dependent upon its parent task’s workflow lifetime—it should not be removed from the Content Store until its parent task is deleted.

Table 16 Metadata task attributes

Property DescriptionMD Capture UI By default, it calls iwmetadata.cgi (the metadata capture CGI

program) to display the metadata capture GUI where end-users can associate metadata with the files associated with the task.Click the MD Capture UI field to display a dialog box where you can specify the CGI program.For more information on using metadata to describe data in files, and organizing and managing the files, see the TeamSite Administration Guide.

Immediate Specifies whether a metadata capture script can run immediately when the Metadata task is activated in the situations listed in the description of the Metadata task element.The value can be True or False (default value).

Interwoven, Inc. 90


Workflow tasks can be specified with a path to a job specification file. Upon activation of the workflow task, TeamSite compiles and instantiates a new job using the specification file.

In addition to the common attributes (described on page 57), you can assign the following task-specific attribute for Nested Workflow tasks:

Review Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attributes for Review tasks:

Table 17 Nested Workflow task attributes

Property DescriptionWorkflow Specifies a workflow that can be a job specification file, a

workflow model (.ipm), or a workflow template file (.wft).You can enter the value directly or set it using one of the following variables:• CONFIGURABLE. See “Configurable Variables ($IW_CV)” on

page 58.• DATASOURCE. See “Datasource Variables ($IW_DS)” on

page 60. • SCRIPT. See “Script Variables ($IW_SCRIPT)” on page 62.

Table 18 Review task attributes

Property DescriptionAvailable Groups

Specifies a list of groups available for review. You can identify group(s) of reviewers from this list in the Reviewers dialog box and during workflow configuration and instantiation in TeamSite.

Available Users

Specifies a list of users available for review. You can identify reviewers from this list in the Reviewers dialog box and during workflow configuration and instantiation in TeamSite.



Reviewers Specifies the reviewers.This attribute is required. The value specified for this attribute is saved in the WorkflowModelName_config.xml file, and is referenced in the workflow model using the $IW_Reviewer variable.In the Reviewers dialog box, you can select users and/or groups from the lists of available users and available groups.

Figure 47 Reviewers dialog box

You can use the Minimum Number of Reviewers field to specify the minimum number of reviewers required to complete the Review task. Note that a group is considered as one reviewer. Any user of the group can take the review ownership.For the Minimum Number of Reviewers field, if you specify a value higher than the selected number of reviewers, you will not be able to instantiate a job in TeamSite. This is not validated at the client-side, that is, Interwoven Workflow Modeler does not validate it. However, during a job instantiation in TeamSite, you are prompted to select at least the specified number of reviewers.You can modify the selected list of reviewers and the minimum number of reviewers for different branches or folders during the workflow configuration. However, you cannot modify the lists of available users and available groups. If you need a different set of users and groups, add new users and groups in the workflow model using Interwoven Workflow Modeler.

Return On First Reject

Specifies whether the workflow will return to the author as soon as a single reviewer rejects, bypassing all remaining reviewers.This field cannot be changed if the Review Type attribute is set to Concurrent. The value can be True or False (the default value).



Interwoven, Inc. 92


Alternatively, you can set the values for all these attributes (except Reviewers) using one of the following variables:




Submit Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attributes for Submit tasks:

Review Type The type of review. It can use one of the default types:• Serial. After one approver approves the content it is passed to the

next reviewer. It is returned to the author if it is rejected.• Concurrent. Multiple reviewers have the opportunity to approve or

reject the content simultaneously.Notify Reviewer

Specifies whether emails should be sent to the reviewers. Note that an email is sent only if the reviewer is a user. If you specify a group as the reviewer, the email is not sent.The value for this attribute can be True or False (the default value).

Table 19 Submit task attributes

Property DescriptionSubmit Comment Submit comments for the associated files.

Displays a dialog box where you can enter a comment.Submit Info Submit information for the associated files.

Displays a dialog box where you can enter a comment.Override Specifies whether conflicting versions of files in the staging

area can be overwritten.The value can be True, False (the default value).

Save Comments Specifies whether to allow comments that were directly associated with the files during the course of the workflow to remain associated with those files after the files have been submitted.The value can be True or False (the default value).

Skip Conflicts Specifies that files with conflicts cannot be submitted.The value can be True or False (the default value).

Skip Locked Specifies that locked files cannot be submitted.The value can be True or False (the default value).









Update Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attributes for Update tasks:





Unlock Specifies that files be unlocked after the submit operation.The value can be True or False (the default value).

Table 20 Update task attribute

Property DescriptionSource Area V Path Specifies the source area from where the files are copied. This

value is required.The value can be entered directly.

Delete Specifies whether deleted files are propagated to the destination area.The value can be True (this is the default value) or False.

Overwrite Mode Specifies whether to overwrite conflicting versions of files in the destination area.The value can be True or False (this is the default value).

Table 19 Submit task attributes


Interwoven, Inc. 94


URL Task Attributes

In addition to the common attributes (described on page 57), you can assign the following task-specific attribute for URL tasks:

Assigning Common Link AttributesLike tasks, links also have common and link-specific attributes associated with them in the Interwoven Workflow Modeler Property pane. The common properties are described in this section and the link-specific properties in the next section.

All links have the following three properties in common:

Name

Type

ID

These properties are described in the following sections.

Name

The Name property uses the form: FlowNumber where Number represents the total number of elements in the workflow model after the link is added.

For example, if you add a Default link to a workflow model that contains only a Start node and a User task, the link is the third element added to the workflow model and is assigned the name Flow3.

You can click the assigned name in the Property pane and type a new name. The Tree pane reflects the change.

Table 21 URL task attributes

Property DescriptionURI Uniform Resource Identifier to be invoked by an external

command.A dialog box appears where you can enter the URL or have it set by one of the following variables:• CONFIGURABLE—See “Configurable Variables ($IW_CV)” on

page 58.• DATASOURCE—See “Datasource Variables ($IW_DS)” on

page 60. • SCRIPT—See “Script Variables ($IW_SCRIPT)” on page 62.



Type

The Type property is one of the following seven link types:

For more information on these link types, refer to “Links Toolbar” on page 34.

ID

The ID property is a unique, read-only, system-generated identifier for the link. It is always the same as the link’s Name property.

For example, if you add a Timeout link between User Task2 and User Task3, and the link is the eleventh element added to a workflow model, it is assigned the Name and ID Flow11 in the Properties pane.

The same link appears as Flow11(UserTask2 -> UserTask3) in the Tree pane, and is represented by a purple line labeled Timeout in the Project pane (the Project pane displays any link type in red when it is selected).

Assigning Link-Specific AttributesThe following links have link-specific attributes that you can set in the Properties pane:

Timeout Links

Conditional Links

Timeout Links

Timeout links specify a time limit for the completion of a task. When the user-defined time period has passed, the task becomes inactive and the tasks connected by the link are made active.

To create a Timeout Duration attribute for a Timeout link:

1. Click a Timeout link in the Tree view or Project pane.

2. In the Properties pane, click the text field next to the Timeout Duration property.

The Timeout Duration dialog box appears.

• Default • Success • Reset • Failure • Inactivate • Conditional • Timeout •

Interwoven, Inc. 96


Figure 48 Timeout Duration dialog box

3. Optionally, you can select one of the following variables to represent the timeout duration from the unlabeled drop-down list:




4. Select one of the following Timeout type options:

Absolute. The task becomes inactive and the workflow is transitioned to the next task on a specific date and time.

Relative. The task becomes inactive and the workflow is transitioned to the next task after a specified amount of time has passed since the current task became active, for example, 48 hours after a task was assigned to a user.


To construct an Absolute timeout, select a month, year, day of the month, hour of the day, and minute of hour from the corresponding GUI elements.

The Absolute timeout duration uses a 24-hour clock, so if the Hours field is set to 16, and the Minutes field is set to 20, the task transitions at 16:20 or 4:20PM.

To construct a Relative timeout, set the number of hours and minutes in the Hours and Minutes fields.

6. Click OK.



Conditional Links

Conditional links define the workflow path on which to continue only if a condition evaluates to True. You can link two tasks with any number of conditional links, but you should also link them by a Default link, so that if all conditional links evaluate to False, the workflow can continue using the Default link.

To create an Expression attribute for a Conditional link:

1. Click a Conditional link in the Tree view or Project pane.

2. In the Properties pane, click the text field next to the Expression property (the default value reads False).

A drop-down list displays the following options:

False. The workflow continues over this link if the condition of the current task evaluates to False.




True. The workflow continues over this link if the condition of the current task evaluates to True.

Working with Logical NodesInterwoven Workflow Modeler includes three logical nodes that enable links to be qualified with the logical gates AND, OR, or NOT. These nodes specify the conditions under which a task becomes active.

AND. All tasks linked to this node must be completed to activate a successor task.

OR. One of the tasks linked to this node must be completed to activate a successor task.

NOT. None of the tasks linked to this node must be completed to activate a successor task.

When a task is completed, it signals the successor task that evaluates the logic defined by the logical node to determine if it should be activated.

For example, if you want Task 3 to be activated only if Task 1 and Task 2 have been completed, create links from Task 1 and Task 2 to an AND node, then create a link from the AND node to Task 3:

Interwoven, Inc. 98


Figure 49 AND node

Logical Node Attributes

Similar to tasks and links, logical nodes also have the following attributes that you can assign in the Properties pane:

GatewayType

Name

X

Y

ID

GatewayType

The GatewayType property is one of the following three node types:AND

OR

NOT

Name

The Name property uses the form: GatewayNumber where Number represents the total number of elements in the workflow model after the node is added.

For example, if you add an AND node to a workflow model that contains only a Start node and a User task, the node is the third element added to the workflow model and is assigned the name Gateway3.

You can click the assigned name in the Property pane and type a new name. The Tree pane and Project pane reflect the change.

X

X axis coordinate in the Project pane of the selected node.



Click the current value to edit it, or click and drag the corresponding node in the Project pane to change this value.

Y

Y axis coordinate in the Project pane of the selected node.

Click the current value to edit it, or drag the corresponding node in the Project pane to change this value.

ID

The ID property is a unique, read-only, system-generated identifier for the link. It is always the same as the link’s Name property.

For example, if you add an OR node to a workflow model, and the node is the eleventh element added to a workflow model, it is assigned the Name and ID Gateway11 in the Properties pane.

The same link appears as Gateway11(Gateway11) in the Tree pane, and is represented by the OR node icon in the Project pane (the Project pane displays the node outlined in red when it is selected).

Interwoven, Inc. 100

Chapter 5

Predefined Workflow Models

This chapter describes the sample workflow models shipped with the product. These sample workflow models are located at the following location:

//TS_Server/iwadmin/main/workflowModels/STAGING/Models

An editable version is also stored in the following workarea:


These workflow models are available for your use and also illustrate the tasks and transitions included in the workflow models. They have features and supporting files that make them easier to use. It is recommended that you use or revise these workflow models when possible. The configurable steps for these workflows are marked as “optional”.

NOTETo ensure that your existing sample workflows are not overwritten, the latest sample workflows (which include some changes) are deployed at: <iw-home>\install\AdminStore\workflowModeler\Models. If required, you can get the latest sample workflows from this location.


Chapter 5: Predefined Workflow Models

Author Submit with Deploy

Figure 50 illustrates an author submit combined with a deployment.

Figure 50 Diagram of the Author Submit with Deploy solution workflow

1. When a new job is instantiated, the author is prompted for the following information:• Submit comment (required)• Information comment

(optional)• Individual file comments

(optional)

2. When the job is initiated, an email notification is sent to an approver.

3. Author clicks Review Work to submit modified files.

4. Author-submitted content is sent to an approver. The approver is defined as the owner of the workarea from which the files are submitted.

5. The approver either:• Approves the work. • Rejects the work (which is

sent back, as a task, to the author who modifies the work, and resubmits it for approval by clicking Review Again on that task).

6. When approved, the files are submitted to the staging area.

7. The files are then deployed to the specified location.

Note: The deploy script need to be configured before using this workflow model.

Review Work

Author Work

Approveiw_areaowner

reject

approve

Submitiw_areaowner

End

failure

retryDeploy Resolve Deployment

Problem



Author Submit with Email

Figure 51 illustrates an author submit combined with an email.

Figure 51 Diagram of the Author Submit with Email solution workflow



(optional)

2. When the job is initiated, an email notification is sent to an approver.

3. Author submits modified files. The files are sent to the approver, who is defined as the owner of the workarea to which the files are submitted.


sent back, as a task, to the author who modifies the work, and resubmits it for approval by clicking Author Rework on that task). When resubmitted, another email is sent to the approver).


Author Finish

Author Work

Email to Approver

reject

Submit

End

Approveiw_areaowner

approve

iw_areaowner



Author Submit with Metadata

Figure 52 illustrates an author submit with metadata capture.

Figure 52 Diagram of the Author Submit with Metadata solution workflow



(optional)

2. Author clicks Metadata to capture metadata.

3. Author-submitted content is then processed for metadata capture (by either the TeamSite Tagger GUI or through MetaTagger integration).

4. Author-submitted content is sent to an approver. The approver is defined as the owner of the workarea from which the files are submitted.


sent back, as a task, to the author who modifies the work, and resubmits it for metadata capture and approval by clicking Author Rework on that task).


Metadata

Author Work

Metadata Captureiw_user

reject

Submitiw_areaowner

End

Approveiw_areaowner

approve



Configurable Author Assignment

Figure 53 illustrates a configurable author assignment.

Figure 53 Diagram of the Configurable Author Assignment solution workflow

1. A new job is initiated; the initiator may have already selected files to be worked on by the author (prior to initiating the job) or may attach them to the job.

2. (Optional) Email notification of the assigned work and any associated files is sent to the author.

3. Author completes assigned work and marks the task as Done.

4. (Optional) Content is processed for metadata capture (by either the TeamSite Tagger GUI or through MetaTagger integration).

5. Work is submitted to the reviewer for approval or rejection.

6. The reviewer either:• Approves the work, in which case

the files are submitted to the staging area.

• Rejects the work, in which case the job is returned to step 2.

7. (Optional) The file is deployed to the specified location (email is sent to the initiator if there is a deployment problem).

New Job

Email to Author

Metadata Capture

reject

Submitiw_areaowner

approve

(optional)Add Files to Job

(optional)

End

failure

retry(optional) Deploy Resolve Deployment

Problemiw_areaowner

Email Notification ofDeployment Problem

(optional)

cancel job

(optional)

Author Work

Review



Configurable Author Submit

Figure 54 illustrates a configurable author submit.

Figure 54 Diagram of the Configurable Author Submit solution workflow

1. Author submits modified files, which initiates a new job and prompts the author for the following information:• Submit comment (required)• Information comment


(optional)2. (Optional) The author selects additional files to be submitted.3. (Optional) Author-submitted content is then processed for metadata capture (by either the TeamSite Tagger GUI or MetaTagger integration).

4. Work is submitted to the review subflow for approval or rejection.

5. The reviewer either:• Approves the work and the

files are submitted to the staging area.

• Rejects the work, in which case an optional email requesting revisions is generated and a revision task occurs.


Submit

Author Work

Metadata Capturereject

Submitiw_areaowner

approve

(optional)Email to Author

iw_user

(optional)

End

failure


Problemiw_areaowner


(optional)

cancel job

Review

(optional)Add Files to Job



Configurable Default Submit

Figure 55 illustrates a configurable default submit.

Figure 55 Diagram of the Configurable Default Submit solution workflow

Configurable Workflow OverviewThe following three solutions workflows are activated by default and are configurable:

configurable_author_assignment.ipm

configurable_author_submit.ipm

configurable_default_submit.ipm

Each of the configurable workflows has a number of configurable options. CONFIG and DATASOURCE variables are used to hold values for configurable options. These configurable variables are specified in an external configuration file called WorkflowName_config.xml. For example, the configurable_author_submit.ipm file has a corresponding configuration file called configurable_author_submit_config.xml. This configuration file is described in “Workflow-Specific Configuration Files” on page 108.

1. A user—whose work does not need review—submits a file.

2. (Optional) Content is processed for metadata capture (either in the TeamSite Tagger GUI or through MetaTagger integration), then submitted to the staging area.


Submit

Metadata Capture

Submitiw_user

iw_user

(optional)

End

failure


Problemiw_areaowner


(optional)

cancel job



Workflow-Specific Configuration FilesThis section introduces the workflow-specific configuration files used by files in the //TS_Server/iwadmin/main/workflowModels/STAGING/Models folder.

Workflow.cfg File Overview

Each WorkflowName_config.xml file contains entries for a number of optional features. The configuration of a feature (for example, email notification) is identical in each workflow where it is included. The following list contains the configurable features that are available in each of the config (.xml) files.

configurable_author_submit_config.xmlAdd Files

Deployment

Email Notification

Metadata Capture

Review

configurable_default_submit_config.xmlDeployment

Email Notification

Metadata Capture

configurable_author_assignment_config.xmlAdd Files

Deployment

Metadata Capture

Review

VisualAnnotate and Configurable WorkflowsVisualAnnotate is a review tool that is installed by the TeamSite installation program. It enables users to annotate HTML pages from within their browser window. Reviewers can draw, change text, and add “sticky notes” directly on the pages they are viewing. These annotations are stored separately from the file as extended attributes.



VisualAnnotate reviews are implemented within the following solution workflows:Configurable Author Submit

Configurable Author Assignment

Using or adapting these solutions eliminates the need to build separate VisualAnnotate workflows. Global variables are used for VisualAnnotate.

For more information about VisualAnnotate and its configuration, see TeamSite Workflow Developer’s Guide.

NOTEAs VisualAnnotate is not supported on non-English servers, remove the VisualAnnotate functionality from these workflows before using them on a non-English server.


Chapter 6

Managing and Configuring Workflow Models

This chapter primarily describes the procedures for managing and configuring workflow models after they are published to the TeamSite server from the Interwoven Workflow Modeler. It includes the following sections:

Understanding Workflow Roles

Published Workflow Models in TeamSite

Managing Workflow Models

Configuring Workflow Models

Understanding Workflow RolesThe ability to publish, manage, and configure workflow models is subject to the role defined in TeamSite. To maintain existing privileges given to TeamSite users and to ensure that Interwoven Workflow Modeler functions properly, the following out-of-the-box roles are available in TeamSite:

WorkflowUser Role

WorkflowAdmin Role

WorkflowUser Role

By default, all TeamSite users should be able to use workflow models. To achieve this, the workflowModels branch of the iwadmin store is shared for iwEveryone with the WorkflowUser role. However, the users with this role have bare minimum permissions, just enough to execute and view workflows. Users do not have permissions to design and publish a workflow.

NOTESThe iwEveryone group is automatically added to the workflowModels branch with the WorkflowUser role. You do not have to add it manually.


Chapter 6: Managing and Configuring Workflow Models

Permissions of the WorkflowUser role have been reduced in TeamSite 6.7.1 SP1. In TeamSite 6.7.1, the iwEveryone group had the Modify access to the iw-wa workarea. However, in TeamSite 6.7.1 SP1, the iwEveryone group has the Readonly access.

WorkflowAdmin Role

All TeamSite users are not allowed to publish, subscribe, and configure workflow models. Only a certain group of people are allowed to perform these operations. The WorkflowAdmin role is for those users. Normally, these users include workflow developers or TeamSite administrators.

The WorkflowAdmin role has privileges to publish and save workflow models to TeamSite. In addition, it has privileges to manage, configure, and debug the workflow models.

You should manually add users to the workflowModels branch with the WorkflowAdmin role. You should not assign this role to the iwEveryone group, unless required.

NOTEUsers who belong to the WorkflowAdmin role should also have the Modify access in the iwadmin/main/workflowModels/WORKAREA/iw-wa workarea. You need to add this manually. In addition, you need to manually assign full permissions for each folder (and its files) of the iw-wa workarea: Config, Instance, Internal, and Models.

Users with the WorkflowAdmin role can perform the following operations in TeamSite:

Configure workflow model

Copy files and folders

Create file

Create folder

Delete files and folders

Download

Edit

Import

Lock file

Manage workflow model

Modify file extended attributes

Move files and folders

Preview file

Publish workflow model



Submit

Transition task

Unlock file

Update workarea

View file history

Web view workflow model

The operations specific to workflow models have been included under the Workflow category (select Administration > Roles and Permissions > Manage Roles > Edit).

The key operations are as follows:

Manage Workflow Model. Users can add or remove workflows allowed for a branch or vpath. They can specify the users who can instantiate these workflows. They have access to the Manage Workflows link in the Administration tab and in the Properties link present in the Content tab.

Publish Workflow Model. Users can use Interwoven Workflow Modeler to publish workflows to TeamSite.

Configure Workflow Model. Users can configure or customize the workflows for different branches. They can provide default values or make certain fields hidden or visible during instantiation.

Webview Workflow Model. Users can view the workflow in a browser. They can check the values of the properties for each task and track the workflow after instantiation.

Operations Summary for Workflow Roles

The following table provides a summary of operations allowed for the WorkflowAdmin and WorkflowUser roles.

Published Workflow Models in TeamSiteWhen you publish a workflow model from the Interwoven Workflow Modeler, it is published to the Staging area on a branch called workflowModels in the iwadmin store:

//TS_Server/iwadmin/main/workflowModels/STAGING/Models (shown in Figure 56)

Table 22 Operations summary for workflow roles

Role Publish Workflow

Manage Workflow

Configure Workflow

Web View Workflow

Execute/Run Workflow

WorkflowAdmin Yes Yes Yes Yes YesWorkflowUser No No No Yes Yes



An editable version is also stored in the following Workarea:


Figure 56 workflowModels branch

WorkflowModels Branch Contents

The Content tab of the workflowModels branch contains a folder structure that stores the files used by TeamSite to implement and configure workflow models. The structure is shown in the graphic, which is followed by the structure description.

Figure 57 Content tab of WorkflowModels branch

Config. Contains subfolders of the format modelName_config (where modelName is the file name of the published workflow model) that contain the configuration file (default_config.xml) associated with a each workflow model. The default_config.xml file includes default values for the instantiation form fields.

Instance. Contains the ModelInstance folder that includes the workflow model XML file created when a workflow model is instantiated to create a new job. The file is named as jobid_modelName.ipm. After the job is finished, the file is deleted.



NOTEThe file deletion does not happen synchronously. It may take a few seconds, depending on the server load. File deletion depends on the event subsystem. Therefore, if the event subsystem is stopped on the TeamSite instance, files will not get deleted and you have to manually delete the files associated with each workflow job.

In these instance models, the configuration information is resolved and saved within the model itself. The instance models are used to produce the in-progress web view of the model that shows the status of a job on the Workflow tab:

Figure 58 Workflow model icon

Internal. Contains the following two files (normally). It can contain any other files too.

available_models.xml. Determines which workflow models are available and their subscription information. If you are familiar with the previous versions of TeamSite workflow, you will find this file similar to the available_templates.cfg workflow template file. This file is described in detail in “Managing Workflow Models” on page 116.

default_config.cfg. Default Customization screen that appears for all workflows. It enables end-users to customize a workflow for a given branch, folder, or workarea.

NOTEdefault_config.cfg includes a specific reference to the DTD file—http://localhost/iw-cc/workflowModeler/ProcessModelConfiguration.

dtd. If the TeamSite server URL is changed (for example, if the port number or the machine name is changed), you need to edit this file and specify the correct URL. For any other reason, you should not modify files or subfolders contained within the Internal folder.

Models. Contains the workflow model files (.ipm) that have been published from Interwoven Workflow Modeler.

Workflow model icon



For information on the functionality available on the Workflow and Administration tabs, click the Help link contained in either screen.

Managing Workflow ModelsThe available_models.xml file controls which workflow models are available to each branch. It is an XML configuration file that lists all of the workflow models that are available for use on the TeamSite server. For each workflow model, this file indicates the name of the workflow model, branch(es) for which the workflow model can be instantiated, and the conditions under which the workflow model is available.

NOTEConcurrent updates to the available_models.xml file are not supported. For example, while user 1 is editing the available_models.xml file, if user 2 opens, edits, and saves the file, then user 1 will not be able to save the changes.

The available_models.xml File

This section provides detailed information on various elements of the available_models.xml file.

The container element in the available_models.xml file is the available_models element. This element contains the following attribute:

require_workarea. specify whether (true) or not (false) workflow models selection screen will include a branch/workarea chooser if workarea context is not present. Most of the out-of-the-box workflow model examples require this to be enabled (require_workarea="true") to work properly. Default value is true.

Within the available_models element is the model element:<available_models require_workarea="true">

<model debug="true" active="true" filename="Author_Submit"

name="Author Submit">

...

...

</model>

</available_models>

The model element has the following attributes:

debug. specify whether the workflow model is in the debug (true) or production (false) mode. If debug is set to true, a radio button appears in the job instantiation screen, which enables you to select the mode. If debug is selected, the workflow job is not created, instead the XML content is displayed within the job instantiation screen.



active. indicate whether (true) or not (false) the workflow model is enabled. The default value is yes. If active is set to false, the workflow will not be visible to users for instantiation.

filename. specify the name of the workflow model file without its extension (.ipm). For example, if the file name is Author_Submit.ipm, the attribute value is as follows:

filename="Author_Submit"

name. specify the title of the workflow model, for example:

name="Author Submit Workflow"

This value is used as the display name for the workflow model. The name specified here must be unique.

Specifying Workflow Model Access

You can configure access to each workflow model listed in the available_models.xml file by using any combination of the following categories:

command

role

group

user

branch-vpath

vpath-regex

You can combine categories using boolean terms such as AND, OR, and NOT to include and exclude those that meet the inclusion or exclusion criteria.

Workflow model access is configured within the allowed element, which is a sub-element of model.

Within the model element is the allowed element, where you can configure user access by matching workflow commands with user roles:<model ...>

<allowed>

...

</allowed></model>

Command Access

Workflow commands are specified by the command element. The command element specifies the user-activity that starts the corresponding workflow. For example, the following configuration:



<command name="submit"/>

specifies that the associated workflow is started when performing a Submit and that it cannot be invoked by other means.

The valid command values that you can associate with a workflow are:

submit (submitting files)

assign (assign button or menu item)

new_job (new job)




NOTEThe tt_data command is valid in ContentCenter Standard and can be configured in ContentCenter Professional; see the User Interface Customization Guide. The tt_deletedcr command is only valid when users are using the ContentCenter Standard interface; in ContentCenter Professional, this command is not valid and data records are treated like any other assets.

Role Access

Access based on TeamSite roles is specified by the role element’s name attribute. For example, the following configuration:

<role name="author"/>

specifies that if the user is logged in as an Author.

Group Access

Access based on user groups is specified by the group element:

<group name="marketing"/>

User Access

Access based on individual user name is specified by the user element:

<user name="jdoe"/>



Branch-vpath Access

Access based on a TeamSite branch is specified by the branch-vpath element. You can also specify whether the workflow model should be available to the subbranches or not. For example, the following configuration:

<branch-vpath vpath="/default/main" include-subbranches="true"/>

specifies that the workflow model is also available to the subbranches of /default/main, because the include-subbranches attribute is set to true.

Vpath-regex Access

Access based on regular expressions is specified by the vpath-regex element. You can use regular expressions to search for a specified pattern and specify what to do when matching patterns are found. Using regular expressions allows a greater level of flexibility when adding items.

For example, if you want only the users in the three administration_1 branches (a1, a2, and a3) to access a workflow model, you can set the following constraint:<allowed>

<or>

<branch-vpath vpath="/default/main/administrator_1/a1"/><branch-vpath vpath="/default/main/administrator_1/a2"/>

<branch-vpath vpath="/default/main/administrator_1/a3"/>

</or>...

</allowed>

If a new branch called a4 is added to /default/main/administrator_1 you could manually update the available_models.xml file to allow access for users in the new branch by adding the branch element to the existing ones:<branch-vpath vpath="/default/main/administrator_1/a4"/>

Alternatively, you could modify the available_models.xml file to use the following regular expression and, thus, automate the constraints placed on the a4 branch:

<allowed>

<and>

<vpath-regex regex="/default/main/administrator_1/.*"/></and>

...

</allowed>

This regular expression allows users from any branch under /deault/main/administrator_1 to have access to the workflow model.



Path Separators

When using regular expressions, the path-separators (“\”, “\\”, “/”) are all translated to “/” in both the pattern and the string to match against before attempting the match.

In the following example:<vpath-regex regex="foo"/>

any branch path that includes the string foo will be matched. Here the following examples match:/default/main/food/... /default/main/barfoo/...

In the next example:<vpath-regex="^/default/main/foo"/>

any branch path that begins with the value-string will be matched. Here the following example matches:/default/main/food/...

while this one does not:/default/main/barfoo/...

The following examples are all treated as identical on both Windows and UNIX.<vpath-regex regex="^/default/main/foo"/>

<vpath-regex regex="^\default\main\foo"/>

<vpath-regex regex="^\\default\\main\\foo"/><vpath-regex regex="^/default\main\\foo"/>

Combining Access Categories

Pairings of individual or multiple access elements can be included or excluded using the and, or, and not elements within the allowed element. You can use boolean logic to create combinations of categories that can either have access to a specific workflow model, or be excluded from it.

In the following example:<model filename="Author_Submit" debug="true" active="true" name="Author Submit Workflow">

<allowed><and>

<command name="submit"/>

<or><role name="author"/>

<role name="editor"/>

<group name="marketing"/>

<and><role name="admin"/>

<not>

<user name="jdoe"/>



</not></and>

</or>

</and></allowed>

</model>

the following individuals have access to the Author Submit workflow:

Those who are authorized to perform submit commands.

Those who have the author or editor role.

Those who are members of the marketing group.

Those who have the admin role, with the exception of the user jdoe.

If no access category is specified, it is assumed that category has full access to the workflow model.

The available_models.xml file is validated against the Subscription schema (available_models.xsd). For more information on the Subscription schema, see “available_models.xsd (Subscription schema)” on page 189.

NOTEThe Subscription schema has been modified. Using ContentCenter Professional, when you access the available_models.xml file for the first time, it is automatically updated to adhere to the revised Subscription schema. However, if you do not access the XML file, the old XML file will still be valid. This is because both old and revised versions of the Subscription schema are supported in this release.

When the available_models.xml file is saved, TeamSite checks each branch with an entry in the file to see if there is a custom configuration file, custom_config.xml, available for that branch. If the branch has a custom configuration file defined for it, the instantiation form is generated from the custom configuration file (as described in “Configuring Workflow Models” on page 123). If the branch does not have a custom configuration file defined for it, the default configuration file (located in iwadmin/main/workflowModels/WORKAREA/iw-wa/Config/workflowModelName_config) is used to generate the instantiation form.

You can manage a workflow model’s availability to one or more TeamSite branches using one of the following tabs:

Administration tab

Content tab



Managing Workflow Models Using the Administration Tab

To manage a workflow model using the Administration tab:

1. Log in to ContentCenter Professional.

2. Click the Administration tab.

3. Click TeamSite Admin > Configuration > Workflow Models > Manage Workflows.

The contents of the available_models.xml file are displayed in ContentCenter Professional.

Figure 59 available_models.xml file

4. Add an entry for the workflow model.

For example, to manage the Author Submit workflow model, you can add the following sample entry:....

<model debug="true" active="true" filename="Author_Submit"

name="Author Submit"> <allowed>

<and>

<vpath-regex regex=".*"/> </and>

</allowed>

</model>...

5. Click Save.

The XML is validated against the Subscription schema.

For more information on the Subscription schema, see “available_models.xsd (Subscription schema)” on page 189.



Managing Workflow Models Using the Content Tab

To manage a workflow model using the Content tab:


2. Click the Content tab.

3. Navigate to the store that contains the branches you want.

4. Open the main branch. If sub-branches exist, navigate through them to the branch or folder you want.

5. Click Properties > Workflow Management > Manage Workflows

The contents of the available_models.xml file are displayed (see Figure 59). Repeat steps 4 through 6 mentioned under the section Managing Workflow Models Using the Administration Tab.

Configuring Workflow ModelsTeamSite provides you the flexibility to configure workflow models (listed in the available_models.xml file) for any of the specified branches. When you configure a workflow model for a branch, a custom configuration file, custom_config.xml, is added for that branch.

You can manage a workflow model’s availability to one or more TeamSite branches using one of the following tabs:

Administrator tab

Content tab

Configuring Workflow Models Using the Administration Tab

To configure a workflow model using the Administration tab:


2. Click the Administration tab.

3. Click TeamSite Admin > Configuration > Workflow Models > Configure Workflows.

The workflow models that have been subscribed to a branch or folder appear.



Figure 60 Subscribed workflow models

NOTEIn the available_models.xml file, if you have an entry for a model that does not have its .ipm file in the Staging area, this screen displays an error.

You can click the workflow model icon in the View column to display a web view of a workflow model.

4. Select the workflow model you want to configure, and then click Next.

The branch information is displayed from the available_models.xml file.

Figure 61 Branch information in available_models.xml

The Current Configuration column indicates that one of the following configuration files is being used for each of the branches:

Default. Default configuration file.

Custom. Configuration file being created after configuring a workflow model.

Outdated. A custom configuration files that becomes outdated when the configured workflow model is modified and republished. For more information, see “Working with Outdated Custom Configurations” on page 127.



5. Click Actions in the Edit Configuration column, and then select Edit Configuration to change the configuration file used by the corresponding branch.

If you want to use a custom configuration file for all branches, click Actions for the All Branches option.

The Configure Workflow screen appears.

Figure 62 Configure Workflow screen

6. Edit one or more of the variables to customize the information that is displayed on the Instantiation Form generated on the specified branch.

7. Click Save.

When you save the custom configuration, TeamSite does the following:

a. Creates a custom_config.xml file for the specified branch(es).

b. Replicates the directory structure of the branch(es) under the//TS_Server/iwadmin/main/workflowModels/WORKAREA/iw-wa/Config/<WorkflowModelName>_config folder, and stores the custom_config.xml file in that location.

For example, if you configure the samplereview workflow model for the branch //TS_Server/default/main, the vpath of the custom_config.xml file is as follows://TS_Server/iwadmin/main/workflowModels/WORKAREA/iw-wa/Config/samplereview_config/default/main

c. Submits the custom_config.xml file to the Staging area.



Considering the above example, the Staging area vpath of the custom_config.xml file will be as follows://TS_Server/iwadmin/main/workflowModels/STAGING/Config/samplereview_config/default/main

When you instantiate the workflow model, the instantiation form is generated using the custom information for the workflow model.

For example, if you enter Info in the Label field, and Sample information in the Value field in step 6, the form would look like this:

Figure 63 Workflow Instantiation form

Configuring Workflow Models Using the Content Tab

To configure a workflow model using the Content tab:


2. Click the Content tab.

3. Navigate to the store that contains the branches you want.

4. Open the main branch. If sub-branches exist, navigate through them to the branch or folder you want.

5. Click Properties > Workflow Management > Configure Workflows

The workflow models that have been subscribed to a branch or folder are displayed (see Figure 60). Repeat steps 4 through 7 mentioned under the section Configuring Workflow Models Using the Administration Tab.



Selection Order for Custom Workflow Configuration

When you instantiate a workflow model from a branch or folder, a custom workflow configuration is selected in the following order:

1. If you have a custom_config.xml file in the corresponding vpath (including folder) of iwadmin, then that file is used.

2. If you do not have a custom_config.xml file in that vpath, then the immediate parent’s branch-level file is used. A workarea-level file is never considered.

3. If you do not have a custom_config.xml file at the branch level, then the global-level file is used; that is, a custom_config.xml file defined for the workflow.

NOTEThe default_config.xml file resides at this level. Considering the previous example, the vpath of the default_config.xml file is //TS_Server/iwadmin/main/workflowModels/STAGING/Config/samplereview_config.

If you do not have a custom_config.xml file at this level, then system generates a file with the default text, textarea, or radio, depending on the widget defined in the default_config.xml file.

The custom_config.xml file is only used for populating the fields of the instantiation form with default values. To change the default presentation of the instantiation form, you need to create a custom_instantiation.cfg file for the required branch, sub-branch, and/or folder. For more information on creating a custom_instantiation.cfg file, see “Creating Custom Job Instantiation Forms” on page 143.

Working with Outdated Custom Configurations

A custom configuration becomes outdated when the configured workflow model is modified and republished.

As an example, consider that a user performs the following actions:

1. Publishes the XYZ workflow model.

2. Configures it for the branch //TS_Server/default/main/abc.

3. Modifies the XYZ workflow model using Interwoven Workflow Modeler and republishes the XYZ workflow.

Therefore, for the //TS_Server/default/main/abc branch, the Current Configuration column will indicate that the custom_config.xml file is outdated.

When you instantiate a job from that branch, the default configuration is used, not the outdated configuration.



TeamSite provides the flexibility to either use the outdated custom configuration file or to delete the custom configuration file and use the new (updated) default configuration file.

Figure 64 Outdated Custom Configuration

To use the updated default configuration file, click Actions in the Edit Configuration column and select Delete Custom Configuration.

To use the outdated custom configuration file, click Actions in the Edit Configuration column and select Use Outdated Configuration.


Chapter 7

Instantiating Workflows

If you are familiar with instantiating previous versions of TeamSite workflow templates (.wft), you will find that workflow models (.ipm) are instantiated the same way. Workflow models can be instantiated with the following commands (either from the command line or in the GUI):

New Job

Submit

Assign




iwmodelc.bat command-line utilty

NOTEThe tt_data command is valid in ContentCenter Standard and can be configured in ContentCenter Professional; see the User Interface Customization Guide. The tt_deletedcr command is only valid when users are using the ContentCenter Standard interface. In ContentCenter Professional, this command is not valid and data records are treated like any other assets.

Instantiating Workflows in ContentCenter Professional

The ContentCenter Professional GUI contains three options for instantiating workflow models:

New Job

Submit

Assign

Each of these options is described in the corresponding section that follows.


Chapter 7: Instantiating Workflows

Instantiating Workflow Models With the New Job Option

The ContentCenter Professional GUI enables you to instantiate a workflow model using the New Job option from a workarea.

To instantiate a workflow model using the New Job option:

1. On the Content tab of the Content Center Professional GUI, click Actions.

2. Select New Job from the menu that appears.

Figure 65 New Job menu option

The Select a Workflow dialog box appears.

Figure 66 Select a Workflow dialog box



NOTEThe Select a Workflow list contains workflow template-based workflows (Author Assignment in this example) and workflow models (all others). Workflow models are identified by the icon.

3. Select a workflow model, and click Next.

The Instantiate Workflow form appears:

Figure 67 Instantiate Workflow form

NOTEThe Instantiate Workflow form is generated using a Data Capture Template (DCT). As TeamSite provides a facility to create customized forms using DCTs, you have the flexibility to customize these forms. For information on creating a custom instantiation form, see “Viewing Workflow Models in ContentCenter Professional” on page 136. For detailed information on DCTs, see FormsPublisher Developer’s Guide.

Depending on the form’s configuration settings (described in “Configuring Workflow Models” on page 123) the fields may already contain one or more entries, be read-only, or display different values depending on the branch.

4. Provide the requested information, and click Submit.

You can view the new job you instantiated by clicking the Workflow tab:



Figure 68 Jobs listed on the Workflow tab

Instantiating Workflow Models With the Submit Option

The ContentCenter Professional GUI enables you to instantiate a workflow model using the Submit option from a workarea.

To instantiate a workflow model using the Submit option:

1. On the Content tab of the Content Center Professional GUI, select a file you want to submit, and then click Actions.

2. Select Submit from the menu that appears.

Figure 69 Submit menu option







The Instantiate Workflow form appears.







Figure 72 New job listed on the workflow tab

Instantiating Workflow Models With the Assign Option

The ContentCenter Professional GUI enables you to instantiate a workflow model using the Assign option from a workarea.

To instantiate a workflow model using the Assign option:

1. On the Content tab of the Content Center Professional GUI, select a file you want to assign, and then click Actions.

2. Select Assign from the menu that appears.

Figure 73 Assign menu option







The Instantiate Workflow form appears:







Figure 76 New job listed on the Workflow tab

Viewing Workflow Models in ContentCenter Professional

You can view workflow models either before or after they are instantiated. Each option is described in the corresponding section:

“Viewing Workflow Models Before Instantiation” on page 136

“Viewing Workflow Models After Instantiation” on page 137

Viewing Workflow Models Before Instantiation

To view a workflow model before instantiation:

1. Click the Content tab in ContentCenter Professional.

2. Navigate to //TS_Server/iwadmin/main/workflowModels/STAGING/Models.

3. Select the workflow model you want to view.



Figure 77 Selected workflow model on the Content tab

4. Click the Preview link. Web view of the selected workflow model appears (see Figure 81).

NOTEYou can display the web view of a workflow model from the Staging area only. In other words, web view is available for workflow models that are submitted to the Staging area.

Viewing Workflow Models After Instantiation

After workflow models have been instantiated, you can view their progress from the following areas on the Workflow tab:

View Jobs

View Tasks

Job Details

Task Details

To view an instantiated workflow model:

1. Click the Workflow tab in ContentCenter Professional.

2. Click the Jobs or Tasks link.



Figure 78 Jobs and Tasks links on the Workflow tab


In the View Jobs (or View Tasks) area, click the Actions link next to the workflow model you want to view, then select View Workflow Instance.

Figure 79 Viewing workflow instance – View Jobs

In the Job Details (or Task Details) area, click the Actions link for the selected workflow model, then select View Workflow Instance.

Figure 80 Viewing workflow instance – Jobs Details

Web view of the selected workflow model appears.



Figure 81 Web view of instantiated workflow model

1. Overview Area. Use it to get a bird's-eye-view of the workflow model, as it displays the entire workflow model in a miniature form. It is useful when all parts of the workflow model are not within the visible region of the main diagram area.

2. Select Tool. Use it to select various elements on the web view screen.

3. Zoom Mode. Use it to magnify selected parts of the main diagram area. You need to use the click-and-drag action to select a region.

4. Pan Mode. Use it to pan the main diagram area. When active, the cursor turns into a hand.

5. Show All. Use it to fit the content (workflow model) within the visible region of the main diagram area.

6. Zoom In. Use it to increase the magnification of the content in the main diagram area.

7. Zoom Out. Use it to decrease the magnification of the content in the main diagram area.

8. Pan Tool. Use it to pan the main diagram area in various directions. You can use it for viewing all (not-in-view) parts of the main diagram area

9. Property Sheet. Use it to view the properties of the workflow model elements.

23

10

9

81

4567



NOTEProperties with empty values are not displayed in Property Sheet. In addition, co-ordination properties (x and y) are not displayed.

10. Legend Area. Use it to identify the status of each element of the workflow model. This area appears after the instantiation of the workflow model.

Instantiating Workflow Models in ContentCenter Standard

To instantiate a workflow model in ContentCenter Standard:

1. Log in to ContentCenter Standard.

The ContentCenter Standard portal page appears.

2. In the Tasks area, click New Job.

Figure 82 New Job link in ContentCenter Standard

The Select A Workflow screen appears.



Figure 83 Select A Workflow screen



The Instantiate Workflow screen appears:





4. Provide the requested information, and click Next.

A message appears stating that the operation was successful.

5. Click Done.

For more information about working with workflows, tasks, and jobs, see the How Do I... and topic-specific online help in the ContentCenter Standard UI.

Instantiating Workflow Models from the TeamSite Front Office

You can instantiate workflows from the TeamSite Front Office Check In menu option.

Figure 85 Check In option in TeamSite Front Office

For more information on working with workflow, jobs, and tasks in TeamSite Front Office, see the TeamSite Front Office documentation.



Instantiating Workflow Models from the Command Line

Workflow models can also be run from the command line using the iwmodelc.bat command.

The iwmodelc.bat command-line utility is installed by default in the iw-home/bin directory. It is similar to iwjobc.exe documented in the TeamSite Command-Line Utility Guide.

You can find the valid options and arguments for iwmodelc.bat by executing the following command at the command prompt: iwmodelc.

Creating Custom Job Instantiation FormsJob instantiation forms, which are displayed when you create a new job, are generated using Data Capture Templates (DCTs). As TeamSite provides a facility to create customized forms using DCTs, you can customize the presentation of job instantiation forms.

NOTETeamSite 6.7.1 SP1 supports datacapture.6.0.DTD only.

For more information on the DCT syntax, see FormsPublisher Developer’s Guide.

To create a custom job instantiation form:

1. Run the command line tool iwmodeldct.bat.

You can find the valid options and arguments for iwmodeldct.bat by executing the following command at the command prompt: iwmodeldct.

NOTEYou need to refer to the default_config.xml file of the workflow model to know the contents for the custom DCT.

2. Save the DCT with the name custom_instantiation.cfg.

3. Identify the folder (or branch) for which the job instantiation form needs to be customized, and place the custom_instantiation.cfg file in the corresponding vpath of iwadmin.

For example, if you want to customize the instantiation form of the samplereview workflow model for the branch //TS_Server/default/main, you need to place the custom_instantiation.cfg file in the following vpath:



//TS_Server/iwadmin/main/workflowModels/WORKAREA/iw-wa/Config/samplereview_config/default/main

Selection Order for Custom Job Instantiation Form

When you instantiate a workflow model from a branch or folder, the custom job instantiation form is selected in the following order:

1. If you have a custom_instantiation.cfg file in the corresponding vpath (including folder) of iwadmin, then that file is used.

2. If you do not have a custom_instantiation.cfg file in that vpath, then the immediate parent’s branch-level file is used. A workarea-level file is never considered.

3. If you do not have a custom_instantiation.cfg file at the branch level, then the global-level file is used; that is, a custom_instantiation.cfg file defined for the workflow.

NOTEThe default_config.xml file resides at this level. Considering the previous example, the vpath of the default_config.xml file is //TS_Server/iwadmin/main/workflowModels/STAGING/Config/samplereview_config.

If you do not have a custom_instantiation.cfg file at this level, then the system generates a file with the default text, textarea, or radio, depending on the widget defined in the default_config.xml file.


Chapter 8

Using Datasource Framework

IntroductionDatasource framework provides you an easy way to write your own Datasources that can extract data from within TeamSite or any external source. You can use Datasources for the variables of workflow models developed using Interwoven Workflow Modeler or for Data Capture Templates (DCTs) in TeamSite.

The following points summarize the uses of Datasources:

Datasources can pull data from any external application such as LDAP, database, and so on.

Datasources can pull data from within TeamSite. You can use CSSDK inside Datasources to communicate with TeamSite to fetch the data.

Creating a DatasourceTo create a Datasource:

1. Implement a Datasource interface, see “Implementing Datasource Interfaces” on page 145.

2. Register the Datasource with TeamSite, see “Registering a Datasource” on page 148.

3. Deploy the Datasource in TeamSite, see “Deploying a Datasource” on page 149.

Implementing Datasource Interfaces

Datasource framework exposes the following interfaces, which are available for creating Datasources:

SimpleDataSource

ArrayDataSource (deprecated)

ListDataSource

MapDataSource


Chapter 8: Using Datasource Framework

NOTEThe ArrayDataSource interface has been deprecated and will not be supported after a few releases. Therefore, it is recommended that you use the ListDataSource interface (instead of ArrayDataSource), as it provides similar capability.

All your Datasource implementations have to implement at least one of these interfaces to be recognized by the Datasource framework. These interfaces are located in the following file:

iw-home/httpd/webapps/content_center/WEB-INF/lib/datasource.jar

Javadocs for these interfaces are available in the following file:

iw-home/httpd/webapps/content_center/WEB-INF/lib/datasourcedoc.jar

After you create a class that implements one of these interfaces, perform the following steps:

1. Compile the file to create a .class file.

NOTEEnsure that the datasource.jar and DataSourceFrameworkSchema.jar files are in your project’s class path.

2. Create a .jar file using the .class file. The .jar file can have any name, for example, SampleDatasource.jar.

3. Register the Datasource by adding an entry for it in the Datasource configuration file. For information on registering Datasources, see “Registering a Datasource” on page 148.

SimpleDataSource

You must implement this interface if you are creating a Datasource that returns a String.

Signaturepublic interface SimpleDataSource

{

public String execute(String sessionId, String context, Map param);}

ArrayDataSource

You must implement this interface if you are creating a Datasource that returns an array of values.



NOTEThis interface has been deprecated; use ListDataSource instead.

Signaturepublic interface ArrayDataSource

{public String[] execute(String sessionId, String context, Map param);

}

Arguments for SimpleDataSource and ArrayDataSource

The description of the parameters used by the SimpleDataSource and ArrayDataSource interfaces is as follows:

sessionId. Session ID of the currently logged in user.

context. TeamSite vpath.

param. Hash map containing the additional parameters passed using the Datasource configuration file DataSourceConfig.xml or passed while calling the Datasource in the FormsPublisher DCT.

ListDataSource

You must implement this interface if you are creating a Datasource that returns a list of values. It is mostly used for populating a list.

Signaturepublic interface ListDataSource

{public List<String> execute(DataSourceContext context);

}

MapDataSource

You must implement this interface if you are creating a Datasource that returns a map. It is mostly used to populate different display names and display values in lists. Key is used as the display name, and value of the map is used as the actual value.

Signaturepublic interface MapDataSource{

public Map<String,String> execute(DataSourceContext context);

}



Arguments for ListDataSource and MapDataSource

The description of the parameters used by the Datasource interfaces is as follows:

context. An instance of the DataSourceContext class. This class contains methods such as getSessionId, getServerContext, and so on.

For more information, see Javadocs of this class. The class is located under:com.interwoven.datasource.core.DataSourceContext

Registering a Datasource

Every Datasource must be registered with the Datasource framework. To register a Datasource, you need to add an entry for that Datasource in the Datasource configuration file—DataSourceConfig.xml, which is present under iw-home/local/config.

NOTEThe Datasource configuration file also enables you to pass additional information to the Datasource component as parameters.

The structure of the DataSourceConfig.xml file with an entry for a sample Datasource (for example, TS User Picker) can be as follows:......

<datasource>

<name>TS User Picker</name><classname>com.interwoven.datasource.examples.TSUserPicker</classname>

<namespace>IW-WFM</namespace>

<param name="servername">abc-w2ks</param><param name="serviceBaseURL">http://abc-w2ks:80</param>

<param name="csFactory">com.interwoven.cssdk.factory.CSLocalFactory

</param></datasource>

...

...

where,

name: unique name for the Datasource. You can use any name for your Datasource, provided it is unique in relation to other registered Datasources on that TeamSite server.

Classname: fully qualified name of the Datasource class.

namespace (optional): specifies the Datasource scope and thereby restricts its availability to a particular module of TeamSite. In addition, it helps in resolving the naming conflict. In other words, you can use the same Datasource name for Datasources belonging to different namespaces. For example, you can have a TS



User Picker Datasource for Interwoven Workflow Modeler and one for FormsPublisher.

NOTESIf you do not specify the namespace element, the Datasource is available to both Interwoven Workflow Modeler (IW-WFM) and FormsPublisher.You must not use namespace names starting with IW-, as they are restricted.

param: use this element to pass any additional information that your Datasource may need, for example, database URL, LDAP server name, and so on.

The structure of the DataSourceConfig.xml file is based on the DataSourceConfig.xsd schema. A copy of the DataSourceConfig.xsd file is present under:

//TS_Server/iwadmin/main/workflowModels/STAGING/Internal

For more information on the DataSourceConfig.xsd schema, see “DataSourceConfig.xsd” on page 192.

Deploying a Datasource

After you register the Datasource, perform the following steps to deploy the Datasource:

1. Place the .jar file into the following location:

iw-home/local/config/lib/content_center/customer_src/lib

2. At the command prompt, navigate to the following folder: iw-home/local/config/lib/content_center/customer_src

3. Run make_toolkit.ipl.

You can now use the newly created Datasource in Interwoven Workflow Modeler and DCTs.

NOTETo use the newly created Datasource in Interwoven Workflow Modeler, you may have to re-login to TeamSite.

Using Datasources in Job Instantiation FormsJob instantiation forms, which are displayed when you create a new job, are generated using Data Capture Templates (DCTs). TeamSite gives you the flexibility to create custom instantiation forms (DCTs) and customize the presentation of these forms.

For information on creating a custom instantiation form, see “Creating Custom Job Instantiation Forms” on page 143.



One of the ways to customize a DCT is to use Datasources. You can use Datasources for any DCT UI widget that supports the <option> tag. To call Datasources in a DCT, you can use one of the following:

Static Calls (inline)

Dynamic Calls (FormAPI)

Static Calls for Datasources

You can make static calls using inline commands. Datasource framework supports the following inline commands:

getDatasourceNames

executeComponent

getDatasourceNames

Retrieves names of all the Datasources registered with TeamSite. You can also retrieve a filtered list of names based on namespaces; for example, you can retrieve names of all the Datasources belonging only to the Interwoven Workflow Modeler namespace (IW-WFM).

Syntax<command-prefix>:<method-name>:<namespace>

where,

command-prefix. This is a constant and should always be Datasource; it is case-insensitive.

method-name .This is a constant and should always be getDatasourceNames; it is case-insensitive.

namespace (optional). This is the namespace identifier used while registering Datasources. For example, for Datasources belonging to Interwoven Workflow Modeler, it should be IW-WFM.

You can call this command as follows:<inline command="Datasource:getDatasourceNames:IW-WFM"/>

This sample command retrieves names of all the Datasources belonging only to the Interwoven Workflow Modeler namespace (IW-WFM).

executeComponent

Executes the specified Datasource (for example, UserPicker) and displays the values returned by that Datasource.



Syntax<command-prefix>:<method-name>:<component-name>: <param-name>=<param-value>:<param-name>=<param-value>

where,

command-prefix. This is a constant and should always be Datasource; it is case-insensitive.

method-name. This is a constant and should always be executeComponent; it is case-insensitive.

component-name. This is a name of a component that you want to execute, for example, UserPicker.

param-name (optional, unless parameter value is specified). This is a name of a parameter that can retrieve a specific value.

param-value (optional). This is a value for the passed parameter.

You can call this command as follows:<inline command="Datasource:executeComponent:UserPicker: role=master:server=TeamSite"/>

In this sample code, the UserPicker Datasource returns users with the master role from the TeamSite server.

An Example for Static Calls

The following code snippet demonstrates the use of the getDatasourceNames and executeComponent inline commands:...

...

<item name="DataSourceComponent" pathid="dsComponent"><label>Datasources</label>

<description>Lists all the registered datasources present in the

system.</description><select>

<inline command="Datasource:getDatasourceNames"/>

</select></item>

<item name="Users" pathid="@Users">

<label>Author</label> <description>Select a user who is a TeamSite author</description>

<select>

<inline command="Datasource:executeComponent:TS User

Picker:Role=author"/> </select>

</item>

...



...

Dynamic Calls for Datasources

In addition to static calls, you have the option of calling Datasources using FormAPI. These are remote server calls and are asynchronous in nature, similar to the callserver() method. However, the syntax is a slightly different from the callserver() method.

For more information on FormAPI, refer to FormAPI Developer’s Guide.

To support dynamic calls, the following JavaScript objects have been introduced:IWDatasource

IWMap

IWDatasource

Javascript function that enables you to work with Datasources. To use dynamic calls for Datasources, you need to create an instance of this Javascript function and call its methods. It includes the following methods:

getDatasourceNames

Retrieves a list of registered Datasources for the specified namespace. This is an asynchronous call.

Arguments

callbackfunction. Name of the user-defined callback Javascript function that is capable of handling the Datasource names. The signature of the callback function should be of the following form: <functionName>(Array, String, IWMap).

namespace. Namespace of the Datasource. If you pass an empty string, all the registered Datasources are returned.

contextParams (optional). An IWMap object that contains a list of name-value pairs. These values are returned to the callback function as is. You can use them to pass the contextual information. As this is an asynchronous call, you can pass object names, widget names, and so on, so that when you receive a response in the callback function, you can map the response with the request and take appropriate action.

Return Value

Returns void; calls the callback function with the result, default value, and contextParams.



executeDatasource

Executes the specified Datasource component. This is an asynchronous call.

Arguments

callbackfunction. Name of the user-defined callback Javascript function, which is capable of handling the Datasource names. The signature of the callback function should be of the following form: <functionName>(Array, String, IWMap).

dsComponentName. Name of the Datasource component to be executed, for example, UserPicker.

dsParams (optional). An IWMap object that contains a list of name-value pairs. These name-value pairs are passed to the Datasource. These values are different from the name-value pairs specified while registering the Datasource.

contextParams (optional). An IWMap object that contains a list of name-value pairs. These values are returned to the callback function as is. You can use them to pass the contextual information. As this is an asynchronous call, you can pass object names, widget names, and so on, so that when you receive a response in the callback function, you can map the response with the request and take appropriate action.

Return Value

Returns void; calls the callback function with the result and contextParams.

addOptionsToSelect

Adds the result of a Datasource into a Data Capture Form (DCF) select item. It is a utility method.

IWMap

Simulates a Java Map object in Javascript. You should pass an instance of this type of object to the methods of IWDatasource. The IWMap object contains the following methods:

put(). Adds a new entry into the map.

For example: mapObj.put(key,value);

get(). Retrieves an entry from the map for the specified key.

For example: mapObj.get(key);

key(). Retrieves an array of keys present in the map.

For example:mapObj.keys();



length(). Returns the number of items present in the map.

For example:mapObj.length();

An Example for Dynamic Calls

The following code snippet demonstrates the use of objects and methods that support dynamic calls for Datasources:......

function init()

{getDatasourceNames();

/*Add listners to this component */var propertyItem = IWDatacapture.getItem

("press-release/Heading/head/datasourcedemo/dcapidsComponent");

IWEventRegistry.addItemHandler(propertyItem.getName(), "onItemChange", setValueForDatasource);

}

function setValueForDatasource(item, defaultValue){

if(item.getValue() != null)

{

var selectedDSValue = item.getOptions()[

item.getValue()].value;var datasourceObj = new IWDatasource();

var dsParams;

var returnParams = new IWMap();returnParams.put("selectItemVpath",

"press-release/Heading/head/datasourcedemo/dcapiUsers");

datasourceObj.executeDatasource("setDatasourceValueCallback", selectedDSValue, dsParams,

returnParams);

return;}

}

function setDatasourceValueCallback(resultObj, ctxParams){

var selectItemRef;

if(ctxParams != undefined){

selectItemRef = ctxParams.get("selectItemVpath");

}

var datasourceObj = new IWDatasource();datasourceObj.addOptionsToSelect(resultObj, selectItemRef,

getItemValue(selectItemRef));



top.hiddenFrameRunning = true;return;

}

function getDatasourceNames(){

var returnParams = new IWMap();

returnParams.put("selectItemPath",

"press-release/Heading/head/datasourcedemo/dcapidsComponent");var datasourceObj = new IWDatasource();

datasourceObj.getDatasourceNames("setDatasourceNamesToSelect",

"", returnParams);}

function setDatasourceNamesToSelect(resultObj, returnParams)

{alert("3");

var selectItemPath;

if(returnParams != undefined){

selectItemPath = returnParams.get("selectItemPath");

}alert("Result received = " + resultObj);

var datasourceObj = new IWDatasource();

datasourceObj.addOptionsToSelect(resultObj, selectItemPath, getItemValue(selectItemPath));

return;

}function getItemValue(itemName)

{

var propertyItem = IWDatacapture.getItem(itemName);var value;

try{

value = item.getOptions()[propertyItem.getValue()].value;return value;

}catch(e){}

try{value = propertyItem.getValue();

return value;

}catch(e){}}

...

...


Chapter 9

Using Custom Code

OverviewTeamSite gives you the flexibility to execute custom code during the workflow instantiation. Using the custom code, you can modify the workflow properties, add files to the workflow, and/or remove files from the workflow. To perform these actions, you need to call in-process (recommended) or out-of-process commands. You can use Interwoven Workflow Modeler to add these commands for the two new properties – PreProcessor Command and PostProcessor Command – of any workflow model. In addition, you can specify the order in which these commands should be executed.

The following figure illustrates the sequence in which the pre-processor and post-processor commands are executed during the workflow instantiation.

Figure 86 Custom code workflow

Pre-processor commands are executed during the workflow instantiation (just before the instantiation screen is rendered), whereas post-processor commands are executed after the instantiation screen is rendered and before the workflow job is created.


Chapter 9: Using Custom Code

Creating Custom CodeTo create your custom code for an in-process command:

1. Implement the InProcessJavaCommand interface, see “Implementing the InProcessJavaCommand Interface” on page 158.

2. Deploy the custom code in TeamSite, see “Deploying Custom Code” on page 160.

NOTEFor out-of-process commands, you can develop a class or script and place it any location. You need to specify the location in the PreProcessor Command or PostProcessor Command property of a workflow model.

Implementing the InProcessJavaCommand Interface

To develop custom code for an in-process command, you must implement the InProcessJavaCommand interface. For example:

public class PreProcessorURLTask implements InProcessJavaCommand

{

...

...

}

NOTESYour class must include the following import statement:import com.interwoven.modeler.workflow.commands.InProcessJavaCommand;

In addition, your project should have the modelerworkflowapi.jar file in its classpath. The modelerworkflowapi.jar is available at the following location: iw-home/httpd/webapps/content_center/WEB-INF/lib/

In your class, you need to provide implementation for the execute() method. It enables you to make modifications to a workflow model. It returns the WFMWorkflow object, which contains the workflow instance. You can add files, change the owner, change properties of the workflow, and return the workflow object.

Syntax

public WFMWorkflow execute(WFMWorkflow workflow, Map<String,String> params)



Parameters

workflow. A WFMWorkflow instance. You can make changes to this instance; the changes are reflected in the workflow.

params. Additional parameters passed while specifying a command for the PreProcessCommand or PostProcessCommand property.

The key parameter is the instance of the WFMWorkflow interface. This interface represents a workflow model and includes methods (such as addFile(), getTasks(), setOwner(), and so on) for modifying the workflow model. Using this interface, you can add files to or remove files from the workflow model. In addition, you can modify the properties of the workflow model.

NOTEYou cannot change the structure of the workflow model. In other words, you cannot add additional workflow elements (for example, tasks, links, and so on).

Additional Interfaces

In addition to the WFMWorkflow interface, TeamSite provides interfaces for all the workflow elements. Some of them are as follows:

WFMTask

WFMUserTask

WFMReviewTask

WFMEmailTask

WFMDeployTask

WFMSubmitTask

WFMFlow

WFMDefaultFlow

WFMConditionalFlow

All the interfaces include methods that enable you to retrieve and set properties of their respective tasks. For example, using the WFMUserTask interface, you can retrieve and set the properties of a User task.

You can find more information on the interfaces and their methods in the Javadocs included in the modelerworkflowapidoc.jar file, which is located at:

iw-home/httpd/webapps/content_center/WEB-INF/lib

An Example

The following sample code snippet illustrates how you can use the WFMWorkflow, WFMTask, and WFMURLTask interfaces. Similarly, you can use other interfaces in your custom code.



public class CustomCodeDemo implements InProcessJavaCommand

{

public WFMWorkflow execute(WFMWorkflow workflow, Map<String,String> params)

{

//Add a file to the workflow

WFMFile file=new WFMFile("//abc/main/WORKAREA/myarea/Task.txt", "Comment Sample");

workflow.addFile(file);

//Retrieve all the tasks of the workflow

//and store them in an array of WFMTask

WFMTask[] tasks=workflow.getTasks();

//Loop through the array, identify the URL task,

//and modify its propertiesfor (int i = 0; i < tasks.length; i++)

{

if(tasks[i] instanceof WFMURLTask){

WFMURLTask urltask=(WFMURLTask)tasks[i];

...

...

urltask.addVariable("WHO","TSMaster");

urltask.setBriefDescription("Modified Brief Description");urltask.setDescription("Modified Description");

...

...}

}

return workflow;}

}

Deploying Custom Code

To deploy your custom code:

1. Create a JAR for your class.

2. Place the .jar file into the following location:

iw-home/local/config/lib/content_center/customer_src/lib

3. At the command prompt, navigate to the following folder: iw-home/local/config/lib/content_center/customer_src

4. Run make_toolkit.ipl.



Your custom code will be called during instantiation after you add the command in Interwoven Workflow Modeler for the PreProcessor Command or PostProcessor Command properties.


Appendix A

Interwoven Workflow Modeler Tutorial

This tutorial shows you how to create a workflow model similar to Configurable Default Submit, which is shipped with TeamSite. In addition, it shows you how to make the workflow model available to end-users logged in to your TeamSite server. Use this tutorial to learn the basic skills you will need to develop workflow models, and to learn about some of the features available in Interwoven Workflow Modeler.

By the end of this tutorial, you will learn how to perform the following tasks:

Create a workflow model that uses various workflow elements such as Submit Task, Deploy Task, and so on.

Use CONFIGURABLE and SCRIPT variables.

Make your workflow model available to job creators.

The concepts and procedures included in this tutorial are designed to get you through the creation of your first actual workflow model. Some features that are not specific to the creation of this project are not explained. These options—and other advanced Interwoven Workflow Modeler features—are described in detail in other chapters of this book.

PrerequisitesBefore you begin, you need to ensure the following:

The TeamSite server is installed and configured as described in the TeamSite Installation Guide.

Interwoven Workflow Modeler client is installed as described in this manual. See Chapter 2, “Installing the Interwoven Workflow Modeler” for more information.

You have privileges to Publish workflow models to the TeamSite server.

You have the TeamSite server name and the Interwoven Web daemon (iwwebd) port number available.

You are familiar with basic TeamSite administration tasks (or have access to the TeamSite documentation).


Appendix A: Interwoven Workflow Modeler Tutorial

The WorkflowAdmin role has been created for you in TeamSite. For more information on the WorkflowAdmin role, see “Understanding Workflow Roles” on page 111.

Tutorial OverviewIn a real-world implementation, before developing a workflow model, you need to analyze your business requirements and develop a design for the same. As these stages are out of the scope of this tutorial, this chapter focuses only on the development and use of Interwoven Workflow Modeler workflow models, which follow this pattern:

Development. A workflow model developer creates a workflow model that describes the flow of tasks in a particular job.

Deployment. The workflow model developer makes the workflow model available to job creators by publishing the workflow model to the TeamSite server and adding an entry of the workflow model in the available_models.xml file.

For more information on publishing the workflow model and adding an entry in the available_models.xml file, see “Publishing Workflow Models to TeamSite” on page 52 and “Managing Workflow Models” on page 116.

Job Instantiation. In ContentCenter Professional, a job creator selects the workflow model that describes the job to be created. A screen appears into which the job creator enters data specific to that job.

The presentation and default values for this screen can be configured. For more information, see “Configuring Workflow Models” on page 123.

Although this tutorial covers only the development and deployment phases, the following sections use the tutorial project to describe the three phases of workflow development and use, so that you can gain a broad understanding of this process.

Development

In this tutorial you, the workflow developer will develop a workflow model, similar to Configurable Default Submit, which describes a job comprising the following tasks:

A user whose work does not need review submits a file.

Start Task. Defines the start of the workflow model.

Dummy Task. If metadata generation for the file is not required, the job proceeds to a dummy task. A dummy task is used as a placeholder for time delays, tasks resets, or gate transition tasks. The file is sent for submission after the specified time limit.

Metadata Task. If metadata generation for the file is required, the job proceeds to the Metadata task, which calls the iwmetadata.cgi program to create metadata. After the metadata is created, the file is sent for submission.



Submit Task. The job transitions to the Submit task and TeamSite’s Submit operation is performed. The file is submitted to the Staging area. The job proceeds to the End task if deployment is not required or proceeds to the Deploy task for deployment.

Deploy Task. The file is deployed to the specified location. If the deployment operation succeeds, the job proceeds to the End task. If it fails, it proceeds to the Notify Deploy task.

Gateway. The Gateway ensures that the job proceeds to Notify Deploy and Resolve Deploy Problems tasks only if the Deploy Task fails.

Notify Deploy Task. An email is sent to the job initiator if there is a deployment problem.

Resolve Deploy Problems Task. The job transitions to the Resolve Deploy Problems task and the deployment problem is resolved. After the deployment problems are resolved, the job transitions to the Deploy Task to be redeployed to the specified location.

If the deployment operation is cancelled, the job transitions to the End task.

End Task. The job ends after the task is completed.

Deployment

When the workflow model development is complete, you can save or publish it to the TeamSite server.

If you select Save to Server, the draft workflow model is saved to //TS_Server/iwadmin/main/workflowModels. However, if you select Publish Workflow, the workflow model is saved to //TS_Server/iwadmin/main/workflowModels/STAGING/Models.

NOTEWhenever you select Publish Workflow, a copy of the workflow model is automatically saved to //TS_Server/iwadmin/main/workflowModels.

To make the workflow model available to job creators, you need to add an entry for the workflow model in the available_models.xml file. This file helps you manage a workflow model’s availability to one or more TeamSite branches. For information on managing workflows, see “Managing Workflow Models” on page 116.

Instantiation

When job creators initiate a new job, the creator first selects a workflow in a TeamSite GUI, and then fills in the required job parameters (for example, job description, task owner, and so on) in the form.



You will configure the tutorial workflow model in such a way that some job parameters are extracted automatically by the workflow model, and others must be supplied by the job creator.

You can customize the following aspects of new job forms:

The type of form element that displays for any given line of input (for example, a text area instead of a text field).

The default value for each form element.

For information on customizing the new job form, see “Creating Custom Job Instantiation Forms” on page 143.

Creating a New WorkflowTo complete this tutorial, you must work in the online mode; that is, you need to log in to the TeamSite server. For information on logging in to the TeamSite server, see “Starting the Interwoven Workflow Modeler” on page 31.

To open the tutorial and begin your project:

1. Launch Interwoven Workflow Modeler.

The Login dialog box appears.

2. Enter the following information in the Login dialog box:

User Name. Your TeamSite user name.

Password. Your TeamSite password.

Domain. The domain where the TeamSite sever you are accessing resides, for example, myCompany.com. If you do not know the domain where your TeamSite server resides, contact your TeamSite administrator.

NOTEFor a UNIX server, the domain name is the same as the server name. For example, if your server name is myServer, the domain name too is myServer.

Server Name. The name of the TeamSite server.

Port Number. The Interwoven Web daemon (iwwebd) port number.

3. Click OK.

4. Select File > New Workflow.

By default, a workflow model labeled Unnamed (#) (where # is the total number of workflow models you have created) is displayed.

5. Place the following workflow elements on the Project pane, so that your workflow model is identical to the one in the following figure:



Figure 87 Tutorial: Creating a new workflow model

The following table lists the elements used in this workflow model:

Table 23 Tutorial–list of workflow elements

Element Name Element TypeStart Start EventDummy Task Dummy TaskCreate Metadata Conditional LinkNo Metadata Conditional LinkSubmit After Timeout Timeout LinkSubmit Files Default LinkMetadata Capture Metadata TaskSubmit Submit TaskDeploy Content Conditional LinkNo Deploy Conditional LinkDeploy Task Deploy TaskGateway AND GatewayNotify Conditional LinkNotify Deploy Email TaskResolve Problems Conditional Link



These tasks and links have been renamed using their Name attribute.

Variables Overview

In this tutorial, you will create two new variables supported by the TeamSite workflow engine. The new variables are as follows:

CONFIGURABLE variable. Enables you to create a workflow model that contains elements whose values do not need to be assigned until the workflow is customized or instantiated in TeamSite. For example, if you have an AreaVPath property set as a configurable variable, you do not need to provide the value when you are creating the workflow model. Instead, its value can be assigned by end-users in TeamSite.

SCRIPT variable. Enables you to write JavaScript for any task, transition link, or node property and have the value returned by the script determine the value assigned to that property. For example, if you create a Script variable for the property MDCaptureUI, you could create a script to determine which metadata capture screen is displayed to end-users.

These variables are available for most attributes of the workflow model elements. Their values are resolved just before instantiation. Therefore, they appear as strings or Boolean values in the final job specification file.

For more information on these variables, see “Interwoven Workflow Modeler Variables” on page 57.

Specifying Workflow Attributes

In this section, you will specify two workflow attributes.

To specify values for the workflow attributes:

1. In the Tree pane, select Workflow Model.

Resolve Default LinkResolve Deploy Problems User TaskDeploy Success Success LinkDeploy Failure Failure LinkRetry Default LinkCancel Default LinkEnd End Event

Table 23 Tutorial–list of workflow elements

Element Name Element Type



2. In the Properties pane, specify values for the following attributes:

These attributes are common to all the workflow tasks. For more information on attributes specific to the workflow, see “Assigning Workflow-Specific Attributes” on page 78.

Table 24 Tutorial–Workflow attributes

Attribute Description ActionName Specifies the name that

displays in the list of available jobs in the TeamSite user interfaces

Type Sample WorkflowModel

Brief Description

Provides a brief description for the workflow model.

Type Sample Workflow.

Global Variables

Variables that are available across the workflow model. All the workflow model elements can use these variables.

Click the blank field next to the Description attribute, and create three global CONFIGURABLE variables with the following details:Variable 1• ID—Type includeMetadata• Label—Type Include Metadata• Default Value—Type true• Select the Hidden and Readonly

optionsVariable 2• ID—Type includeDeploy• Label—Type Include Deploy• Default Value—Type true• Select the Hidden and Readonly

optionsVariable 3• ID—Type notifyDeployFailure• Label—Type Notify Deploy

Failure

• Default Value—Type true• Select the Hidden and Readonly

optionsThe values (true or false) set for these variable and the script used for the conditional links determine the workflow path.



Specifying Task Attributes

In this section, you will specify the attributes for each task. Each task has some common and some unique set of attributes. For details about these attributes, see “Assigning Common Task Attributes” on page 67 and “Assigning Task-Specific Attributes” on page 82.

Dummy Task (Dummy Task)

You need to specify the following attributes for the Dummy task.

To specify values for Dummy task attributes:

1. In the Project pane, select the Dummy Task.


Metadata Capture (Metadata Task)

You need to specify the following attributes for the Metadata Task.

To specify values for Metadata task attributes:

1. In the Project pane, select the Metadata Task.


Table 25 Tutorial–Dummy task attributes

Attribute Description ActionName Specifies a name that


Type Dummy Task

Brief Description

Provides a brief description of what the task does.

Type Submit In Progress

Description Allows the job creator to enter a description of the new task

1. Click the blank field next to the Description attribute.

2. In the text box of the Description dialog box, type Dummy Task.

Table 26 Tutorial–Metadata task attributes



Type Metadata Capture

Brief Description

Provides a brief description of what the task does.

Type Metadata Capture



Submit (Submit Task)

You need to specify the following attributes for the Submit Task.

To specify values for the Submit Task attributes:

1. In the Project pane, select the Submit Task.


Description Allows the job creator to enter a description of the new job


2. In the text box of the Description dialog box, type Metadata Task.

Table 27 Tutorial–Submit task attributes



Type Submit

Brief Description

Provides a brief description of what the task does

Type Submit Files

Description Allows the job creator to enter a description of the new job


2. In the text box of the Description dialog box, type Submit Task.

Submit Comment

Allows the job creator to specify submit comments for the associated files.

Click the blank field next to the Submit Comment attribute, and create a CONFIGURABLE variable with the following details:• ID—Type sbmtComment• Label—Type Comment• Description—Enter submit

commentSubmit Info Allows the job creator to

specify submit information for the associated files.

Click the blank field next to the Submit Info attribute, and create a CONFIGURABLE variable with the following details:• ID—Type sbmtInfo• Label—Type Info• Description—Enter submit

information

Table 26 Tutorial–Metadata task attributes

Attribute Description Action



Deploy Task (Deploy Task)

You need to specify the following attributes for the Deploy Task.

To specify values for Deploy Task attributes:

1. In the Project pane, select the Deploy Task.


Notify Deploy (Email Task)

You need to specify the following attributes for the Notify Deploy task.

To specify values for the Notify Deploy task attributes:

1. In the Project pane, select the Notify Deploy task.


Table 28 Tutorial–Deploy task attributes



Type Deploy Task

Variables Enables you to set values for variables pertinent to this task

1. Click the field next to the Variables attribute.

2. From the Name field, select odDeploymentName.

3. In the Value field of the Variables dialog box, set a valid value for the odDeploymentName variable.

You need to ensure that Open Deploy has been configured.For information on the Open Deploy configuration, see the Open Deploy documentation.

Table 29 Tutorial–Notify Deploy task attributes



Type Notify Deploy

Brief Description

Provides a brief description of what the task does

Type Notify Deploy Failure



In addition, you need to do the following:

Specify the email address to which you want the notification to be sent. To do this, complete the following steps:

a. Log in to TeamSite.

b. Select the Administration tab.

c. In the left pane, under Roles and Permissions, select Manage Users. A list of users is displayed in the right pane.

d. Click Edit against the pertinent user.

e. In the User Details page, enter the email address in the Email text box, and click Save.

Specify the mail domain and server values. Complete the following steps:

a. Navigate to the TeamSite server configuration file, iw.cfg file. By default, the file is located in /etc (Solaris) or iw-home/etc (Windows)

b. In the iw.cfg file, specify the mail domain and mail server names.

Example:maildomain=MyCompany.com

mailserver=smtp.MyCompany.com

Variables Allows defining values for variables

1. Click the field next to the Variables attribute.

2. In the Name field, select mail_template, and in the Value field, select a default mail template.

3. In the Name field, select ClassName, and in the Value field, select a default class name.

4. In the Name field, select target_task_name, and in the Value field, select Resolve Deploy Problems.

Note that if you are using default mail templates and classes, use the following combination: • For authorNotification.xsl or

configurableAuthorNotification.xsl, use the AuthorMailNotificationTask class.

• For reviewerNotification.xsl or configurableReviewerNotification.xsl, use the ReviewerMailNotificationTask class.

Table 29 Tutorial–Notify Deploy task attributes




Specifying Link Attributes

In this tutorial, you will use Default, Conditional, Success, and Failure links. You need to specify an intuitive name for each link, because these names will appear on the buttons that help you proceed to the next task of the job.

Create Metadata (Conditional Link)

You need to specify the following attributes for the Create Metadata link.

To specify values for the Create Metadata link attributes:

1. In the Project pane, select the Create Metadata link.


No Metadata (Conditional Link)

You need to specify the following attributes for the No Metadata link.

To specify values for the No Metadata link attributes:

1. In the Project pane, select the No Metadata link.

Table 30 Tutorial–Create Metadata link attributes



Type Create Metadata

Expression Indicates (using true or false) whether the link should be used for the workflow path

1. Select SCRIPT from the field next to the Expression attribute.

2. In the Source tab, type the following:

if("$IW_CV(includeMetadata)" == "true")

{true;

}

else{

false;

}




Submit After Timeout (Timeout Link)

You need to specify the following attributes for the Submit After Timeout link.

To specify values for the Submit After Timeout link attributes:

1. In the Project pane, select the Submit After Timeout link.


No Deploy (Conditional Link)

You need to specify the following attributes for the No Deploy link.

Table 31 Tutorial–No Metadata link attributes



Type No Metadata




if("$IW_CV(includeMetadata)" != "true")

{

true;}

else

{false;

}

Table 32 Tutorial–Submit After Timeout link attributes



Type Submit After Timeout

Timeout Duration

1. Click the field next to the Timeout Duration attribute.

2. In the Minute field, type 1.



To specify values for the No Deploy link attributes:

1. In the Project pane, select the No Deploy link.


Deploy Content (Conditional Link)

You need to specify the following attributes for the Deploy Content link.

To specify values for the Deploy Content link attributes:

1. In the Project pane, select the Deploy Content link.


Table 33 Tutorial–No Deploy link attributes



Type No Deploy.




if("$IW_CV(includeDeploy)" != "true"){

true;

}else

{

false;}

Table 34 Tutorial–Deploy Content link attributes



Type Deploy Content.



Notify (Conditional Link)

You need to specify the following attributes for the Notify link.

To specify values for the Notify link attributes:

1. In the Project pane, select the Notify link.





if("$IW_CV(includeDeploy)" == "true")

{

true;}

else

{false;

}

Table 35 Tutorial–Notify link attributes



Type Notify.




if("$IW_CV(notifyDeployFailure)" == "true")

{

true;}

else

{

false;}

Table 34 Tutorial–Deploy Content link attributes




Resolve Problems (Conditional Link)

You need to specify the following attributes for the Resolve Problems link.

To specify values for the Resolve Problems link attributes:

1. In the Project pane, select the Resolve Problems link.


Other Links

For all other links, you need to set the Name attribute only.

To specify a name for a link:

1. On the Project pane, select a link.

2. In the Properties pane, click the field next to the Name attribute.

3. Type a name for the link.

Saving Your Workflow ModelIn this section, you will save your workflow file and use the Validate feature to find and correct an error in the workflow model.

Table 36 Tutorial–Resolve Problems link attributes



Type Resolve Problems.




if("$IW_CV(notifyDeployFailure)" != "true"){

true;

}else

{

false;}



When you save a workflow model, Interwoven Workflow Modeler checks for errors. If errors exist, the Error pane displays information about each error. You can validate your workflow model at any time by selecting Options > Validate Workflow.

To save the workflow model on your local system:

1. Select File > Save As.

A dialog box prompts you to validate the workflow model.

2. Click Yes.

If the workflow model has error(s), the Error pane appears at the bottom of the application screen with a list of errors. You need to fix the errors, if any. For more information on the Error pane and fixing errors, see “Errors Pane” on page 47.

If there are no errors, the Save As dialog box appears.

3. In the Save As dialog box, navigate to the required directory.

4. Name the file Sample_WorkflowModel.ipm.

5. Click Save.

Now that you have validated your workflow model and saved it, you are ready to publish it to the TeamSite server.

Publishing Your Workflow Model to TeamSiteWhen you are ready to make a workflow model available to TeamSite users, you must publish it to the TeamSite server.

To publish the workflow model to the TeamSite server, select File > Publish Workflow.

This will save the workflow model to //TS_Server/iwadmin/main/workflowModels/STAGING/Models. In addition, a copy of the workflow model is automatically saved to //TS_Server/iwadmin/main/workflowModels.

Now you need to make the workflow model available to job creators.

To make the workflow model available to job creators, you need to add an entry for the workflow model in the available_models.xml file. This file helps you manage a workflow model’s availability to one or more TeamSite branches. For information on managing workflows, see “Managing Workflow Models” on page 116.

Finish the tutorial by testing your work. In the next section, you will invoke your workflow model from a TeamSite user interface and create a new job with it.



Testing Your WorkTest your work by creating a new job with your workflow model in TeamSite.

1. Open a browser and log in to your TeamSite server.

2. Navigate to any workarea.

3. Select Actions > New Job.

The Select Workflow window displays with Sample_WorkflowModel included in the list of available workflows.

4. Select Sample_WorkflowModel, and click Next.

A new job form appears. Notice that the form includes blank text areas for all the configurable variables you defined while designing the workflow model.

NOTEIf you do not select the specified minimum number (or more) reviewers, you will not be able to instantiate the job.

5. Specify values for the blank fields.

6. Click Submit.

This step will initiate the job.

7. Click the Workflow tab.

The job you just created has placed a task in your Task list. Complete all the tasks of the job.

Congratulations! You have successfully completed the Interwoven Workflow Modeler tutorial.


Appendix B

Datasource Example

To create a Datasource, you must implement the SimpleDataSource, ListDataSource, or MapDataSource interface. For information on these interfaces, see “Implementing Datasource Interfaces” on page 145.

NOTEFor this example, we have used the MapDataSource interface.

To create a sample Datasource:

1. Write a java class that implements the MapDataSource interface. For your reference, we have included the actual code of an out-of-the-box Datasource interface, MapUserPicker.

//MapUserPicker.java

package com.interwoven.datasource.examples;

import com.interwoven.datasource.ArrayDataSource;import com.interwoven.datasource.MapDataSource;

import com.interwoven.datasource.core.DataSourceContext;

import com.interwoven.log100.Logger;import com.interwoven.log100.LoggerFactory;

import com.interwoven.cssdk.common.CSClient;

import com.interwoven.cssdk.common.CSRemoteException;import com.interwoven.cssdk.common.CSException;

import com.interwoven.cssdk.common.CSIterator;

import com.interwoven.cssdk.access.*;import com.interwoven.cssdk.factory.CSFactoryInitializationException;

import com.interwoven.cssdk.filesys.CSVPath;

import com.interwoven.cssdk.filesys.CSBranch;

import java.util.*;

/**

* Datasource class, which retrieves all TeamSite users and sends back the

* shortname and display name.*/

public class MapUserPicker implements MapDataSource

{


Appendix B: Datasource Example

private static final Logger log = LoggerFactory.getLogger(MapUserPicker.class.getName());

/*** This method returns Map<String,String> containing names of all the

* TeamSite users. It uses CSClientUtil.java class

* to get the CSClient object from the session string passed by the

* Datasource framework.* Key contains the user's shortname and value contains the user's

* display name

*/public Map execute(DataSourceContext context)

{

String sessionId = context.getSessionId();String vpath = context.getServerContext();

Map<String,String> params = context.getAllParameters();

if(sessionId != null){

Map test = new HashMap();

test.put("rsk1","rshamanth1");test.put("rsk2",null);

test.put("rsk3","!)@(@#*#)&_$$#&%_@$#%+_#+($)#%$\":>>?|{}{|)");

test.put("rsk4","dude");test.put("rsk4","dude duplicate");

test.put("","");

return test; }

CSClient client = null;

String role = null;if(log.isDebugEnabled())

{

log.debug("Received session id = " + sessionId); log.debug("Received vpath = " + vpath);

log.debug("Received params = " + params);

}try {

//Getting the CSClient object from sessionId

client = CSClientUtil.getCSClient((String)sessionId,params);} catch (CSInvalidSessionStringException e1) {

e1.printStackTrace();

} catch (CSFactoryInitializationException e1) {e1.printStackTrace();

} catch (CSExpiredSessionException e1) {


} catch (CSAuthenticationException e1) {e1.printStackTrace();

} catch (CSRemoteException e1) {

e1.printStackTrace();} catch (CSException e1) {




}if(client == null)

{

return new HashMap<String,String>();}

CSIterator iterator = null;

try {iterator = client.getPrincipalManager().getAllTSUsers();

} catch (CSException e1) {

e1.printStackTrace();}

if(log.isDebugEnabled())

{log.debug("Total number of users = " + iterator.getTotalSize());

}

ArrayList userObjList = new ArrayList();Map userNameList = Collections.synchronizedSortedMap(new

TreeMap<String,String>());

while(iterator.hasNext()){try{

Object userCs = iterator.next();

CSUser user=(CSUser)userCs;userObjList.add(user);

if(user.getDisplayName() == null)

{userNameList.put(user.getName(),user.getName());

}

else{

userNameList.put(user.getName(),user.getDisplayName());

} if(log.isDebugEnabled())

{

log.debug("User name =" + user.getName() + " display name = " + user.getDisplayName());

}

}catch(Exception e){

e.printStackTrace();

}}

if(params.get("Role") != null)

{//Role is present, so try to get all users matching this role

in the given vpath

role = (String)params.get("Role");if(log.isDebugEnabled())

{



log.debug("Role received = " + role);}

Map userWithSpecifiedRole = Collections.synchronizedMap(new

TreeMap<String,String>());for(int i=0;i<userObjList.size();i++)

{

try {

CSUser user = (CSUser) userObjList.get(i); if(log.isDebugEnabled())

{

log.debug("User name = " + user.getName()); }

if(vpath != null)

{ //Vpath is present, so get all users who have this

//role in this vpath

CSVPath csvpath = new CSVPath((String)vpath); CSBranch branch = client.getBranch(csvpath,true);

CSRole[] roles = user.getRoles(branch);

for(int j=0;j<roles.length;j++) {


{log.debug("Roles of this user = " +

roles[j].getName());

} if(roles[j].getName().equalsIgnoreCase(role))

{

if(!userWithSpecifiedRole.values().contains(user.getName()))

{

if(user.getDisplayName() == null) {

userWithSpecifiedRole.put

(user.getName(),user.getName()); }

else

{userWithSpecifiedRole.put

(user.getName(),

user.getDisplayName()); }

}

}

} }

else

{ //As vpath is null, we cannot get roles for the

//user. So, just return an empty array



Map defaultUsers = new HashMap<String,String>(); defaultUsers.put("$IW_AREAOWNER","AREAOWNER");

defaultUsers.put("$IW_USER","CURRENT USER");

return defaultUsers; }

} catch(Exception e)

{

e.printStackTrace(); //Just ignore and go to next iteration.

}

} return userWithSpecifiedRole;

}

else {

//If no role is specified return all users

//Add default users also userNameList.put("$IW_AREAOWNER","AREAOWNER");

userNameList.put("$IW_USER","CURRENT USER");

return userNameList; }

}

}

// Code for the CSClientUtil.java, which is used in the MapUserPicker.java

// file is as follows:

package com.interwoven.datasource.examples;

import java.util.Locale;

import java.util.Map;

import java.util.Properties;

import com.interwoven.cssdk.access.CSAuthenticationException;

import com.interwoven.cssdk.access.CSExpiredSessionException;import com.interwoven.cssdk.access.CSInvalidSessionStringException;

import com.interwoven.cssdk.common.CSClient;

import com.interwoven.cssdk.common.CSException;import com.interwoven.cssdk.common.CSRemoteException;

import com.interwoven.cssdk.factory.CSFactory;

import com.interwoven.cssdk.factory.CSFactoryInitializationException;import com.interwoven.log100.Logger;

import com.interwoven.log100.LoggerFactory;

/*** Utility class with a method to retrieve the CSClient object

* from a session string corresponding to a user's session on the TeamSite

* server.*/

public class CSClientUtil



{private static final Logger log =

LoggerFactory.getLogger(CSClientUtil.class.getName());

public static final String SERVERNAME = "servername"; public static final String SERVICEBASEURL = "serviceBaseURL";

public static final String CSFACTORY = "csFactory";

public static final String LOCALE = "locale";

public static final String APPLICATION_CONTEXT = "appcontext";

/**

* Retrieves the CSClient object for the given sessionString * @param sessionString

* @param param should contain the following parameters as keys

* servername * serviceBaseURL

* csFactory

* locale [Optional] * appcontext [Optional]

* @return

* @throws CSInvalidSessionStringException * @throws CSExpiredSessionException

* @throws CSAuthenticationException

* @throws CSRemoteException * @throws CSException

* @throws CSFactoryInitializationException

*/

public static CSClient getCSClient(String sessionString, Map param)

throwsCSInvalidSessionStringException, CSExpiredSessionException,

CSAuthenticationException, CSRemoteException, CSException,

CSFactoryInitializationException{


{log.debug("session string :"+sessionString);

log.debug("map is :"+param);

}

Locale locale = null;

String serverName = null;CSFactory factory = null;

String appcontext = null;

//Read the properties from the Map and set it to the Properties object

Properties props = new Properties();

//TeamSite server name

serverName= (String)param.get(SERVERNAME);

//Read Service base URL; it should be of the format



// http://<servername>:<port>//or

// https://<servername>:<port>

props.setProperty(SERVICEBASEURL, (String)param.get(SERVICEBASEURL));

//Set the CSFactory object to be used

//For example: com.interwoven.cssdk.factory.CSLocalFactory

props.setProperty("com.interwoven.cssdk.factory.CSFactory",

(String)param.get(CSFACTORY));

//Get the CSFactory

factory=CSFactory.getFactory(props);

if(param.get(LOCALE)!=null)

{locale=(Locale)param.get(LOCALE);

}else

{locale=Locale.getDefault();

}

if(param.get(APPLICATION_CONTEXT)!=null){

appcontext=(String)param.get(APPLICATION_CONTEXT);

}else{

appcontext= "workflowModeler";

} //Get the CSClient object

return factory.getClient(sessionString,locale,appcontext,serverName);

}}

2. Compile the file to create a .class file.

3. Create a .jar file using the .class file. The .jar file can have any name, for example, SampleDatasource.jar.

4. Register the Datasource by adding an entry for it in the Datasource configuration file. For more information, see “Registering a Datasource” on page 148.

5. Deploy the Datasource in TeamSite. For more information, see “Deploying a Datasource” on page 149.


Appendix C

Workflow Schemas

Workflow schemas are available in iw-home/install. They are as follows:

available_models.xsd. Defines the schema for the available_models.xml file. It contains a collection of declarations (elements and attributes) that describe the expected document structure.

BPMNModel.xsd. Defines the schema for the workflow model file (.ipm), which includes information on the workflow elements (for example, User task).

ProcessModelConfiguration.xsd. Defines the schema for a workflow model’s default configuration file. This configuration file contains information about the CONFIGURABLE, DATASOURCE and SCRIPT variables added in the workflow model.

DataSourceConfig.xsd. Defines the schema for the DataSourceConfig.xml file, which is used to register Datasources.

The following sections include detailed information on the key schemas (available_models.xsd and DataSourceConfig.xsd).

available_models.xsd (Subscription schema)The available_models.xml file begins with the following prolog:<?xml version="1.0" standalone="no" ?>

<!DOCTYPE available_models SYSTEM ‘./available_models.xsd’>

It declares that the available_models.xml uses the available_models.xsd to describe the expected document structure. The available_models.xsd file is a collection of declarations divided into two types:

ELEMENT. Defines an element and what it can contain.

ATTRIBUTE. Defines the attributes that are allowed for an element.

The available_models.xsd file is available in iw-home/install.

The following available_models.xsd defines the default behavior of the available_models.xml file:


Appendix C: Workflow Schemas

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<xs:schema xmlns="http://www.interwoven.com/modeler/schema/subscription10" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.interwoven.com/modeler/schema/subscription10" elementFormDefault="qualified" attributeFormDefault="unqualified">

<xs:complexType name="available_modelsType">

<xs:sequence minOccurs="0" maxOccurs="unbounded">

<xs:element ref="model"/></xs:sequence>

<xs:attribute name="require_workarea" default="true">

<xs:simpleType><xs:restriction base="xs:NMTOKEN">

<xs:enumeration value="true"/>

<xs:enumeration value="false"/></xs:restriction>

</xs:simpleType>

</xs:attribute></xs:complexType>

<xs:element name="available_models" type="available_modelsType"/>

<xs:complexType name="modelType"><xs:sequence>

<xs:choice minOccurs="0">

<xs:element ref="allowed"/></xs:choice>

</xs:sequence>

<xs:attribute name="name" type="xs:string" use="required"/><xs:attribute name="filename" type="xs:string" use="required"/>

<xs:attribute name="active" default="true">




</xs:simpleType>

</xs:attribute><xs:attribute name="debug" default="false">

<xs:simpleType>

<xs:restriction base="xs:NMTOKEN"><xs:enumeration value="true"/>

<xs:enumeration value="false"/>

</xs:restriction></xs:simpleType>

</xs:attribute>

</xs:complexType>

<xs:element name="model" type="modelType"/><xs:complexType name="allowedType">

<xs:sequence>

<xs:choice minOccurs="0">



<xs:element ref="command"/><xs:element ref="branch-vpath"/>

<xs:element ref="vpath-regex"/>

<xs:element ref="role"/><xs:element ref="user"/>

<xs:element ref="group"/>

<xs:element ref="and"/>

<xs:element ref="or"/><xs:element ref="not"/>

</xs:choice>

</xs:sequence></xs:complexType>

<xs:element name="allowed" type="allowedType"/>

<xs:complexType name="andType"><xs:sequence>

<xs:choice maxOccurs="unbounded">





<xs:element ref="and"/><xs:element ref="or"/>

<xs:element ref="not"/>

</xs:choice></xs:sequence>

</xs:complexType>

<xs:element name="and" type="andType"/><xs:complexType name="orType">

<xs:sequence>

<xs:choice maxOccurs="unbounded"><xs:element ref="command"/>

<xs:element ref="branch-vpath"/>

<xs:element ref="vpath-regex"/><xs:element ref="role"/>

<xs:element ref="user"/>

<xs:element ref="group"/><xs:element ref="and"/>

<xs:element ref="or"/>

<xs:element ref="not"/></xs:choice>

</xs:sequence>

</xs:complexType>

<xs:element name="or" type="orType"/><xs:complexType name="notType">

<xs:choice>







<xs:element ref="and"/><xs:element ref="or"/>

<xs:element ref="not"/>

</xs:choice>

</xs:complexType><xs:element name="not" type="notType"/>

<xs:complexType name="userType">

<xs:attribute name="name" type="xs:string" use="required"/></xs:complexType>

<xs:element name="user" type="userType"/>

<xs:complexType name="groupType"><xs:attribute name="name" type="xs:string" use="required"/>

</xs:complexType>

<xs:element name="group" type="groupType"/><xs:complexType name="roleType">

<xs:attribute name="name" type="xs:string" use="required"/>

</xs:complexType><xs:element name="role" type="roleType"/>

<xs:complexType name="commandType">

<xs:attribute name="name" type="xs:string" use="required"/></xs:complexType>

<xs:element name="command" type="commandType"/>

<xs:complexType name="branch-vpathType"><xs:attribute name="vpath" type="xs:string" use="required"/>

<xs:attribute name="include-subbranches" default="true">




</xs:simpleType>

</xs:attribute></xs:complexType>

<xs:element name="branch-vpath" type="branch-vpathType"/>

<xs:complexType name="vpath-regexType"><xs:attribute name="regex" type="xs:string" use="required"/>

</xs:complexType>

<xs:element name="vpath-regex" type="vpath-regexType"/></xs:schema>

DataSourceConfig.xsdThe structure of the DataSourceConfig.xml file is based on the following schema (DataSourceConfig.xsd):


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>



<xs:schema xmlns="http://www.interwoven.com/schema/datasourceFramework" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.interwoven.com/schema/datasourceFramework" elementFormDefault="qualified" attributeFormDefault="unqualified">

<xs:element name="classname" type="xs:string"/>

<xs:complexType name="datasourceType"><xs:sequence>

<xs:element ref="name"/>

<xs:element ref="classname"/><xs:element name="namespace" type="xs:string" minOccurs="0"/>

<xs:element name="param" type="paramType" minOccurs="0"

maxOccurs="unbounded"/></xs:sequence>

</xs:complexType>

<xs:element name="datasources"><xs:complexType>

<xs:sequence>

<xs:element name="datasource" type="datasourceType" minOccurs="0" maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType></xs:element>

<xs:element name="name" type="xs:string"/>

<xs:complexType name="paramType"><xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute name="name" type="xs:string" use="required"/></xs:extension>

</xs:simpleContent>

</xs:complexType></xs:schema>

Appendix D

Troubleshooting

This chapter provides troubleshooting information for the errors that you may encounter while working with the Interwoven Workflow Modeler.

The following table lists some error messages and their possible cause and solution.

Table 37 Error messages

Error Message Possible Cause and Solution“BrowserLaunchingInitializingException” message is logged in the WorkflowModeler.log file.

The which command is unable to find the browser.Ensure that: • /usr/bin is always in the PATH.• <browser executable> is present in at least one of

the locations used by the which command to find the browser.

In the Choose Shortcut Folder screen, after selecting a folder using the Choose button, if you click Previous, then the Cancel, Previous, and Install buttons are disabled.

Click Choose to select another location for the shortcut. This action enables the Cancel, Previous, and Install buttons.

Unable to find the bpmn.css file on the file system. Some of the functions may not work as expected.

The bpmn.css file, typically located in installation_directory\resources\ilog\views\bpmn, has been moved, renamed, or deleted.Reinstall the Interwoven Workflow Modeler or copy the bpmn.css and bpmncore.css files from the Interwoven Workflow Modeler installation CD.

An exception occurred while creating the toolbar for tasks. Please check the log file for more information.

The activities.xml file, typically located in installation_directory\data\palettes, is corrupt. You can find more information in the installation_directory\WorkflowModeler.log file. Reinstall the Interwoven Workflow Modeler.

An exception occurred while creating the toolbar for events, flows, gateways, and so on. Please check the log file for more information.

The common.xml file, typically located in installation_directory\data\palettes, is corrupt. You can find more information in the installation_directory\WorkflowModeler.log file. Reinstall the Interwoven Workflow Modeler.


Appendix D: Troubleshooting

An exception occurred while initializing the Interwoven Workflow Modeler. Check the log file for more information.

The Interwoven Workflow Modeler installation is incorrect or corrupt. You can find more information in the installation_directory\WorkflowModeler.log file.Reinstall the Interwoven Workflow Modeler.

Unable to initialize the UI appearance according to the preferences.

The Interwoven Workflow Modeler is trying to use an appearance (look and feel) that is not supported by the current system.Edit the PreferencesSettings.cfg file located in installation_directory\resources folder. The ProcessModeler_LookandFeel entry must have the following value:ProcessModeler_LookandFeel=com.sun.java.swing.plaf.windows.WindowsLookAndFeel

Unable to find the TeamSite CSSDK properties file.

The samples.properties file, typically located in installation_directory\resources\ directory, has been moved, renamed, or deleted.Reinstall the Interwoven Workflow Modeler or copy the samples.properties file from the Interwoven Workflow Modeler installation CD.

Target directory does not exist on the TeamSite server.

The workarea iwadmin/main/workflowModels/WORKAREA/iw-wa/Models is missing from the TeamSite iwadmin store.Create the missing workarea in the iwadmin store.

Parent directory does not exist on the TeamSite server.

The Models directory does not exist on the TeamSite server.Create the missing directory: iwadmin/main/workflowModels/WORKAREA/iw-wa/Models

File update failed because the target directory is read-only.

For the current user, the iwadmin/main/workflowModels/WORKAREA/iw-wa/Models directory is read-only on the TeamSite server.Provide write permission for the current user for this directory.


Error Message Possible Cause and Solution



Unable to save the workflow model. Please view the log file for more information.

There can be several reasons for this error. Some common reasons are:• User does not have write permission on the

directory where the workflow model needs to be stored.

• The file may be in use by some other application.You can find detailed information in the installation_directory\WorkflowModeler.log file.If the problem is one of the two listed here:• Assign appropriate permissions to save the file on

the local file system.• Close the file if it is in use by another application.

Unable to load the workflow model.

User does not have appropriate permissions to retrieve models from the TeamSite server.Assign appropriate permissions on the TeamSite server for the current user.


Error Message Possible Cause and Solution


Index
Symbols$IW_USER 21, 46.ipm files 18, 49.wft files 21
Aaccess

workflow model 117active tasks 19adding

links to workflow models 51tasks to workflow models 50

administering workflow models 22Administration tab 122alignment grid 38Allow Editing option 39AND node 35AND operator 21, 35application settings

configuring 40application theme

configuring 41approval cycle

workflow models 22arranging

all elements 34links 34selected elements 34

Assigninstantiating workflow 134

attributesdefined 21of elements 21variables 21

Author Submit with Deploy 102Author Submit with Email 103Author Submit with Metadata 104author_submit_with_deploy.wft file 102author_submit_with_email.wft file 103author_submit_with_metadata.wft file 104available_models.xml 22available_models.xsd

schema 189available_templates.cfg file

structure 116available_templates.dtd file 189

BBoolean operators 21

operatorsBoolean 35

branchmodel access 119

branch contentworkflowModels 114

business processes and tasks 36

CCGI task 36changing

application theme 41color-coded links 44combining

model access 119command

model access 117commands

instantiating workflows 129Conditional link 35Config folder

workflowModels branch 114config.xml files 18Configurable Author Assignment 105configurable author assignment workflow model

107Configurable Author Submit 106configurable author submit workflow model 107Configurable Default Submit 107configurable default submit workflow 107configurable_author_assignment.cfg file 108configurable_author_assignment.wft file 105configurable_author_submit.cfg file 108configurable_author_submit.wft file 106configurable_default_submit.cfg file 108configurable_default_submit.wft file 107configuration files

.cfg 108available_templates.dtd 189


Index

configurable_author_assignment.cfg 108configurable_author_submit.cfg 108configurable_default_submit.cfg file 108workflow 108

configuringapplication settings 40shortcut keys 42workflow 111workflow validation prompt 40

configuring workflowsAdministration tab 123Content tab 126

confirmation messagesconfiguring 40

contentworkflow models as 22

Content tab 123converting

workflow model 55Create menu 36, 37creating

workflow model 166creating new workflow models 49, 166custom workflow configuration

selection order 127custom_config.xml

file 127custom_instantiation.cfg

selection order 144customizing

job form 143customizing workflow models 22

DDatasource

interfaces 145sample 181

default.ipm file extension 49installation folder (C:\Program

Files\Interwoven\WorkflowModeler) 25local location of workflow models 43, 49nodes in Tree pane 44project name 43workflow model name 49, 166

Default link 35default_config.cfg

file 115Deploy task 37designing

workflow model 166Display toolbar 37displaying

Properties pane 34

draft workflow modelretrieving 53

Dummy task 37duplicating

elements 34

Eediting

existing workflow models 51elements

adding to workflow models 50assigning properties 21duplicating 34grouping 34in the Tree pane 44Properties pane 45Start Event node 50ungrouping 34

Email task 36End Event node 35error messages

troubleshooting 195Error pane

illustrated 48validation results 47

executable fileInterwoven Workflow Modeler 23

extended attributesannotations 108

External task 36

FFailure link 35file

installation 23files

.ipm 18, 49

.wft 21available_models.xml 22config.xml 18workflow templates 21WorkflowModler.exe 31worklow configuration 18

Fit to Contents tool 38

Ggrid

allignment 38show or hide 38spacing option 39

Grid Spacing option 39group

model access 118


Index

Group task 36grouping

elements 34GUI elements

illustrated 33introduced 33

HHide/Show Overview option 45Hide/Show Overview tool 38Hide/Show Tree tool 38hiding

Properties pane 34hiding and showing GUI panes 37

Iicon, workflow models 21icons

New Diagram 49Open Diagram 51Start Event 50

Inactive linklinks

Inactive 35inactive tasks 19installation

file 23installing

default location 25Interwoven Workflow Modeler 23prerequisites

Interwoven Workflow Modelerinstalling 23

startup shortcut icons 26system requirements 23

Instance folderworkflowModels branch 114

instantiatingworkflow 129

instantiating workflowAssign 134command line 143Content Center Professional 129ContentCenter Standard 140New Job 130Submit 132TeamSite Front Office 142

instantiating workflowsAssign 22commands 129instantiation screen 22introduced 22New Job 22

Submit 22interfaces

Datasource 145Internal folder

workflowModels branch 115Interwoven Web daemon (iwwebd) 32Interwoven Workflow Modeler

creating workflow models 20executable file 23GUI elements 33logging into TeamSite 31new TeamSite features to accommodate 21starting 31TeamSite compatibility 21uninstalling 28

invokinglogin screen 40

iwwebd 32

Jjob form

customizing 143jobs

defined 20job instance 20job spec 22job specification 20

Llifecycle, of workflow models 17links

adding to Project pane 51arranging 34color-coded 44Conditional 35Default 35duplicating 34Failure 35icons illustrated 35repeating 34Success 35Timeout 35

Links toolbar 34local default location for workflow models 43Lock task 37Login dialog box 31login option 39Login to TeamSite option 39Logiout from TeamSite option 39logout option 39


Index

MMake Selection Active tool 37managing

outdated configuration 127workflow 111

managing workflow models 22managing workflows 122, 123menus

Create 36, 37Options 38View 38

Metadata task 36model access

branch 119combining 119command 117group 118role 118user 118

model elementattributes 116path separators 120

Model Properties node 44Models folder

workflowModels branch 115modes

Offline 32Online (logged into TeamSite) 32

modifyingapplication theme 41applications settings 40shortcut keys 42

NNested Workflow task 37New Diagram icon 49New Job

instantiating workflow 130nodes

AND 35duplicating 34End Event 35grouping 34icons illustrated 35introduced 21Model Properties 44NOT 35OR 35repeating 34Start Event 35, 50Text Annotation 36ungrouping 34Workflow Model 44

NOT node 35NOT operator 21, 35

OOffline mode 32Online mode (logged into TeamSite) 32Open Diagram icon 51operators

AND 35NOT 35OR 35

optional elements 20Options menu

Allow Editing 39Grid Spacing 39introduced 38Login to TeamSite 39Logout from TeamSite 39Sticky Actions 39Validating Workflow 39validating workflow models 38

OR node 35OR operator 21, 35organizing

all elements 34selected elements 34

outdated configurationmanaging 127

Overview paneillustrated 46versus the Project pane 46

PPan tool 38, 47panes

Error 47Overview 46Project 46Properties 45Tree 43, 44

password, TeamSite 32path separators

model element 120preference

setting 39Priority property

PropertiesPriority 46

Project paneadding links 51adding tasks 50displaying the allignment grid 38grid 39


Index

illustrated 43Options menu setting 38versus the Overview pane 46

propertiesassigning to elements 21required 50variables 21

Properties pane 45hiding 34showing 34showing or hiding 45

publishedworkflow model 113

published workflow modelretrieving 53

publishingworkflow model 179workflow models 21, 52

Rregular expressions

path separators 120repeating

elements 34required elements 20required properties 50Reset link

linksReset 35

retrievingworkflow model 53

Review task 36role

model access 118

Ssample

Datasource 181saving

workflow model 178schema

Subscription 189schemas

validation against in Error pane 47selection order

custom workflow configuration 127custom_instantiation.cfg 144

settingpreference 39

shortcut keyssetting 42

shortcutsfor starting the Interwoven Workflow Modeler

26

starting without 31startup (illustrated) 31

showingProperties pane 34

showing and hiding GUI panes 37solutions workflows

author_submit_with_deploy.wft file 102author_submit_with_email.wft file 103author_submit_with_metadata.wft file 104configurable author assignment 107configurable author submit 107configurable default submit 107configurable_author_assignment.wft file 105configurable_author_submit.wft file 106configurable_default_submit.wft file 107

Standard toolbar 34Start Event node 35Start Event nodes 50starting the Interwoven Workflow Modeler 31states of tasks 19Sticky Actions option 39Submit

instantiating workflow 132Submit task 37Subscription

schema 189Subscription schema

available_models.xsd 189Success link 35system requirements, for installing 23

Ttasks

active 19adding from the Tasks toolbar 36adding to Project pane 50as business processes 36as units of work 36CGI 36defined 19Deploy 37Dummy 37duplicating 34Email 36External 36Group 36grouping 34icons illustrated 36inactive 19Lock 37Metadata 36Nested Workflow 37repeating 34


Index

Review 36states 19Submit 37ungrouping 34Update 36URL 37User 36

Tasks toolbar 36TeamSite 39

administering workflow models 22branches and workflow models 22Interwoven Workflow Modeler compatibility 21logging into from Interwoven Workflow

Modeler 31new features for workflow models

21Option menu login option 39Option menu logout option 39password 32tsadmin store 52user name 32workflowModels branch 52

TeamSite branches 52terminology, workflow 18testing

workflow model 180Text Annotation node 36Timeout link 35toolbars

Display 37Links 34Standard 34Tasks 36

Tree panedefault nodes 44element list 44illustrated 44

troubleshootingerror messages 195

tsadmin store 52tutorial

Interwoven Workflow Modeler 163

Uungrouping

elements 34uninstalling

default program location 28icon on All Programs menu (illustrated) 31Interwoven Workflow Modeler 28

Update task 36upgrading

workflow model 55URL task 37

usermodel access 118

user nameTeamSite 32

User task 36

VValidate Workflow option 39Validate Workflow tool 38validating

workflow 34validating workflow models

from the Options menu 38results in Error pane 47

variable$IWUSER 46

variables$IWUSER 21introduced 21

View menu 38viewing

workflow models 136viewing workflow models

after instantiation 137before instantiation 136ContentCenter Professional 136

VisualAnnotate 109extended attributes 108introduced 108

Wworkflow

configuration files 108configuring 111managing 111terminology 18validating 34VisualAnnotate 109

workflow modelconfiguring access 117creating 49, 166published 113publishing 179retrieving 53saving 178testing 180upgrading 55

Workflow Model node 44workflow models 49

adding links 51adding tasks 50administering in TeamSite 22approval of 22


Index

as TeamSite content 22availability to branches 22available_models.xml 22configuring 123creating (overview) 20customizing 22defined 18differentiating from workflow templates 21editing existing 51example of (illustrated) 19icon that identifies 21instantiating 22introduced 17jobs 20lifecycle 17lifecycle (illustrated) 18managing 22, 116managing in TeamSite 52optional elements 20publishing 21, 52required elements 20subject to TeamSite workflow 22submitting in TeamSite 22tasks 19validating 47

workflow templatesdifferentiating from workflow models 21

workflowModelsbranch content 114

workflowModels branch 52Config folder 114Instance folder 114Internal folder 115Models folder 115

WorkflowModler.exe files 31

ZZoom tools 37


Index


wfm_1001_user_v01_en

Documents

Transcript of wfm_1001_user_v01_en