Command-Line Tools
Release 6.7.1
Service Pack 1
UNIX
®
© 1999-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, Inc.
160 East Tasman Drive
San Jose, CA 95134
http://www.interwoven.com
Printed in the United States of America
iwgettrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
iwgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
iwidmap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
iwmigrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
iwprefconv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
iwproxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
iwrecentusers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
iwreset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
iwrmuser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
iwroleadm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
iwsi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
iwstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77
iwstoreadm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
iwtestcfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81
iwtock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
iwuidname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83
iwuser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84
iwuseradm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87
iwutildreset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91
iwutildstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92
iwversion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93
Chapter 3: Development Tools 95
General Development Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95
Deployment Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96
Branch Operation Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
Edition Operation Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
Workarea Operation Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
Version Management Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98
Workflow and Job Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
Search and Index Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
iwaddtaskfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102
iwaddtaskgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103
iwaddtaskuser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
iwattrib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
iwauthen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
iwcallback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
iwcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116
iwckrole. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117
iwcmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118
iwcp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120
iwdecode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121
iwdelcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122
iwdeltaskfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
iwdiffapply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
iwdiffdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
iwencode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
iwevents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128
iwextattr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
iwfilestate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133
Interwoven, Inc. 4
Contents
iwgeteventcomments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136
iwgeteventfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
iwgettaskbyname. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138
iwgetwfobj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139
iwinvokejob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140
iwjobc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
iwjobvariable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142
iwlasted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143
iwldapmigrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144
iwldapsearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
iwldapsync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
iwlist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
iwlistlocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
iwlistmod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
iwlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
iwlockinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
iwmerge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157
iwmkbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
iwmkwa. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
iwmvtaskfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160
iwndxaddbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161
iwndxfreezebr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162
iwndxlistbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163
iwndxmgrfreeze. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164
iwndxmgrstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165
iwndxmgrstop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166
iwndxpurgebr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167
iwndxrefreshbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168
iwndxrmbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169
iwndxstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170
iwndxwamodificationsbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172
iwnexted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
iwprop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174
iwprv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .176
iwpublish. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177
iwqueryjobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178
iwquerytasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179
iwrcsdiff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181
iwrename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .183
iwretryjobop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184
iwrevert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185
iwrlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186
iwrmbr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .188
iwrmed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189
iwrmjob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .190
iwrmtaskfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191
iwrmtaskgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192
iwrmtaskuser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193
iwrmwa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194
iwsetjobdescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195
iwsetjobowner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196
iwsettaskattrib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .197
iwsettaskcomment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198
iwsettaskdescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .199
iwsettaskfilecomment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .200
iwsettaskownerandarea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201
iwsettasktimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202
iwsrchattrib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .203
iwsrchgethome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206
iwsrchgetpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207
iwsrchmgrping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209
iwsrchmgrstop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210
iwsrchndxstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
iwsrchndxstatuschg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213
iwsrchquery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214
iwsubmit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217
iwtaketask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218
iwtaskselect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219
iwtaskvariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .220
iwundochoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221
iwunlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .222
iwuntaketask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .223
iwupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224
iwvpath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225
Chapter 4: Command Triggers 227
Starting Command Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .228
Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .230
iwat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232
iwat-env. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233
iwatcreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .235
iwatlock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .236
iwatmkbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237
iwatmkwa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .238
iwatpub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239
iwatrmbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
iwatrmed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241
iwatrmwa. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242
iwatserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243
iwatsub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .244
iwatunlock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245
iwatupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .246
iwlsat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247
iwrmat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .248
Appendix A: Master List 249
Appendix B: Sample Command Trigger Scripts 257
Email Notification Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257
Replication Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .262
Interwoven, Inc. 6
Contents
Interwoven, Inc. 8
List of Tables
Table 1 Notation conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Table 2 CLT-related environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Table 3 System information tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Table 4 System services tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 5 Content Store tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Table 6 General development tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Table 7 Deployment tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Table 8 Branch operation tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Table 9 Edition operation tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Table 10 Workarea operation tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Table 11 Version management tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Table 12 Workflow and job tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Table 13 Search and index tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Table 14 Server attribute values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Table 15 Archive attribute values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Table 16 Branch attribute values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Table 17 Edition attribute values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Table 18 Workarea attribute values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Table 19 Submit event attribute values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Table 20 Update event attribute values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Table 21 Staging area attribute values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Table 22 File and directory attribute values . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Table 23 Query expressions and elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Table 24 Command trigger tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Table 25 Command triggers and TeamSite events . . . . . . . . . . . . . . . . . . . . . . . 230
Table 26 CLT alphabetized master list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Table 27 CLT error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Interwoven, Inc. 10
About This Book
TeamSite Command-Line Tools describes each TeamSite command-line tool (CLT) and
®
command trigger, including syntax and usage examples. It is intended primarily for
TeamSite Administrators and Master users, and for Web server administrators and
system administrators. Users of this manual should be familiar with basic UNIX
commands and be able to use an editor such as emacs or vi.
Many of the operations described in this manual require root access to the TeamSite
server. If you do not have root access to the TeamSite server, consult your UNIX system
administrator.
Notation Conventions
This manual uses the following notation conventions:
Interwoven, Inc. 12
Chapter 1
CLTs enable you to use the command line instead of the browser or file system interface
to perform most TeamSite administration and development tasks. For example,
TeamSite provides CLTs for creating and deleting branches and workareas, publishing,
deploying, assigning files, invoking the proxy server, interacting with jobs, and dozens
of other tasks. CLTs are designed for users and administrators who are comfortable
using a command-line interface, and who cannot or prefer not to use the browser or file
system interface.
In addition to CLTs, TeamSite also supports a set of command triggers that let you
configure TeamSite to execute custom scripts whenever certain events occur. For
example, you can use command triggers to execute an email notification script
whenever a file is assigned, or whenever a new branch is created, or when any of several
other supported events occur. The scripts that are triggered can be simple or complex
and typically are created by an administrator for a specific site or installation.
You should use CLTs and command triggers only if you have a good understanding of
TeamSite structure, roles, and concepts. When learning CLTs, it is often helpful to
monitor your activities using the GUI. If you choose to monitor from the GUI, be sure to
refresh your view often. In some cases, it might be helpful to run multiple TeamSite
sessions using the GUI.
The following sections briefly describe the default set of TeamSite CLTs and command
triggers.
CLTs
CLTs are organized into two main categories: administration tools and development
tools.
Administration Tools
Administration tools are divided into the following categories:
System Information. Returns system-wide information or information about a
file’s location.They do not provide information about the data in a file (the
development tool CLTs provide that type of information).
System Services. Enable you to manipulate files or objects that affect the entire
TeamSite system. Typical tasks include, but are not limited to, editing configuration
files, performing system backups, and starting the proxy server.
Content Store. Enables you to perform various tasks on the Content Store,
including checking for and fixing problems, converting to and from a multiple file
system Content Store, and merging metadata files.
See Chapter 2, “Administration Tools,” for details about the CLTs in each category.
Development Tools
Development tools are divided into the following categories:
General Tools. Enable you to perform operations on, or retrieve information about,
the data in a specific file or TeamSite object.
Deployment. Enable you to you deploy a TeamSite edition to a production server.
Branch Operations. Enable you to you create and manipulate TeamSite branches.
Edition Operations. Enable you to you create and manipulate TeamSite editions.
Workarea Operations. Enable you to create and manipulate TeamSite workareas.
Version Management. Return information about file revisions and versions, and let
you manipulate specific versions of files and directories.
Workflow/Job. Enable you to control workflow and job elements such as file locks,
assignments to authors, and file approval/rejection.
Templating. Enable you to update, insert data into, and otherwise manipulate
template-based files.
Search and Index. Enable you to administer the index manager and search server,
control indexing operations on a per-branch basis, and perform various search
operations (including queries).
See Chapter 3, “Development Tools,” for details about the CLTs in each category.
Interwoven, Inc. 14
Chapter 1: Overview of CLTs and Command Triggers
Command Triggers
All command triggers are described in Chapter 4, “Command Triggers”. Two sample
command trigger perl scripts—one that sends email notification and one that replicates
files—are shown in Appendix B, “Sample Command Trigger Scripts”.
Additionally, you can enter the name of the CLT followed by -h to obtain “help” on that
CLT. The help provides a brief description of the CLT and lists the flags and options for
that CLT. You can enter the CLT name followed by -v to display version information. If
-h or -v are specified, any other flags or options entered at the same time are ignored.
Version Paths
Most CLTs require that you use a version path (vpath) to specify the location of a
branch, workarea, staging area, edition, file, or directory in TeamSite. Vpaths are used
only for items within TeamSite; all other files (for example, configuration files) must be
specified with a directory path (see “Directory Paths” on page 17). Vpaths have the
following form:
To specify a server:
//servername
For example, the default vpath for the TeamSite server is:
//IWSERVER
For example, the default vpath for the TeamSite Content Store is:
//IWSERVER/default
For example, the default vpath for the main branch is:
//IWSERVER/default/main
The vpath for a subbranch named dev off of the main branch would be:
//IWSERVER/default/main/dev
To specify an edition:
//servername/archivename{[/branchname]+}/EDITION/editionname
For example, the default vpath for the initial edition on the main branch is:
//IWSERVER/default/main/EDITION/INITIAL
To specify a workarea:
//servername/archivename{[/branchname]+}/WORKAREA/workareaname
For example, the vpath for a workarea named eng on the main branch would be:
//IWSERVER/default/main/WORKAREA/eng
The vpath for a workarea named qa on the subbranch dev would be:
//IWSERVER/default/main/dev/WORKAREA/qa
For example, the vpath for a file named logo.gif in the directory /htdocs/gifs in
workarea eng on subbranch dev would be:
//IWSERVER/default/main/dev/WORKAREA/eng/htdocs/gifs/logo.gif
Relative vpaths
Most TeamSite CLTs only require you to specify relative vpaths. For example, instead
of specifying //IWSERVER/default/main you would only need to specify main. In the
following example, if you are already in the default directory, instead of specifying:
//IWSERVER/default/main/dev/WORKAREA/eng/htdocs/gifs/logo.gif
If you are in the htdocs directory of workarea eng on the main branch, you only need to
specify:
gifs/logo.gif
Interwoven, Inc. 16
Chapter 1: Overview of CLTs and Command Triggers
Directory Paths
Some CLTs require you to specify directory paths. These are the full file system mount
directory paths of a file in TeamSite, starting from the server’s root directory. When you
use a CLT, be sure to check whether it requires a directory path or a vpath.
When using any of these variables, you must set IWCLT_SERVER first. After
IWCLT_SERVER is set, it is typical to set just one of the other three variables, depending
on what is mounted on your system. For example, if the default archive is mounted, you
would set IWCLT_SERVER and IWCLT_DEFAULTMOUNT. You could then execute any
command residing on the defined server and mount point by entering just the command
name on the command line.
NOTE
If you set more than one MOUNT variable, TeamSite extracts information in the following
order: IWCLT_MOUNT, IWCLT_DEFAULTMOUNT, IWCLT_DEFAULTMAINMOUNT.
Object IDs
Some CLTs require that you specify object IDs (objids). Objids are identifiers for each
object (file, directory, workarea, staging area, edition, tag, and others) in the TeamSite
system. To find the objid for an item, use the iwattrib command (see “iwattrib” on
page 105). CLTs that require an objid also require further information about the objid,
such as what type of object it describes or the area in which it resides.
Class IDs
Each type of object has its own class ID. Class IDs are 8-digit hexadecimal numbers,
whose values for each class are as follows.
NOTE
This is only a partial list; additional classes are included with TeamSite.
server 0x00000051
archive 0x00002020
branch 0x00002250
workarea 0x00002100
edition 0x00002010
Interwoven, Inc. 18
Chapter 1: Overview of CLTs and Command Triggers
Specifying Comments
CLTs that use comments require them to be specified in one of two ways:
As a command option
As a required field
Specify the comment using the -c option. If you do not use the -c option, the change
comment will be read from stdin. After typing the comment, type Ctrl-D to exit.
NOTE
If you do not specify a comment, you must still type Ctrl-D to exit.
This method requires you to type a comment in the Comment field. If you do not want to
attach a comment, type two single quotes ( '' ) in the Comment field. If the comment
includes spaces, enclose it in a set of single quotes, for example, 'Please edit this
file.'
CLT Location
CLTs reside in the bin subdirectory of the directory returned by the iwgethome
command. Note that not everything contained in this directory is a CLT.
Interwoven, Inc. 20
Chapter 2
Administration Tools
This chapter describes the administration CLTs from the following groups:
System Information Tools
System Services Tools
Content Store Tools
The CLTs are grouped and summarized in the following sections. Each CLT is then
presented in detail, arranged alphabetically.
Interwoven, Inc. 22
Chapter 2: Administration Tools
iwabort
Provides a method for terminating a long-running server operation. The command
works on operations including submit, update, create branch, delete
branch/workarea/edition, and freeze. Before issuing iwabort, use iwstat to obtain the
identifier for the operation.
Use with submit and update operations. There are occasionally some places in
submit and update where they cannot be terminated by using iwabort. After issuing
iwabort, you may end up with some but not all the files submitted or updated.
Use with create and delete operations. The branch will not be created and may or
may not be deleted.
System Services.
Usage
iwabort operation_id
Example
Use iwstat to obtain the server status. Then, using the ID shown in the first column,
abort the submit operation.
%iwstat
%iwabort 0x24caee4b
Interwoven, Inc. 24
Chapter 2: Administration Tools
iwaccess
Controls TeamSite user permissions for access to files, directories, areas, branches,
Content Stores, servers, jobs, and tasks. Defines which roles one user can delegate to
another. Defines whether branches and workareas are public or private.
System Services.
Usage
iwaccess -h [command] | -v
iwaccess all-permission-entries
Interwoven, Inc. 26
Chapter 2: Administration Tools
delegable- vpath Displays the roles that user can delegate to other
roles-of-user -user user users in the context of the specified vpath.
Examples
The following command displays whether the user dinesh is allowed to edit files in the
workarea /default/main/Workarea/andre :
% iwaccess check-permission /default/main/WORKAREA/andre -user dinesh -op
Edit
Interwoven, Inc. 28
Chapter 2: Administration Tools
The following command displays whether the user dinesh is allowed to modify the
properties of task 1234 in the workarea /default/main/Workarea/andre:
% iwaccess check-task-permission 1234 -user dinesh -op
ModifyTaskProperties
The following command grants to the user dinesh the permission to perform the
operations associated with the role dbadmin on the branch /default/main. This
example assumes that the TeamSite role dbadmin is already defined:
% iwaccess add-permission-entry /default/main -user dinesh -role dbadmin
The following command makes the user dinesh the owner of the branch
/default/main:
% iwaccess set-owner /default/main dinesh
NOTE
Execute iwroleadm -all-operations for a list of valid operation names.
iwaccessmigrate
Migrates the old access model from a pre-6.7 TeamSite release to the new access model.
Can instead generate an XML manifest file of permission, group, and role settings for
use before or after an upgrade from a pre-6.7 TeamSite release. To use this CLT, you
must have read permission across all stores on the content server.
Interwoven, Inc. 30
Chapter 2: Administration Tools
5. At the server level, a group permission entry with the iwEveryone TeamSite group
and reviewer role is assigned.
6. On a per branch basis, if the branch’s “other” bits are 0 (that is, 770 or 750) and the
-i option is not specified, then the inherit-from-parent flag on the branch is set
to false. If the -i option is specified, the inherit-from-parent flag is always set
to true.
System Services.
Usage
iwaccessmigrate [-h] [-v]
iwaccessmigrate [-o] [-bg] [-n] [-i] [-m] [-g] [-b role]
iwaccessmigrate [-o] [-bg] [-p group-prefix] [-i] [-m] [-g] [-b role]
iwaccessmigrate [-o] [-f file]
Examples
The following command migrates the entire content server to the new access model.
Permissions are based on the existing TeamSite groups-for-sharing for each branch.
% iwaccessmigrate -bg
The following command accomplishes the same as the preceding command, except that
no new TeamSite groups will be created.
% iwaccessmigrate -bg -n
The following command applies permissions from a previously generated manifest file,
iw-home/etc/accessresults.xml.
% iwaccessmigrate -f iw-home/etc/accessresults.xml
Interwoven, Inc. 32
Chapter 2: Administration Tools
iwadduser
Adds a TeamSite user to the specified role files in iw-home/conf/roles and the entity
database.
System services.
Usage
iwadduser [-h|-V] -user username -roles roleList
Example
% iwadduser -V -user jerome -roles master,admin
Adds the user jerome to TeamSite master and admin roles files.
iwancestor
Prints the vpath of the common ancestor of the specified files.
System Information.
Usage
iwancestor [-i] vpath1 vpath2
Interwoven, Inc. 34
Chapter 2: Administration Tools
iwchgrp
iwchgrp is equivalent to the UNIX chgrp command. Because TeamSite retains the
concept of group ownership of branches and workareas, iwchgrp allows you to change
the group of a file, directory, branch, workarea, or file system entity such as a link. To
change the group of a branch, workarea, or FSE, you must be the owner.
System Services.
Usage
iwchgrp [-h|-v] group path
Examples
%iwchgrp Administrators /default/main/dev/Workarea/andre
changes the group of workarea andre on the dev branch to the local group of
administrators.
%iwchgrp WEBSTER/Marketing /default/main/dev/Workarea/andre
changes the group of workarea andre on the dev branch to the Marketing group in the
WEBSTER domain.
iwconfig
A command line interface to TeamSite’s main configuration file, iw.cfg. Allows you to
read the configuration file, list the names of all the sections in the configuration file, or
write to the configuration file. For information on configuring iw.cfg, see the TeamSite
Administration Guide.
System Services.
Usage
iwconfig [options] section varname [value]
Example
%iwconfig -l
returns:
main
iwcgi
iwproxy
iwproxy_remap
global_default_map
iwproxy_external_remap
iwserver
returns:
775
Interwoven, Inc. 36
Chapter 2: Administration Tools
iwconfigtsreport
A command line interface to the TeamSite Reporting configuration file
iw-home/tsreport/conf/tsreport.xml. Allows you to reset all parameters in the
configuration file. For information about file syntax, supported events, and other
reporting features, see the TeamSite Administration Guide.
System Services.
Usage
iwconfigtsreport [-db*]
iwconfigtsreport -dbuser username -dbpasswd password
iwconfigtsreport -licensekey
iwconfigtsreport -jndiport
When specifying db* command line options (such as dbtype, dbserver, and so on), you
must use one of the following combinations:
All of the db* options (dbtype, dbserver, dbport, dbname, dbuser, and dbpasswd)
must be used together on the same command line, or
The dbuser and dbpasswd options must be used together on the same command line.
Specifying all db* options on the same command line sets the database type and
configures the schema. Specifying just dbuser and dbpasswd configures the database
user and password without creating the schema.
Examples
%iwconfigtsreport -dbtype mssql -dbname db1 -dbserver server1 -dbport 8085
-dbuser shashi -dbpasswd asdfjkl
sets the reporting database type to MS SQL Server 2000 and configures the schema.
Interwoven, Inc. 38
Chapter 2: Administration Tools
iwconvertserver
The iwconvertserver process supports the Content Store conversion GUI by
communicating with remote TeamSite servers. You must run the iwconvertserver
process manually for the GUI to function properly.
Content Store.
Usage
iwconvertserver [-h|-v|-V level]
General Options
Procedure
1. Change to the iw-home/bin directory, for example:
%cd /iw-home/bin
2. Run the iwconvertserver utility from iw-home/bin with no arguments.
iwfreeze
Freezes and unfreezes all system writes. Unlike a full server stop, users can still log into
the system and read data.
To determine whether the TeamSite server is currently frozen, use the iwstat (page 77)
command-line tool.
System Services.
Usage
iwfreeze [-h|-v|+N|-j|--] [backing_store]
Examples
%iwfreeze +30
returns:
Freeze archive default for 30 seconds...
%iwfreeze --
returns:
Archive default unfrozen.
Interwoven, Inc. 40
Chapter 2: Administration Tools
Notes
When iwfreeze is issued, the system performs the following activities:
Blocks new operations.
Completes all current operations.
Flushes the cache.
Issues a message telling users an iwfreeze has occurred.
Returns write operations with a failure status message.
Performs read-only operations.
iwfsck
Diagnoses Content Store problems and enables repair of some of the problems found.
Content Store.
Usage
iwfsck [-h] [-v] [-xxx] [-l] [-a] [-b path] [-c size] [vpath]
[-nofmtchk] [-z] [-d [-f] [-s] [-m] [-p] [-r]]
Interwoven, Inc. 42
Chapter 2: Administration Tools
Examples
% iwfsck
To check directories and files in addition to branches and areas, issue the command:
% iwfsck -d
Use the following command to check protopaths and parents in addition to branches,
areas, directories, and files. This command can be very resource intensive.
% iwfsck -d -p -r
iwfsfix
The iwfsfix command repairs certain problems. If iwfsck (see page 42) finds problems
when the Content Store is diagnosed, it outputs lines in the format:
FIX iwfsfix repair args
The repairs and their arguments are shown below. The content of these lines, following
the word FIX, are iwfsfix command lines. To perform repairs, copy the FIX line issued
by iwfsck and paste it on the command line, with the word FIX removed.
There are also repairs for ModLists that must be performed when the TeamSite server is
running. These lines are in the format:
FIX /bin/touch junkfile; /bin/rm junkfile
where junkfile is a uniquely named file that is created and removed from an affected
directory.
Removes the reference to a tag (lock) from a branch. This is done when the tag point
itself is missing.
delete_tag_and_point branch_id tag_id
Deletes the reference to a tag (lock) from a branch and removes the tag point itself.
This is done when a tag duplicates or conflicts with another tag within a branch.
delete_direntry directory_id diritems_index filename
Deletes the reference to an area (workarea or edition) from a branch. This cannot be
done on a staging area because a branch by definition always contains a staging
area.
null_previous point_id
Sets to null (-1) the PreviousPoint reference within a point. This is done when the
PreviousPoint reference for a point is incorrect.
clone_diritems directory_id diritems_index new_gen_id new_dot_dot
Clones a set of directory items within a directory to create a new set. This is done
when a set of directory items is shared between areas, but it should not be shared.
Interwoven, Inc. 44
Chapter 2: Administration Tools
iwfsshrink
Invokes a batch job in the server to find and remove duplicate file contents in the
Content Store. This command is used to improve space usage in an existing Content
Store. It can be used as a maintenance tool on a regular, perhaps quarterly, basis. This
operation results in no user-visible changes to the TeamSite virtual file system; for
example, file histories are unchanged.
Content Store.
Usage
iwfsshrink [-h|-v] [run|pause|abort|status] [store]
Examples
Issuing iwfsshrink status when iwfsshrink has finished running results in status
similar to:
Issuing the iwfsshrink run command, followed by the iwfsshrink status command,
results in status similar to:
Current run started Tue Jul 11 14:19:20 2000
Not yet completed
In phase 1
Files examined: 980
Bytes examined: 67053122
Files found to be duplicates: 0
Files converted: 0
Bytes removed: 0
Interwoven, Inc. 46
Chapter 2: Administration Tools
iwgetelog
Displays the contents of /etc/defaultiwelog (the TeamSite events log) or exits with a
nonzero error code. The TeamSite events log includes the time an operation was
performed, the username and role of the user, the type of operation, the area or file
affected, and additional information according to the type of operation performed (for
example, objids and comments attached to files and operations).
System Information.
Usage
iwgetelog [-h|-v|-o]
Example
% iwgetelog
returns:
/var/adm/iwevents.log
iwgetfilejobs
Displays a list of associated workflow job and task IDs for a file.
System Information.
Usage
iwgetfilejobs [-h] [-v] [-s servername] path
Example
% iwgetfilejobs -s factotum /default/main/WORKAREA/kconnor/foo.txt
returns:
job=125998 task=125999
You can use the returned job or task ID with a command like iwgetwfobj as described
on page 139.
Interwoven, Inc. 48
Chapter 2: Administration Tools
iwgethome
Displays the location of the TeamSite program files (the contents of
/etc/defaultiwhome).
System Information.
Usage
iwgethome [-h|-v]
Example
% iwgethome
returns
/usr/iw-home
iwgetlocation
Displays the location of various TeamSite configuration or log files.
System Information.
Usage
iwgetlocation [-h|-v] [-a|-l|-c configfilekey|-g logfilekey|filekey
[filekey...]]
Examples
% iwgetlocation -l
returns:
iwhome
iwbin
iwconfig
iwstore
iwmount
iwcgimount
iwroles
iwlogs
iwconfigs
iweventlog
iwtracelog
iwdeploylog
% iwgetlocation -a
returns:
iwhome=/usr/iw-home
iwbin=/usr/iw-home/bin
iwconfig=/etc/iw.cfg
iwstore=/local/iw-store
iwmount=/iwmnt
Interwoven, Inc. 50
Chapter 2: Administration Tools
iwcgimount=/.iwmnt
iwroles=/usr/iw-home/conf/roles
iwlogs=/var/adm
iwconfigs=/usr/iw-home/local/config
iweventlog=/var/adm/iwevents.log
iwserverlog=/var/adm/iwserver.log
iwtracelog=/var/adm/iwtrace.log
iwdeploylog=/var/adm/iwdeploy.log
% iwgetlocation iwmount
returns:
/iwmnt
% iwgetlocation -c iwconfig
returns:
/etc/iw.cfg
returns:
/iwmnt
/etc/iw.cfg
/var/adm/iwevents.log
iwgetlog
Displays the contents of /etc/defaultiwlog (the location of the TeamSite server log)
or exits with a nonzero error code. The TeamSite server log contains a record of server
starts and stops, and records any problems encountered at server starts and stops.
System Information.
Usage
iwgetlog [-h|-v|-o]
Example
% iwgetlog
returns:
/var/adm/iwserver.log
Interwoven, Inc. 52
Chapter 2: Administration Tools
iwgetmount
Displays the location of TeamSite mount point (the contents of /etc/defaultiwmount).
System Information.
Usage
iwgetmount [-h|-v|-o]
Example
% iwgetmount
returns:
/iwmnt
iwgetstore
Displays the contents of /etc/defaultiwstore (the location of the TeamSite Content
Store) or exits with a non-zero error code.
System Information.
Usage
iwgetstore [-h|-v|-o]
Example
% iwgetstore
returns:
/local/iw-store
Interwoven, Inc. 54
Chapter 2: Administration Tools
iwgettrace
Displays the contents of /etc/defaultiwtrace (the location of the TeamSite trace logs)
or exits with a nonzero error code. The trace log contains debug information for
TeamSite.
System Information.
Usage
iwgettrace [-h|-v|-o]
Example
% iwgettrace
returns:
/var/adm/iwtrace.log
iwgroup
Administers TeamSite groups.
System Services.
Usage
iwgroup -h [command]|-v
iwgroup id groupname
Interwoven, Inc. 56
Chapter 2: Administration Tools
Interwoven, Inc. 58
Chapter 2: Administration Tools
Examples
adds the empty TeamSite group headquarters with an ID of 77 to the default TeamSite
group file iw-home/conf/iwov.grp.
adds all TeamSite groups contained in engr.xml (as defined by the iwgroup elements) to
the TeamSite group file master.xml.
deletes the TeamSite group headquarters from the default TeamSite group file
iw-home/conf/iwov.grp.
Deletes all TeamSite groups contained in engr.xml (as defined by the iwgroup
elements) from the TeamSite group file master.xml.
Adds the user dinesh to the TeamSite group headquarters in the default TeamSite
group file iw-home/conf/iwov.grp.
Interwoven, Inc. 60
Chapter 2: Administration Tools
Adds all TeamSite users and groups contained in engr.xml (as defined by the user and
group elements) to the TeamSite group file master.xml.
% iwgroup list-groups -a
Displays a list of all TeamSite groups in the default TeamSite group file
iw-home/conf/iwov.grp.
Displays a list of all members of the TeamSite group sveng in the default TeamSite
group file iw-home/conf/iwov.grp.
Displays a list of all members of the TeamSite group sveng in the TeamSite group file
engr.xml.
Changes the ID of the TeamSite group sveng to 3 in the default TeamSite group file
iw-home/conf/iwov.grp.
Changes the name of the TeamSite group sveng to svengnew in the TeamSite group file
engr.xml.
NOTE
The following files show the formats used by TeamSite group files as specified by
inputfile.
Interwoven, Inc. 62
Chapter 2: Administration Tools
iwidmap
The iwidmap CLT changes the mapping between the UID and the token. It can also be
used to refresh the mapping when the same names are used, and the UID has changed.
For more information about UID mapping, see the TeamSite Administration Guide.
Content Store.
Usage
iwidmap [-v] [-h] (-u | -g) [-a][-c user1 user2]
[-x file | -i file] backing-store
NOTES
When OS users or groups are imported or exported, only the OS IDs (“ID” for both
users and groups) are imported/exported.
When non-OS users or groups are imported or exported, only the TeamSite IDs
(“IWUID” or “IWGID”) are imported/exported.IWUID is the tsid attribute set in
tsusers.xml while IWGID is the id attribute set in tsgroups.xml.
Examples
To change the mapping for multiple users and edit idmap.xml so that old names are
replaced with new names:
% iwidmap -u -i /idmap.xml -a /iw-store/NewReleases
iwmigrate
The iwmigrate CLT accepts TeamSite 6.x Content Stores as its source. It can be used to
split a single Content Store into multiple Content Stores, or to move the contents of a
store to another location without losing the history of submit events for the editions.
Content Store.
Usage
iwmigrate [-h] [-v] [-x] [-m mount_location] -o new_backing_location
[-b branch_vpath] [-s starting_ed] [-e ending_ed] [-t timeout] [-c] [-d]
[-f] [-l] [-a cache_size] [-w [only] [-file path | workarea_name]
Interwoven, Inc. 64
Chapter 2: Administration Tools
Example
% iwmigrate -m iwmnt/default -o /iw-store/safari_on_line
-b /default/main/examples
For the branch specified by -b option, migrate all the workareas using -w by itself:
% iwmigrate -m /iwmnt/default -b /default/main
-o /local/new-store/default -w
For the branch specified by -b option, migrate all the workareas listed in the file using
the -w -file file_name format:
% iwmigrate -m /iwmnt/default -b /default/main -o /local/new-store/default
-w -file filename
NOTE
file_name is a file containing a list of workarea names.
For the branch specified by -b option, migrate only named workareas or the workareas
listed in the file using the -w -only [[-f file_name] | [workarea_name]] format:
% iwmigrate -m /iwmnt/default -b /default/main -o /local/new-store/default
-w -only
% iwmigrate -m /iwmnt/default -b /default/main -o /local/new-store/default
-w -only wa1,wa2
% iwmigrate -m /iwmnt/default -b /default/main -o /local/new-store/default
-w -only -file file_name
Using the -only option means that editions will not be migrated.
iwprefconv
The SetHomePage functionality stores the home page information in the entity database
instead of the iwprofiles directory.
If you are upgrading from a pre-5.5.1 release of TeamSite, you must run the iwprefconv
CLT once to copy any existing home page information from the iwprofiles directory
(iw-home/local/iwprofiles) to the entity database (iw-home/local/entities/data).
If you are installing TeamSite without upgrading from a previous TeamSite release, the
home page information is stored in the entity database by default.
To run the iwprefconvCLT, iwserver must be running and you must be logged on as the
root user.
System Services.
Usage
iwprefconv
Interwoven, Inc. 66
Chapter 2: Administration Tools
iwproxy
Invokes and debugs the proxy server. The proxy server is automatically invoked at
startup time.
System Services.
Usage
iwproxy [-h|-v|-d|-x]
Example
% iwproxy -d
returns:
Using tickets for authentication
Using newfangled blobs
[iwproxy] max_connections (default): 100
[iwproxy: using gethostname() for local hostname: factotum]
[iwproxy: changed local hostname to result of gethostbyname(factotum):
factotum.interwoven.com]
[iwproxy] listening at http://factotum.interwoven.com:1080
[iwproxy] using customer web server at http://factotum.interwoven.com:81
[iwproxy] using servlet engine at http://localhost:8080/iw-ts
[iwproxy] using iwwebd at http://fully.qualified.hostname.com:80
[external remap configuration]
[name not set]
key: 0
docroot: [no docroot specified]
[local remap configuration]
/
key: 0
docroot: [no docroot specified]
iwrecentusers
Displays a list of everyone who has used TeamSite since the last time the TeamSite
server was started. The list also contains a timestamp of each user’s most recent
TeamSite operation.
System Information.
Usage
iwrecentusers [-h|-v|-Gn]
Example
%iwrecentusers
returns:
bgunn Mon Sep 16 16:17:08 2004
umaster Fri Sep 13 14:07:59 2004
jgarcia Fri Sep 13 14:05:12 2004
nobody Wed Sep 11 15:34:55 2004
root Mon Sep 9 13:05:02 2004
Interwoven, Inc. 68
Chapter 2: Administration Tools
iwreset
Tells the TeamSite server to reread the TeamSite configuration files (iw.cfg,
submit.cfg, autoprivate.cfg, and the roles files) and resets iwserver based on the
values in the configuration files.
System Services.
Usage
iwreset [-a|-h|-ui|-v]
Example
% iwreset
Tells the TeamSite server to read the TeamSite configuration files and reset iwserver.
Notes
Exits with 0 on success, non-zero on failure.
All except the following iw.cfg settings are reset when iwreset executes. You must
restart TeamSite for the following settings to reset.
Cache size (set in [iwserver])
File system thread count (set in [iwserver])
File system active area cache (set in [iwserver])
File locations (set in [locations])
iwrmuser
Removes a TeamSite user from all role files in iw-home/conf/roles and the entity
database.
System Services.
Usage
iwrmuser -h|-v [-V] username
Example
% iwrmuser.ipl jerome
Removes the user jerome from TeamSite. Note that unlike iwadduser, you cannot
selectively remove users from specific role files.
Interwoven, Inc. 70
Chapter 2: Administration Tools
iwroleadm
Administer roles for TeamSite users and groups.
System Services.
Usage
iwroleadm -h [command]|-v
iwroleadm all-roles
Interwoven, Inc. 72
Chapter 2: Administration Tools
Notes
Depending on your system configuration, user operations are defined in one or more
of the following files:
iw-home/private/etc/userops.xml
iw-home/private/etc/userops_ui.xml
iw-home/private/etc/userops_*.xml
If you edit any of these files manually (as opposed to using a command-line tool
such as iwroleadm), you must run iwreset to pass the changes to the TeamSite
server.
Examples
The following command displays all possible operations that a role can be configured to
perform.
% iwroleadm all-operations
The following command adds to the db_admin role the ability to lock and merge files.
% iwroleadm add-operations db_admin LockFile MergeFile
The following command displays the roles that db_admin can delegate.
% iwroleadm delegable-roles db_admin
The following command adds the eng_db role to the list of roles that db_admin can
delegate. This command assumes that the eng_db role already exists.
% iwroleadm add-delegable-roles db_admin eng_db
Interwoven, Inc. 74
Chapter 2: Administration Tools
iwsi
Available only if the service monitor option of TeamSite is installed. Collects TeamSite
state data about the local environment, including core and configuration files. Files
collected are not deleted from their original locations. Data is stored and compressed in
an archive file named si.timestamp in either iw-home or a specified alternate location.
The command exits after executing; it does not run as a daemon.
System Services.
Usage
iwsi [-h|-v] [file]
Exit Status
NOTES
The value of timestamp in the archive file name has the format yymmdd.hhmmss.
iwtrace.log
iwdeploy.log
Configuration Files:
iw.cfg
$IW_HOME/local/config/submit.cfg
$IW_HOME/local/config/autoprivate.cfg
Core Files:
$IW_HOME/core
Server and Process Output Files:
iwserver
informationprocessid (a file containing output from the following
commands: df, mount, uname, iwversion)
Interwoven, Inc. 76
Chapter 2: Administration Tools
iwstat
Returns current system activity and displays information about whether the Content
Store is running, frozen (with iwfreeze), flushing, out of space (disklow), or has
experienced an I/O error (diskfail). Throughput information is displayed only if the
thruputmonitoring parameter is set to on in iw.cfg (by default it is set to off). Also
displays statistics about completed operations on the TeamSite server
System Information.
Usage
iwstat -h|-v
iwstat [-c] [-Gn] [-i sleep_interval] [-m] [-mm] [-mresettime]
[-mstarttime] [-mz] [-n iterations]
Examples
% iwstat
The following output from iwstat was obtained while the Content Stores default and
workflow were running.
% iwstat
Store Status
defalut Running
workflow Running
The preceding example shows that in the most recent complete one-minute time
duration, the TeamSite server handled 27 operations per second. Each operation took an
average of 0.0189 seconds per operation (19 ms/operation). The average load over this
Interwoven, Inc. 78
Chapter 2: Administration Tools
one minute was 51%. By comparison, a two-cpu server is fully loaded at 200% load, a
four-cpu server is fully loaded at 400% load, and so on. Similarly, for a recent complete
15-minute duration, TeamSite handled 14 operations per second, with an average
operation time of 22 ms. Over this time, the server was occupied at 30% load.
Comparing the short and long duration figures shows the load trends. For example, a
high one-minute load, compared with a lower 60-minute load, tells you that there was a
burst of activity. You can also observe that this is not a fast server, because 27 operations
per second at 50% load is not much throughput. A fast server with fast disks can achieve
operation throughput in the 200-500 operations per second range, with operation times
in the 1-5 ms/operation range.
Finally, a load that is near or exceeds the number of CPUs on the server over a sustained
number of hours may indicate an overloaded server. It may also indicate a need to obtain
a more powerful server or a faster Content Store volume.
The following partial output from iwstat -m was obtained while the Content Stores
default and workflow were running.
% iwstat -m
Store Status
default Running
workflow Running
iwstoreadm
Content Store administration involves creating, activating, and deactivating Content
Stores by using the iwstoreadm CLT. When the iwstoreadm -a storename command is
issued, the following sequence is triggered:
The iw.cfg file is checked to see if a store_directory_storename or
store_comment_storename entry exists. If either does, its definitions are used to
create the Content Store. If these entries do not exist, the Content Store is created as
described in the next bullet.
The Content Store directory is automatically created in /local/iw-store/ and
populated with a minimal Content Store containing a branch named main. The store
remains active until explicitly deactivated by using iwstoreadm -d (even if the
server is stopped and restarted).
Deactivating a store does not delete it. A store can be deactivated, moved to a new
location, and reactivated using original name (though it will be assigned a new store
ID).
Content Store.
Usage
iwstoreadm [-h|-v] [-a store_name] [-d store_name] [-l]
Example
%iwstoreadm -l
Interwoven, Inc. 80
Chapter 2: Administration Tools
iwtestcfg
Returns the submit filtering operation that will be performed upon a file at submission
time. For more information about submit filtering, see the TeamSite Administration
Guide.
System Services.
Usage
iwtestcfg [-h|-v] vpath
Example
% iwtestcfg /default/main/WORKAREA/andre/cgi/test.sh
returns:
Matched area "^/default/main/WORKAREA/.*$"
Matched fse ".*\.sh$"
Actions to do are:
omask=0111
which means that TeamSite is configured to set execute permissions on the specified file
at the time that the file is submitted.
iwtock
Available only if the service monitor feature of TeamSite is installed. Displays
information about the TeamSite iwtock watchdog daemon and lets you specify iw-home
and Content Store locations used by iwtock.
System Services.
Usage
iwtock [-h|-v|] -H iwhomedirpath -s bckstoredirpath
Exit Status
Example
% iwtock -H `/bin/iwgethome` -s `/bin/iwgetstore`
Interwoven, Inc. 82
Chapter 2: Administration Tools
iwuidname
Looks up the user login name corresponding to the specified UID.
System Services.
Usage
iwuidname [-h|-v] uid
Example
% iwuidname 2205
Returns:
andre
iwuser
Enables you to manipulate TeamSite user information.
System Information.
Usage
iwuser action ident [options]
Interwoven, Inc. 84
Chapter 2: Administration Tools
Interwoven, Inc. 86
Chapter 2: Administration Tools
iwuseradm
Add and remove TeamSite users, change user attributes, manage authentication, view
and set user roles, specify default user interfaces.
System Services.
Usage
iwuseradm -h [command]|-v
iwuseradm id user
iwuseradm list-masters
Interwoven, Inc. 88
Chapter 2: Administration Tools
Examples
The following command creates a TeamSite user dinesh who is also an OS user. The
password for dinesh is the same as that for his OS user account.
% iwuseradm add-user dinesh
The following command creates a TeamSite user dinesh who is not an OS user. The
password for dinesh is xyz123.
% iwuseradm add-user dinesh -n -p xyz123
The following command displays whether the user dinesh is a master user.
% iwuseradm master dinesh
The following command specifies that the user dinesh is a master user.
% iwuseradm set-master dinesh true
Interwoven, Inc. 90
Chapter 2: Administration Tools
iwutildreset
Resets utility daemon configuration settings. Does not return any output when
successfully executed. For more information about the utility daemon, see the TeamSite
Administration Guide.
System Services.
Usage
iwutildreset [-h host_name] [-p port_number] [-d ssl_dir]
iwutildstat
Displays active utility daemon operation statistics. For more information about the
utility daemon, see the TeamSite Administration Guide.
System Services.
Usage
iwutildstat [-h host_name] [-p port_number] [-d ssl_dir] [-a]
Example
% iwutildstat -a
Returns:
Active operations:
ID Name Arg Duration
38 GetServerStats 0.000
Completed operations:
Name Count AvgDuration MinDuration MaxDuration
Connect 19 0.000 0.000 0.000
ExecuteCommandAsync 4 0.003 0.000 0.015
ResetConfig 2 0.007 0.000 0.015
GetServerStats 12 0.000 0.000 0.000
Interwoven, Inc. 92
Chapter 2: Administration Tools
iwversion
Returns the current TeamSite release information. It is often used as a test to see if the
TeamSite server is running. Executing iwversion makes a call to iwserver and reads
the version string from iwserver.
System Information.
Usage
iwversion [-h|-v]
NOTE
When iwserver is running, iwversion displays the same result as iwserver -v.
iwversion -v displays the version string that is embedded into the iwversion CLT. If
you have installed patches, the two version strings may not be the same.
Example
% iwversion
returns:
iwserver: 6.7.0 Build 41235 Interwoven 20060328
Interwoven, Inc. 94
Chapter 3
Development Tools
This chapter describes the development CLTs from the following groups:
General Development Tools
Deployment Tools
Branch Operation Tools
Edition Operation Tools
Workarea Operation Tools
Version Management Tools
Workflow and Job Tools
Search and Index Tools
The CLTs are grouped and summarized in the following sections. Each CLT is then
presented in detail, arranged alphabetically.
Deployment Tools
Deployment CLTs enable you to deploy a TeamSite edition to a production server. The
CLTs in this category are:
Interwoven, Inc. 96
Chapter 3: Development Tools
Interwoven, Inc. 98
Chapter 3: Development Tools
NOTE
Within CLTs and examples, you may find references to index server or search server.
These terms are used interchangeably with index manager and search manager,
respectively.
iwaddtaskfile
Adds a file to a specified task in an instantiated job.
Workflow/Job.
Usage
iwaddtaskfile [-h|-v] [-s servername] taskID path+ comment
Example
iwaddtaskgroup
Adds groups to group tasks.
Workflow/Job.
Usage
iwaddtaskgroup [-h] [-v] [-s servername] taskID group
Example
% iwaddtaskgroup 343 graphics
iwaddtaskuser
Adds users to tasks.
Workflow/Job.
Usage
iwaddtaskuser [-h] [-v] [-s servername] taskID user
Example
% iwaddtaskuser -s eaglesmith 105 fred
iwattrib
Displays metadata information about any object in the TeamSite server, including all
branches, workareas, editions, staging areas, files, directories, and symlinks.
General Development.
Usage
One possible returned attribute is flags. Typical returned iwattrib -o flag values
would look similar to:
0x00010000—directory
0x00100000—symlink
0x00000002—deleted
0x00040000—private
The iwattrib CLT can also return a value that is the result of a bitwise OR operation.
For example, for a file that is a directory and private, iwattrib returns the value:
0x00050000
Examples
% iwattrib -l main
returns the names of all the attributes available for the main branch:
cid
objid
crdate
creator
owner
group
name
label
moddate
busy
rootedition
firstedition
lastedition
parentbranch
archive
branchcount
editioncount
workareacount
% iwattrib main objid
returns the objid of the TeamSite archive containing the main branch:
0x000020200000000000000064
Server
Archive
Branch
Edition
Workarea
Submit Event
Update Event
Staging Area
iwauthen
Authenticates the user (by username) by checking the corresponding password. To
prevent the password from being displayed on the command line, the password is passed
to this CLT by the environment variable IWCLT_PASSWORD.
General Development
Usage
iwauthen [-c|-d domain|-h|-v] user
-c Only checks if the username exists (does not use the password
for authentication).
-d domain Specifies the domain against which to authenticate the user
(when logging in to TeamSite on Windows servers).
-h Displays usage message.
-v Displays version.
user Specifies the user to authenticate.
Examples
% iwauthen bgunn
Returns:
0 and prints YES if the password is correct.
1 and prints NO if the password is not correct.
Returns a number greater than 1 if an error occurred while authenticating.
% iwauthen -c nyoung
Returns:
0 and prints YES if the username exists.
1 and prints NO if the username does not exist.
Returns a number greater than 1 if an error occurred while checking.
Notes
The iwauthen CLT is often used in conjunction with the iwckrole CLT as described in
the following scenario:
After installing TeamSite, a user cannot log into TeamSite. To find out why:
1. Run iwckrole.
The results will confirm whether or not the user is configured with the role with
which he or she is trying to log in. If iwckrole fails, there is a problem with the
user’s role, otherwise, continue to step 2.
2. Run iwauthen -c username to determine if the user is known to the system.
If it fails, then the user account is missing, otherwise, continue to step 3.
3. Run iwauthen username.
If it fails, the password being used for authentication is wrong.
For detailed information about the iwckrole CLT, see page 117.
iwcallback
Notifies the server that the program corresponding to an <externaltask/> or
<cgitask/> is finished and passes the server a return code.
Workflow/Job.
Usage
iwcallback [-h|-v] [-s servername] taskID returnCode [comment]
Example
The following command sends the return code 2 to the server production.example.com
when the program named in task 7734 finishes running:
iwcat
iwcat is cat for TeamSite files. If you specify a vpath to the file, you will see the
current version of the file in the area you specify. You can view any previous version of
a file by specifying the objid for that version.
Version Management.
Usage
iwcat [-h|-v] filevpath
iwcat -o fileobjid directoryvpath
Examples
% iwcat main/WORKAREA/andre/htdocs/about2.html
displays the version of the file that has the objid 0x0000007b0000007d000000bb (in this
case, the second most recent version of about2.html). directoryvpath can point to any
area containing the file.
iwckrole
Checks whether the specified user has the specified role.
General Development.
Usage
iwckrole [-h|-v] role user
Example
% iwckrole admin andre
Returns:
YES
iwcmp
Compares any two TeamSite areas and reports an exhaustive list of all modifications.
Version Management.
Usage
iwcmp [-h|-v][-z] area1vpath area2vpath
Example
%iwcmp main/branch1/WORKAREA/wa1 main/branch1/WORKAREA/wa2
Returns:
x+ f htdocs/about.html
f+ - htdocs/about2.html
d+ - htdocs/support/
f+ - htdocs/main.html
f fp+ htdocs/products.html
showing that the file about.html has been renamed to about2.html in the first area, so
about.html appears as deleted and about2.html appears as new in the first workarea. A
directory named support has been created in the first area and does not exist in the
second. The file main.html only exists in the first area specified and has never existed
in the second area, and the file products.html exists in both areas, but in the second
area it has been marked private and modified.
iwcp
Copies files from one location to another.
The iwcp CLT is different from iwupdate in that a file’s version history from the source
is not propagated to the destination. A new (modified) file is created regardless of the
source. Extended Attributes are preserved.
General Development.
Usage
iwcp [-h] [-v] [-r [-k]] [-s] src dst
The source and destination can use a relative path (such as file_name) or an absolute
vpath (such as /default/main/WORKAREA/wa/file_name). Both source and destination
must be on the same store.
Example
iwdecode
Decodes HTML-encoded %xx lines to ASCII lines. Receives HTML-encoded lines
through stdin.
General Development.
Usage
iwdecode [-h|-v]
Example
% iwdecode
Locked%20by%20launching%20edit
^D
Returns:
Locked by launching edit
iwdelcp
Allows users to automatically propagate differences between any two editions to
another file system location. This is a global operation that migrates all file changes and
can be used as a simple deployment mechanism when users do not require the flexibility
of TeamSite OpenDeploy.
iwdelcp copies changed files from a specified edition to a deployment directory (which
must be accessible via a file system). The resulting target directory will have the exact
same content as the deployed edition. iwdelcp only copies files that have changed since
the last time an edition was deployed to the same location. It keeps track of which
edition it deployed last by creating a file in the target directory called .IWDELCP.
NOTE
No concurrency control is enforced—if two copies of iwdelcp are run simultaneously
on the same target directory, the result could be incorrect.
Deployment.
Usage
iwdelcp [Flags] editionvpath srcdir targetdirpath
Flags
Example
% iwdelcp main/br1/EDITION/ed_05 /assets /usr/local/etc/httpd
/htdocs/assets
iwdeltaskfile
Deletes the file that is attached to a TeamSite task and updates the task by removing the
reference to that file. To remove only the file reference from the task (without deleting
the file), use the iwrmtaskfile CLT (page 191).
Workflow/Job.
Usage
iwdeltaskfile [-h] [-v] [-s servername] taskid path
Example
% iwdeltaskfile 1200 content/images/goingGoingGone.gif
iwdiffapply
Automatically synchronizes any two file system directories. iwdiffapply applies the
difference list generated by iwdiffdir to updatedir, referencing refdir.
Version Management.
Usage
iwdiffapply [-h|-v] [-f difflistfile] updatedir refdir
NOTE
After iwdiffapply has been run, updatedir is changed and refdir is unchanged.
If the difflistfile is not specified, it is assumed that the difference list is coming in
from stdin. The difference list is in the format:
m modified file
s new symbolic link
f new file
d new directory
x deleted file or directory
Example
% iwdiffapply -f difflist /iwmnt/default/main/WORKAREA/chris/htdocs
/iwmnt/default/main/WORKAREA/andre/htdocs
modifies the /htdocs directory in workarea chris to look like the /htdocs directory in
workarea andre.
iwdiffdir
Provides a list of all incremental file system changes needed to make a directory from a
workarea look like its counterpart directory in another workarea, edition, or staging
area. Creates a difference list which tells you how to modify updatedir to make it look
like refdir. This list can be used to modify the directory with iwdiffapply.
Version Management.
Usage
iwdiffdir [-h|-v] updatedir refdir
Each entry in the difference list is preceded by one of the following keys:
Example
% iwdiffdir /iwmnt/default/main/WORKAREA/andre/htdocs
/iwmnt/default/main/WORKAREA/chris/htdocs
Returns:
m about2.html
f banner.gif
d support
x logo.gif
meaning that in order for the /htdocs directory in workarea andre to look like the
/htdocs directory in workarea chris, about2.html must be modified, banner.gif must
be added, the support directory must be added, and logo.gif must be deleted.
iwencode
Encodes ASCII lines to HTML-encoded %xx lines. Takes input from stdin.
General Development.
Usage
iwencode [-h|-v]
Example
% iwencode
Locked by launching edit
^D
Returns:
Locked%20by%20launching%20edit
iwevents
Displays a history of submissions or updates of a workarea, staging area, or edition.
Workarea Operation.
Usage
iwevents [-h|-v] -s[ubmit]|-u[pdate] [-n[oheader]] [-i[ds]] [-a] vpath
latest|all
Examples
% iwevents -s main/WORKAREA/andre all
Returns a history of all the submissions from workarea “andre” and includes the headers
for each entry:
TIME UPDATE TYPE PATH USER COMMENT
APPROVE EVENTID FILEID
WORKAREAID REVISION
Returns only the files submitted in the most recent Submit operation and strips the
headers:
[Fri Apr 21 11:59:37 2004] ADD FILE /htdocs/CorpGuide2.pdf andre <none>
FALSE 0x00010258000000000000011f 0x0000007b000000e400000117
x00010100000000000000007b
displays a list of all files copied in to the workarea during all Get Latest operations and
includes the headers:
TIME UPDATE TYPE PATH USER
EVENTID FILEID
SOURCEAREAID
iwextattr
Enables you to set, delete, and look up extended attributes of a file or directory. The file
or directory is specified with a vpath, including the server name. Extended attributes can
use any naming scheme, but one common method is to name attributes by general class,
then by their specific description. For example:
description/language=English
description/keywords=marketing, software, enterprise
The attributes mentioned above both fall into the descriptive category, but one stores
language information and the other stores keywords. You might also have attributes that
describe the file’s relationships to other files, such as its document of origin or the files
it links to, for example:
/relationships/source
/relationships/links/outbound
/description/keywords
/description/language
General Development.
Usage
iwextattr [-h|-v] [-s attribute=value|-g attribute|-d attribute|-l]
[-f] [-u] [-c] [-e] [-r regex] [-x] vpath
When attribute values are printed, unprintable (non-ASCII) characters are outputted as *.
Examples
% iwextattr -s /description/language=English
//IWSERVER/default/main/dev/WORKAREA/andre/products/index.html
% iwextattr -l
//IWSERVER/default/main/dev/WORKAREA/andre/products/index.html
/description/keywords=marketing,software,enterprise
/description/description=Overview of our suite of examples
/description/launch_date=March 19th, 1999
/description/expire_date=May 21st, 1999
/description/language=English
/description/contributors=Bob, Jerry, Phil
/description/audience=Marketing
% iwextattr -g /description/language
//IWSERVER/default/main/dev/WORKAREA/andre/products/index.html
iwfilestate
Displays state information about a file in a TeamSite workarea (it also works for files in
an edition or staging).
NOTE
Unlike most CLTs, iwfilestate must be issued on the TeamSite server host.
General Development.
Usage
Example
% iwfilestate -f text /dev/main/dev/WORKAREA/bgunn/Makefile
Returns:
/dev/main/dev/WORKAREA/bgunn/Makefile
Conflict: No
Current: Yes
Modified: No
Editable: Yes
Not locked
Not assigned
If the script format is specified (instead of text), it would return the following:
conflict=no
current=yes
modified=no
editable=yes
locked=no
assigned=no
While the information returned for the text and script formats are the similar, the
script format is easier for CGIs and other programs to parse.
Notes
The conflict item states whether the file is in conflict with the staging area.
If vpath specifies a file in an edition or staging area, conflict is always no. It is
also no for workarea files that are not in conflict with the corresponding file in the
staging area. However, if a file has been modified in the workarea and a new version
was submitted to the staging area since the last Get Latest operation in the workarea,
then a conflict exists and the conflict item will be yes.
The current item states whether a file in a workarea is the same as the version in
the staging area.
If vpath specifies a file in a workarea and a more recent version of the file has been
submitted to the staging area since the last time a Get Latest operation was done in
the workarea, then current will be no. In all other cases, including files in an
edition or the staging area, current will be yes.
You can think of current as stating whether or not Get Latest will bring a more
recent version of the file into the workarea.
The modified item is yes for a file in a workarea that has been modified in some
way and is therefore eligible for Submit. It is no for files in a workarea that have not
been modified since the last Get Latest operation (and also for all files in editions or
staging areas).
The editable item states if the Edit functionality (buttons or menu items) for a file
is activated in the TeamSite GUI. It is yes if all of the following conditions have
been met:
The file is in a workarea
The user is allowed to modify the workarea
The user is allowed to write to the file
The file is not locked by another user or in a different workarea
Unless:
The Submit Locking model is in use for the branch, and:
The user’s role is not Author
The locked item states whether or not a file in a workarea has been locked in that
workarea’s branch. It is always no for files in editions or staging areas.
If the file is locked by the user invoking iwfilestate, the script format
returns:
locked=self
If the file is locked by a user other than the user invoking iwfilestate, the
script format returns:
locked=yes
owner=user_who_locked_the_file
workarea=name_of_workarea_that_holds_the_lock
and the text format returns:
Locked by user username in workarea workareaname
The assigned item is always no or Not Assigned (this item is not used currently
and will be removed in a future release).
iwgeteventcomments
Displays comments associated with a TeamSite workflow event. For information about
supported workflow events, see the TeamSite Administration Guide.
Workflow/Job.
Usage
iwgeteventcomments [-h|-v] [-s servername] jobID taskID time eventname
Example
% iwgeteventcomments 1000 15 1093048309 TaskAddFile
Displays all comments associated with the TaskAddFile event from task 15 in job 1000
and having a timestamp of 1093048309.
iwgeteventfiles
Displays a list of files associated with a TeamSite workflow event. For information
about supported workflow events, see the TeamSite Administration Guide.
Workflow/Job.
Usage
iwgeteventfiles [-h|-v] [-s servername] jobID taskID time eventname
Example
% iwgeteventfiles 1000 15 1093048309 TaskAddFile
Displays a list of files associated with the TaskAddFile event from task 15 in job 1000
and having a timestamp of 1093048309.
iwgettaskbyname
Writes the task ID to stdout for a task specified by name.A non-zero exit status
indicates a non-normal command execution, such as no task was found with the
specified name.
Workflow/Job.
Usage
iwgettaskbyname [-h] [-v] [-s servername] workflowID taskName
Example
% iwgettaskbyname 1000 My_Approval_Task
iwgetwfobj
Displays the state of any part of the server workflow subsystem in XML. It can be called
in the following ways:
By passing no arguments, in which case it displays the workflow registry.
By passing a single job ID for a job that is still running, in which case it displays the
state of that job.
By a task ID, in which case it displays the state of that particular task.
By setting the -c option, in which case it displays all completed jobs that are
archived for TeamSite Reporting purposes.
Workflow/Job.
Usage
iwgetwfobj [-h|-v] [-r] [-c] [-s servername] [jobID|taskID]
Example
% iwgetwfobj 7734
DTDs
Output from iwgetwfobj conforms to the DTDs described in the “Job Specification
Files” chapter of the Workflow Developer’s Guide.
iwinvokejob
Turns on or runs a job that has been instantiated in the server.
Workflow/Job.
Usage
iwinvokejob [-h|-v] [-s servername] jobID
Example
iwjobc
Instantiates a job into the server based on a specified job specification file and prints (in
decimal) the ID of the job.
Workflow/Job.
Usage
iwjobc [-h|-v] [-i] [-s servername] workflowfile
Example
iwjobvariable
Manipulates workflow variables.
Workflow/Job.
Usage
iwjobvariable [-h|-v] [-s servername]
[-g key|-c key value|-t key value|-d key] [-q] workflowid
-h Print help.
-v Print version.
-s servername Specifies the TeamSite server to which to connect. It can be
specified by name or IP address. The default value is the current
TeamSite server.
-g key Get value of workflow variable key. Prints value to standard
output.
-c key value Create variable key with value value. It is an error if key already
exists.
-t key value Set variable key to value value. If variable key does not exist,
create it.
-d key Delete variable key.
-q Suppress all error messages.
workflowid Specifies the identifier of the workflow.
Example
% iwjobvariable -g foo
iwlasted
Displays the name of the most recent edition on a branch.
Edition Operation.
Usage
iwlasted [-h|-v] [-k] branchvpath
Example
% iwlasted main
Returns:
ed_0001
iwldapmigrate
Creates a new version of tsusers.xml containing LDAP OS user information
previously stored in tsldapuserscache.xml (which is not supported starting with
TeamSite 6.7.1 SP1). Also reads LDAP configuration information from iw.cfg and
uses it to configure the LDAP server in user_databases.xml. Runs automatically when
TeamSite 6.7.1 SP1 or later is installed on a system already hosting TeamSite and
configured to use an LDAP server. Can also be run from the command line. The
database created in user_databases.xml is named LDAP_USER_DB by default.
General Development.
Usage
iwldapmigrate [-h|-v|-i ldap_db_id]
Notes
The TeamSite server (iwserver) must not be running when this CLT is executed.
The original tsusers.xml file, if present, is renamed
tsusers.xml.backup_ldapmigrate_1. If that file name already exists, the next
available whole number is used for the file name suffix (for example,
tsusers.xml.backup_ldapmigrate_2).
Example
% iwldapmigrate -i corp_ldap
iwldapsearch
A search program to query an LDAP user database. Works similarly to the ldapsearch
utilities supplied by various LDAP vendors, but understands how to read TeamSite
configuration information from iw.cfg and user_databases.xml. Accepts similar
arguments to most ldapsearch utilities, but will read TeamSite configuration
information when available. Unlike most LDAP search utilities, iwldapsearch can also
use SSL for its queries. See the TeamSite Administration Guide for details about iw.cfg
and user_databases.xml.
General Development.
Usage
iwldapsearch [options] filter [attributes]
Options:
Replacement Values
Example
</attr_display_name>
<attr_sync name="businessCategory" value="admin,master,author,editor,
tsusers,ccpro,ccstd,ccpro_only,ccstd_only">
</attr_sync>
</iwldap>
Both of these queries give the same result when searching this database. The following
query uses the -t option so the search uses parameters specified for
serverlab2w2k3-adam in the userdatabases.xml file:
C:\Interwoven\cc2.1.1\output\nti86.DEV\src\clt>iwldapsearch -t
serverlab2w2k3-adam (businessCategory=master)
This query specifies the search parameters explicitly from the command line:
C:\Interwoven\cc2.1.1\output\nti86.DEV\src\clt>iwldapsearch -h
serverlab2w2k3.tech.iwov -b "DC=interwoven,DC=com" -s sub -D "CN=Mary
Baker,OU=ADAM users,DC=interwoven,DC=com" -w mbakerr
(businessCategory=master)
objectClass = organizationalPerson
objectClass = user
cn = Bob Brinker
businessCategory = ccpro
businessCategory = master
distinguishedName = CN=Bob Brinker,OU=ADAM users,DC=interwoven,DC=com
instanceType = 4
whenCreated = 20070319220732.0Z
whenChanged = 20070319220732.0Z
uSNCreated = 73763
uSNChanged = 73763
name = Bob Brinker
badPwdCount = 0
badPasswordTime = 0
pwdLastSet = 128188156525309548
objectSid =
lockoutTime = 0
objectCategory =
CN=Person,CN=Schema,CN=Configuration,CN={FCBD6315-491A-44B1-AC99-7F6699A7
9F98}
uid = bbrinker
mail = bbrinker@interwoven.com
iwldapsync
Synchronizes information about TeamSite users from one or more LDAP servers.
Modifies entries in tsusers.xml based on configuration settings in
user_databases.xml and information obtained from LDAP servers. Invoked when
iwserver is first started and periodically afterwards as specified by ldap_thread_delay
in the [authentication] section of iw.cfg. Can also be run manually from the
command line. Output is written to iw-home/local/logs/iwldapsync.log unless the
-t option is specified. See the TeamSite Administration Guide for details about editing
iw.cfg and user_databases.xml to configure what action is taken when iwldapsync is
run.
General Development.
Usage
iwldapsync [-h|-v|-t]
iwlist
Displays list of all subcomponents in a container.
General Development.
Usage
iwlist [-h|-v] [-a|-l|-s] [-m [-u user]] [-i] [-k] vpath
Examples
% iwlist main
Returns:
branch1
branch2
Use the -a tag to include all editions and workareas on the branch.
% iwlist -a main
Returns:
wa1
wa2
INITIAL
ed_001
branch1
branch2
% iwlist -a -l main
Returns a full list of objids, comments, and base editions for all subbranches, workareas,
and editions on the branch:
wa1
andre’s workarea
2205
INITIAL
----------------------------------------------
wa2
chris’s workarea
2205
ed_0001
----------------------------------------------
----------------------------------------------
INITIAL
Initial empty edition
0
0
----------------------------------------------
ed_001
2205
INITIAL
1
----------------------------------------------
----------------------------------------------
branch1
test branch
2205
ed_002
----------------------------------------------
branch2
redesign branch
31001
INITIAL
----------------------------------------------
iwlistlocks
Lists the locks and assignments in a workarea or branch. Displays the following
information: lock date, file path, workarea, state, creator/assigner, owner/assignee,
comments. To see if a file is locked, see the istagged attribute of iwattrib (page 112).
Workarea Operation.
Usage
iwlistlocks [-h|-v] vpath
Example
% iwlistlocks main
Returns a list of all the locks (including assignments) in all workareas on the main
branch. The information is in columns—date, path to the file relative to the workarea,
workarea containing the lock, status, user who locked the file, owner of the lock,
comments—as follows:
[Tue Aug 22 10:31:32 2000] /htdocs/about2.html wa1 LOCKED andre andre
Locked%20by%20launching%20edit
[Tue Aug 22 10:34:15 2000] /htdocs/banner.gif wa1 ASSIGNED andre pat
add%20support%20section
[Tue Aug 22 10:34:40 2000] /htdocs/index.html wa1 DONE andre pat
added%20new%20links
[Tue Aug 22 10:36:29 2000] /htdocs/products.html wa2 LOCKED chris chris
<none>
iwlistmod
Displays a list of all modified files and directories in the specified workarea or workarea
directory.
Workarea Operation.
Usage
iwlistmod [-h|-v] vpath
Examples
% iwlistmod /default/main/WORKAREA/andre
Returns:
x+ assets/images/iwhead60.gif
x+ assets/images/iwlogo49.gif
f+ html/support/testing_form.html
f+ html/support/index.html
f+ html/support/instructions.html
d html/newdir/
f+ index.html
% iwlistmod /default/main/WORKAREA/andre/html/support
Returns:
f+ testing_form.html
f+ index.html
f+ instructions.html
iwlock
Locks any file in any TeamSite workarea. For a description of TeamSite locking, see the
ContentCenter online help.
Workarea Operation.
Usage
iwlock [-h|-v] [-f|-s] vpath comment [ownerid]
Example
% iwlock branch1/WORKAREA/wa1/test.html 'need to use this for a while'
Locks the file test.html in the workarea wa1 on the subbranch branch1. The comment
attached is “need to use this for a while”. Because no owner is specified, the lock owner
is the user who locked it.
Forcing an update will take the version in the staging area to edit, regardless of whether
it is the newer version. Suppressing an update will take the version in the workarea,
regardless of whether it is newer than the version in the staging area.
iwlockinfo
Provides detailed information on any lock held in TeamSite, such as who holds the lock
and in what workarea.
Workarea Operation.
Usage
iwlockinfo [-h|-v] vpath
Example
% iwlockinfo main/branch1/WORKAREA/wa1/test.html
Returns:
Name: test.html
Area: wa1
Time Stamp: [Wed Mar 02 15:52:44 2005]
Assignor: andre
Assignee: andre
State: Locked
Comments: fixing some links
NOTE
test.html is locked in workarea wa1 by Andre, with the comment “fixing some links”
attached.
% iwlockinfo main/branch1/WORKAREA/wa1/htdocs/index.html
Returns:
Name: index.html
Area: wa1
Time Stamp: [Wed Mar 02 15:52:44 2005]
Assignor: andre
Assignee: pat
State: Done
Comments: fix the marketing link.
fixed!
showing index.html in workarea wa1 has been assigned by Andre to Pat, and that Pat
has marked it Done. Comments attached to the file are “fix the marketing link. fixed!”
iwmerge
Merges files from one area into another.
General Development.
Usage
iwmerge [-h|-v] [-n] [-p] [-m|-c] [-a area] [files...]
iwmkbr
Creates a new TeamSite branch. For more information on creating TeamSite branches,
see the ContentCenter online help.
Branch Operation.
Usage
iwmkbr [flags] parent brname comment rooted [ownerid [groupid]]
parent Vpath of the parent branch of the new branch (see page 15).
brname Name of the new branch.
comment Description of the new branch.
rooted Name of edition in the parent branch to serve as a basis for the
new branch.
ownerid Username of the owner of the new branch.
groupid OS or TeamSite group name of the group of Administrators that
has Administrator-level access to the new branch.
Flags
Example
% iwmkbr //IWSERVER/default/main branch1 'test branch' INITIAL andre
creates a subbranch called branch1 off of the main branch. The comment attached to
this branch is “test branch”. It is based on the initial edition of the main branch, and it is
owned by user andre. There is no group of Administrators for this branch (only andre
has Administrator-level privileges for the branch), and the locking model used is the
default, submit locking.
iwmkwa
Creates a new TeamSite workarea on a branch. For more information on creating
TeamSite workareas, see the ContentCenter online help.
Workarea Operation.
Usage
iwmkwa [-h|-v] branchvpath waname comment base_ed [ownerid [groupid]]
Example
% iwmkwa main/branch1 wa1 '' INITIAL chrisc
This creates a workarea named wa1 on the subbranch branch1. No comment has been
attached to this workarea, and it is based on the initial edition of the branch and owned
by chrisc. This is a private workarea because no group has access to it.
iwmvtaskfile
Renames a file that is attached to a TeamSite task.
Workflow/Job.
Usage
iwmvtaskfile [-h] [-v] [-s servername] taskid src dest
Example
% iwmvtaskfile 1200 content/images/tobemoved.gif images/tobemoved.gif
iwndxaddbr
Adds a branch to the index manager to be indexed. The branch might not be indexed
immediately by the index manager, depending on the current server load and the size of
the branch. Use iwndxstatus to verify whether the branch was indexed.
Usage
iwndxaddbr [-h|-v]
iwndxaddbr branchpath
Example
% iwndxaddbr /default/main
Returns:
Success.
iwndxfreezebr
Freezes or unfreezes a branch to be indexed by the index manager. Freezing suspends all
indexing activity on that branch. Unfreeze resumes the indexing of the branch. Any
existing indexes for the branch are still available for query operations even if the branch
is frozen.
Usage
iwndxfreezebr [-h|-v|-u branchpath]
iwndxfreezebr branchpath
Example
% iwndxfreezebr /default/main
% iwndxfreezebr -u /default/main
iwndxlistbr
Displays a list of the paths of all fully and partially indexed branches.
Usage
iwndxlistbr [-h|-v]
Example
% iwndxlistbr
iwndxmgrfreeze
Freezes and unfreezes the index manager. Freezing suspends all indexing activities.
Unfreezing resumes all indexing activities.
Usage
iwndxmgrfreeze [-h|-v|-u]
Example
% iwndxmgrfreeze
Notes
Once frozen, the index manager remains so until an unfreeze command is issued.
Use iwndxmgrstatus prior to iwndxmgrfreeze to determine whether the index
manager is already frozen.
You can perform search queries even if the index manager is frozen.
iwndxmgrstatus
Displays whether the index manager is frozen.
Usage
iwndxmgrstatus [-h|-v]
Example
% iwndxmgrstatus
iwndxmgrstop
Sends a shutdown command to the index manager.
Usage
iwndxmgrstop [-h|-v]
Example
% iwndxmgrstop
stops the index manager. This command does not display a return message.
NOTE
This command does not verify that the index manager shut down successfully. Check
the index log file or list of processes to verify index manager status.
iwndxpurgebr
Deletes the index collections and all other indexing information associated with a
branch from the index manager’s memory and from the system’s disk.
Usage
iwndxpurgebr [-h|-v]
iwndxpurgebr branchpath
Example
% iwndxpurgebr /default/main
Returns:
Success.
NOTE
Use caution when executing iwndxpurgebr. Unlike iwndxrmbr, iwndxpurgebr also
deletes the indexing information from the system’s disk. If, after issuing iwndxpurgebr,
you need to reindex this branch using iwndxaddbr, the entire indexing information will
need to be recreated.
iwndxrefreshbr
Indexes a branch by putting it in the bulk or incremental queue. In general, use the bulk
queue to index a branch for the first time, and use the incremental queue to index
additional or modified files on a branch that is already indexed. Using the bulk queue
typically takes longer than using the incremental queue. However, if the index has not
been updated for a long time, using the incremental queue can be time consuming. In
these cases, it may be preferable to use the bulk queue so that the incremental queue
remains available for other updates.
Usage
iwndxrefreshbr [-h|-v]
iwndxrefreshbr [-b|-i] branchpath
Examples
% iwndxrefreshbr -b /default/main
% iwndxrefreshbr -i /default/main
iwndxrmbr
Deletes the index collections and all other indexing information associated with a
branch from the index manager’s memory, but retains the information on the system’s
disk.
Usage
iwndxrmbr [-h|-v]
iwndxrmbr branchpath
Example
% iwndxrmbr /default/main
Returns:
Success.
NOTE
Because this command removes indexing information just from memory (and not from
disk), reindexing a branch after using iwndxrmbr is much faster compared to using
iwndxpurgebr because the index manager can retrieve and use the relevant original
information rather than completely rebuild the index.
iwndxstatus
Displays the current index status from the index manager for all indexed branches or a
list of specified branches. Output is in XML format.
Usage
iwndxstatus [-h|-v] -a [-f]
iwndxstatus [-f] branchpath1 branchpath2 ...
Example s
% iwndxstatus /default/main
Returns the index status of the /default/main branch on the index manager (similar to
the following):
<branch_index_status_list>
<branch_index_status>
<branch>
<serverid>010000000000000051000000</serverid>
<archiveid>640000000000000020200000</archiveid>
<branchid>0C0100000000000050220000</branchid>
</branch>
<vpath>/default/main</vpath>
<status>11</status>
<last_indexed_edition>testEdition1</last_indexed_edition>
<last_indexed_edition_creation_time>1089325560000</
last_indexed_edition_creation_time>
<freeze_status>UNFROZEN</freeze_status>
<workarea_index_status>TRUE</workarea_index_status>
<collection_list>
<collection>0100000000000000510000006400000000000000202000000C01000000000
00050220000_1</collection>
</collection_list>
</branch_index_status>
</branch_index_status_list>
% iwndxstatus -a
Returns the index status of all indexed branches on the index manager.
Notes
If the value inside the <last_index_edition> element starts with # (for example,
#4), the edition is most likely anonymous.
iwndxwamodificationsbr
Enables or disables the indexing of workareas of the specified branch (which is being
indexed by the index server).
Usage
iwndxwamodifcationsbr [-h|-v] branchpath
iwndxwamodifcationsbr [-h|-v] -u branchpath
Examples
% iwndxwamodificationsbr /default/main
Enables the indexing of the workareas on this branch, causing all modified files in these
workareas to be indexed and available for later searches.
% iwndxwamodificationsbr -u /default/main
Disables the indexing of the workareas on this branch, causing all modified files in these
workareas to not be available for later searches.
iwnexted
Displays the name that would be automatically generated by the iwpublish -a
command for the next edition on a branch.
Edition Operation.
Usage
iwnexted [-h|-v] branchvpath
Example
% iwnexted main
Returns:
ed_0002
If the name of the last edition ends with a number, iwnexted will increment it. If it does
not, iwnexted will append a number to the name.
iwprop
Manipulates TeamSite user properties.
General Development.
Usage
iwprop identity action options property ...
identity
action
options
property
For the -get and -delete action, one or more instances of the form:
[mode] [-key] K
where K specifies the property’s key. The -key is only required if K could be confused
with another command line option or contains an equal sign (=).
For the -set action, prop can have either of two forms:
[mode] K=V
[mode] [-key] K [-value V]
Where K is the property’s key and V is the new value. In the first form, V is assumed to
start immediately after the first equal sign (=). The second form can be used if K
contains an embedded equal sign (=); however, the -value argument must immediately
follow K or the property is assigned an empty value. Note that shell escape characters
may be required if K or V contains special characters such as a blank space or double
quotes (“...”).
If no property is specified, -get displays all properties. At least one property must be
specified for -set and -delete.
mode modifies the way key K of a property is matched and may cause a single property
to apply to more than one property. Valid modes are:
iwprv
Allows users to identify whether any file or directory in any workarea is marked private
and automatically mark any file as either private or public. For a full description of
private and public files and directories, see the ContentCenter online help.
Workarea Operation.
Usage
iwprv [-h|-v] [-c|-g|-s] list-of-vpath
Examples
% iwprv -s main/br1/WORKAREA/wa1/gifs main/br1/WORKAREA/wa1/mktg
main/br1/WORKAREA/wa1/index.html main/br1/WORKAREA/wa1/main.html
makes the directories gifs and mktg and the files index.html and main.html private.
% iwprv -g main/br1/WORKAREA/wa1/gifs
% iwprv -g main/branch1/WORKAREA/wa1/test.html
iwpublish
Publishes the staging area on a branch. For more information on publishing editions, see
the ContentCenter online help.
Edition Operation.
Usage
iwpublish -g [-w|-s] [-f] vpath area comment [ownerid]
Example
% iwpublish main/branch1 STAGING ed_002 'checkpoint'
publishes the staging area on the subbranch branch1 as edition ed_002 with the
comment “checkpoint” attached.
iwqueryjobs
Reads a query from stdin and prints to stdout a list of job IDs that match the query
criteria. Query syntax is described in the DTD section.
Workflow/Job.
Usage
iwqueryjobs[-h|-v][-x][-o offset][-m max][-l locale][-s servername]
<query
Example
The following command searches for matching job IDs on the server
production.example.com:
% iwqueryjobs -s production.example.com
DTD
All queries must be in XML format that matches the following DTD:
The ownedby element returns the job owned by the specified user. The active element
returns active jobs.
iwquerytasks
Reads a query from stdin and prints to stdout a list of task IDs that match the query
criteria. Query syntax is described below in the DTD section.
Workflow/Job.
Usage
iwquerytasks[-h|-v][-x][-o offset][-m max][-l locale][-s servername]
<query
Example
The following command searches for matching task IDs on the server
production.example.com:
% iwquerytasks -s production.example.com
DTD
All queries must be in XML format that matches the following DTD:
iwrcsdiff
Shows the differences between rev1 and rev2 of file. Provides functionality similar to
RCS's rcsdiff for TeamSite files.
Version Management.
Usage
iwrcsdiff [flags] [-r rev1 [-r rev2]] [diff-options] filepath
rev1 and rev2 are revision numbers as displayed by iwrlog, or version strings (revision
IDs) as displayed by the History command from the GUI or by iwrlog.
Flags
Examples
% iwrcsdiff -r 0x00000116000000e300000102 -r 0x000024de0000069d00000148
/iwmnt/default/main/WORKAREA/andre/htdocs/about2.html
Returns nothing because the contents of those files are the same.
If only one revision number is specified, iwrcsdiff will compare the specified version
with the version in the current area. From workarea andre:
% iwrcsdiff -r 0x00000116000000e300000102 htdocs/about2.html
Returns:
6a7
> foo bar
showing that the second version (the version in workarea andre) contains two words on
the sixth line that the first one does not.
If no revision number is specified, iwrcsdiff will compare the version in the current
workarea with the version in the staging area:
% iwrcsdiff htdocs/about2.html
Returns:
1c1
< foo<HTML>
---
> <HTML>
6a7
> foo bar
showing that the first version of about2.html has the word “foo” on the first line and
the second version does not, whereas the second version has the words “foo bar” on the
sixth line and the first version does not.
iwrename
Renames any file, directory, workarea, edition, or branch (except main) in TeamSite.
General Development.
Usage
iwrename [-h|-v] old_vpath new_vpath
iwrename [-h|-v] old_areavpath new_areaname
Examples
% iwrename main/branch1 test
% cd main/test/WORKAREA
% iwrename wa2 andre
changes the name of workarea wa2 to andre on subbranch test. The results are identical
to the preceding example; in this case no vpath was specified in the iwrename command
because wa2 is located in the working directory.
iwretryjobop
Called when conflicts preventing successful completion of submit or update tasks have
been resolved.
Workflow/Job
Usage
iwretryjobop [-h|-v|-o] [-s servername] taskID [comment]
Example
iwrevert
Gives command-line users the same revert functionality that is available from the
history screen in the TeamSite GUI. That is, a user can now revert to any version of a
file via the command line.
Version Management.
Usage
iwrevert [-h|-v] vpath rev
iwrlog
Shows a revision log for the specified TeamSite file. Provides functionality similar to
RCS’s rlog for TeamSite files.
Version Management.
Usage
iwrlog [-h|-v][-c][-m] vpath
Example
% iwrlog -c /default/main/branch1/WORKAREA/andre/htdocs/index.html
Returns the revision number, date, user, and area containing that version for each
version of the file:
file /default/main/branch1/WORKAREA/andre/htdocs/index.html (locked)
working revision /main/branch1/6+
----------------------------
name /htdocs/index.html
revision /main/branch1/6+
last modified Wed Jul 26 11:26:13 2000 by andre in area andre
size 16911
objid 0x0000478f0000479200004816
submit event objid N/A
----------------------------
name /htdocs/index.html
revision /main/branch1/6
last modified Wed Jul 26 11:29:19 2000 by andre in area ed_0002
size 16919
objid 0x000048180000479d0000480f
submit event objid 0x00002258000000000000480e
----------------------------
name /htdocs/index.html
revision /main/branch1/5
last modified Wed Jul 26 11:26:13 2000 by andre in area ed_0001
size 16911
objid 0x000048060000479d00004805
submit event objid 0x000022580000000000004802
----------------------------
name index.html
revision /main/branch1/4
last modified Wed Jul 26 11:24:35 2000 by andre
size 16904
objid 0x0000480600004804000047fa
submit event objid 0x0000225800000000000047f7
----------------------------
name index.html
revision /main/branch1/3
last modified Tue Jul 25 18:59:51 2000 by andre
size 1206
objid 0x00004806000047f9000047b7
submit event objid 0x0000225800000000000047b4
----------------------------
name index.html
revision /main/branch1/2
last modified Tue Jul 25 18:58:46 2000 by andre
size 4
objid 0x00004806000047b6000047ac
submit event objid 0x0000225800000000000047a9
----------------------------
name index.html
revision /main/branch1/1
last modified Tue Jul 25 18:39:17 2000 by andre
size 0
objid 0x00004806000047ab000047a1
submit event objid 0x00002258000000000000479b
==================================================================
total revisions: 7
==================================================================
iwrmbr
Removes the specified branch and all of its contents from TeamSite. For more
information on deleting TeamSite branches, see the ContentCenter online help.
Branch Operation.
Usage
iwrmbr [-h|-v] branchvpath
iwrmbr [-h|-v] parentvpath brname
Example
% iwrmbr main branch1
iwrmed
Deletes any edition on a branch. For more information on deleting TeamSite editions,
see the ContentCenter online help.
Edition Operation.
Usage
iwrmed [-h|-v] branchvpath edition
Example
% iwrmed main/branch1 ed_001
iwrmjob
Unconditionally removes a job instance from the server. Only use as a last resort.
Workflow/Job.
Usage
iwrmjob [-h|-v] [-s servername] jobID
Example
The following command removes job 7734 from the server production.example.com:
% iwrmjob -s production.example.com 7734
iwrmtaskfile
Removes a file from a specific task in an instantiated job.
Workflow/Job.
Usage
iwrmtaskfile [-h|-v] [-s servername] taskID file
Example
iwrmtaskgroup
Removes groups from group tasks.
Workflow/Job.
Usage
iwrmtaskgroup [-h] [-v] [-s servername] taskID group
Example
% iwrmtaskgroup -s darkstar 1973 approvers
iwrmtaskuser
Removes users from group tasks.
Workflow/Job.
Usage
iwrmtaskuser [-h|-v] [-s servername] taskID user
Example
% iwrmtaskuser -s factotum 420 bukowski
iwrmwa
Removes the specified workarea. For more information on deleting workareas, see the
ContentCenter online help.
Workarea Operation.
Usage
iwrmwa [-h|-v] branchvpath workarea
Example
% iwrmwa main/branch1 wa1
iwsetjobdescription
Changes the description of a job.
Workflow/Job.
Usage
iwsetjobdescription [-h|-v] [-s servername] workflowID description
Example
% iwsetjobdescription 344 2002_press_releases
iwsetjobowner
Changes the owner of a job.
Workflow/Job.
Usage
iwsetjobowner [-h|-v] [-s servername] workflowID owner
Example
% iwsetjobowner -s beavis 112 nickSaloman
iwsettaskattrib
Sets a new true or false value for a task attribute (for example, read-only or lock).
Workflow/Job.
Usage
iwsettaskattrib [-h|-v] [-s servername] taskid name value
Example
% iwsettaskattrib -s maynard 462 readonly f
iwsettaskcomment
Assigns a comment to a TeamSite task.
Workflow/Job.
Usage
iwsettaskcomment [-h|-v] [-s servername] taskID comment
Example
% iwsettaskcomment 420 "All content looks valuable here. Tech Pubs is
doing a great job!"
iwsettaskdescription
Modifies an existing TeamSite task description.
Workflow/Job.
Usage
iwsettaskdescription [-h|-v] [-s servername] taskID description
Example
% iwsettaskdescription 1200 "Add images to content"
iwsettaskfilecomment
Assigns a comment to a file associated with a TeamSite task.
Workflow/Job.
Usage
iwsettaskfilecomment [-h|-v] [-s servername] taskID path comment
Example
% iwsettaskfilecomment 1200 images/homebase.gif "Great image of home
base."
iwsettaskownerandarea
Assigns an owner and workarea to a TeamSite task.
Workflow/Job.
Usage
iwsettaskownerandarea [-h] [-v] [-s servername] taskid owner areavpath
Example
% iwsettaskownerandarea 1200 root /default/main/web/WORKAREA/users
iwsettasktimeout
Changes the timeout value on an inactive task that already has a timeout successor
specified in the original job specification.
Workflow/Job.
Usage
iwsettasktimeout [-h|-v] [-s servername] taskid timeout
Examples
% iwsettasktimeout 1200 +002400
% iwsettasktimeout 1200 122520020600
iwsrchattrib
Displays an XML formatted list of indexed extended attributes or FormsPublisher
templating attributes.
Usage
iwsrchattrib [-h|-v|-e|-t template_data_type]
Examples
% iwsrchattrib -t iw-home/examples/Templating/templatedata/internet/pr
Returns a list of indexed attributes for the FormsPublisher pr data type (residing in the
internet data category).
% iwsrchattrib -e
Returns a list of all extended attributes registered with the index manager, such as:
<attr>
<name>Indexed</name>
<type>int</type>
</attr>
<attr>
<name>TeamSite/Templating/PrimaryDocumentType</name>
<type>string</type>
</attr>
<attr>
<name>TeamSite/Templating/PrimaryDCR</name>
<type>string</type>
</attr>
<attr>
<name>OwningAreaId</name>
<type>long</type>
</attr>
<attr>
<name>AreaRelativePath</name>
<type>string</type>
</attr>
<attr>
<name>TeamSite/Templating/DCR/Type</name>
<type>string</type>
</attr>
<attr>
<name>BranchId</name>
<type>long</type>
</attr>
<attr>
<name>CreateDate</name>
<type>date</type>
</attr>
<attr>
<name>IndexedDate</name>
<type>date</type>
</attr>
<attr>
<name>Creator</name>
<type>string</type>
</attr>
<attr>
<name>LastModifier</name>
<type>string</type>
</attr>
<attr>
<name>Version</name>
<type>int</type>
</attr>
<attr>
<name>Size</name>
<type>int</type>
</attr>
<attr>
<name>LastModifiedDate</name>
<type>date</type>
</attr>
<attr>
<name>Title</name>
<type>string</type>
</attr>
iwsrchgethome
Displays the location of the search home directory.
Usage
iwsrchgethome [-h|-v]
Example
% iwsrchgethome
Returns:
>$G:\Interwoven\search\output\nti86.DEV\src\tests\java\dummy.
iwsrchgetpage
Displays a page of results from a query previously performed by iwsrchquery.
Usage
iwsrchgetpage [-h|-v]
iwsrchgetpage userID queryID start page_size
Example
% iwsrchgetpage AJUBA\user1 CMQB9ZZ4 5 5
Returns a results page from query ID CMQB9ZZ4 starting at result index 5 and containing
up to 5 query results (although in this case there were only 2 matching results, so only 2
are displayed). The user has the valid TeamSite ID user1 on the AJUBA domain. Results
could appear as follows:
<data>
<query_id>CMQB9ZZ4</query_id>
<result>
<vpath>//jzhuangd2ks/default/main/STAGING/Copy (3) of
test1.txt</vpath>
<rank>5000.0</rank>
</result>
<result>
<vpath>//jzhuangd2ks/default/main/STAGING/Copy (2) of
test1.txt</vpath>
<rank>5000.0</rank>
</result>
<return_code>0</return_code>
</data>
Notes
To display, for example, 500 results in 50-result blocks, enter values as follows for
start and page_size in consecutive iwsrchgetpage commands:
0 50
50 50
100 50
150 50
and so on.
The value shown in <rank> is the document hit score. It can range from 0 to 10000,
with higher values representing more hits.
iwsrchmgrping
Pings the search manager and displays response time.
Usage
iwsrchmgrping [-h|-v]
Example
% iwsrchmgrping
Returns:
The response time for search manager is: 15 ms
iwsrchmgrstop
Sends a shutdown command to the search manager.
Usage
iwsrchmgrstop [-h|-v]
Example
% iwsrchmgrstop
stops the search manager. This command does not display a return message.
NOTE
This command does not verify that the search manager shut down successfully. Check
the list of processes to verify search manager status.
iwsrchndxstatus
Displays the current index status from the search manager for all indexed branches or a
list of specified branches. Output is in XML format.
Usage
iwsrchndxstatus [-h|-v] -a [-f]
iwsrchndxstatus [-f] branchpath1 branchpath2 ...
Examples
% iwsrchndxstatus /default/main
Returns the index status of the /default/main branch on the search manager (similar to
the following):
<branch_index_status_list>
<branch_index_status>
<branch>
<serverid>010000000000000051000000</serverid>
<archiveid>640000000000000020200000</archiveid>
<branchid>0C0100000000000050220000</branchid>
</branch>
<vpath>/default/main</vpath>
<status>11</status>
<last_indexed_edition>testEdition1</last_indexed_edition>
<last_indexed_edition_creation_time>1089325560000</
last_indexed_edition_creation_time>
<workarea_index_status>TRUE</workarea_index_status>
<collection_list>
<collection>0100000000000000510000006400000000000000202000000C010000000
0000050220000_1</collection>
</collection_list>
</branch_index_status>
</branch_index_status_list>
% iwsrchndxstatus -a
Returns the index status of all indexed branches as known to the search manager.
Notes
If the value inside the <last_index_edition> element starts with # (for example,
#4), the edition is most likely anonymous.
iwsrchndxstatuschg
Instructs the search manager to get the latest status of all the indexed branches from the
search manager.
Usage
iwsrchndxstatus [-h|-v]
Examples
% iwsrchndxstatuschg
Returns:
Success.
NOTE
Under normal circumstances, the index manager automatically notifies the search
manager of any index changes. This CLT is provided as a manual way of performing
that task in case the index manager is brought down or fails after it has indexed a branch
but before it can notify the search manager of the changes.
iwsrchquery
Executes a query on the search manager and returns the first page of the query in XML
format. Use iwsrchgetpage to display additional pages.
Usage
iwsrchquery [-h|-v]
iwsrchquery [-s] [-f queryStrFile] userID pageSize branchpath areapath
Examples
% iwsrchquery -f C:\queries\query1.txt AJUBA\user1 5
\\server1\default\main \\server1\default\main\STAGING
Returns the first page (containing up to 5 query results) resulting from the query defined
in the file C:\queries\query1.txt. The user has the valid TeamSite ID user1 on the
AJUBA domain. The query is applied to the staging area on the default\main branch of
the system server1. The query defined in query1.txt could appear as follows:
<predicate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="TeamSiteSearch.xsd">
<accrue>
<fulltext-any>
<term>vdk</term>
</fulltext-any>
<fulltext-any>
<term>modified</term>
</fulltext-any>
</accrue>
</predicate>
Depending on the contents of the staging area, output similar to the following is
displayed:
<data>
<query_id>CMQB9ZZ4</query_id>
<result>
<vpath>//jzhuangd2ks/default/main/STAGING/test1.txt</vpath>
<rank>5000.0</rank>
</result>
<result>
<vpath>//jzhuangd2ks/default/main/STAGING/Copy of test1.txt</vpath>
<rank>5000.0</rank>
</result>
<result>
<vpath>//jzhuangd2ks/default/main/STAGING/Copy (6) of
test1.txt</vpath>
<rank>5000.0</rank>
</result>
<result>
<vpath>//jzhuangd2ks/default/main/STAGING/Copy (5) of
test1.txt</vpath>
<rank>5000.0</rank>
</result>
<result>
<vpath>//jzhuangd2ks/default/main/STAGING/Copy (4) of
test1.txt</vpath>
<rank>5000.0</rank>
</result>
<return_code>0</return_code>
</data>
In this example no query file is specified, so you are prompted to enter a query:
Please enter the query below. Press Ctrl+C to quit.
Enter the query on the command line. If you enter it as shown in the preceding example
(the contents of query1.txt), the output displayed is identical to the output shown in
preceding example. To run a query that you enter on the command line, press return
after entering </predicate>. The command recognizes that that is the end of the query
and executes the query immediately.
Notes
The schemas are described in this manual in Appendix D, “Search Query Schemas.”
Performing schema validation with the -s option increases search response time.
Use iwsrchgetpage to view additional query result pages. Use the ID specified by
<query_id> in the first page’s output to specify the query in iwsrchgetpage.
The value shown in <rank> is the document hit score. It can range from 0 to 10000,
with higher values representing more hits.
If queryStrFile contains multi-byte characters, it needs to be saved in UTF-8
encoding for the CLT to run properly.
iwsubmit
Submits any TeamSite workarea, file, or directory to the staging area. For a full
description of submitting files to the staging area, see the ContentCenter online help.
Workarea Operation.
Usage
iwsubmit [-h|-v] [-s] [-w|-x] [-u] [-r] [-c global_comment]
[-i info_comment] {vpath file_comment}+
Flags
Example
% iwsubmit -w -u -c 'updated support info' -i 'keyword'
main/WORKAREA/andre/htdocs/index.html 'added imagemap'
Submits the file index.html to the staging area, with the comment “added imagemap”
attached to the file. The comments for the submit operation are “updated support info”
and “keyword”. If index.html is locked, this operation will unlock it. If the version in
the staging area is newer, this operation will overwrite it.
iwtaketask
Assigns a shared task to a specified user.
Workflow/Job.
Usage
iwtaketask [-h|-v] [-s servername] taskID username
Example
iwtaskselect
Marks a usertask finished and chooses which <successorset/> element to signal.
Workflow/Job.
Usage
iwtaskselect [-h|-v] [-s servername] taskID choice [comment]
Example
The following command marks task 7734 done on the server production.example.com
and signals the third <successorset/> element in that task’s <successors/> section:
% iwtaskselect -s production.example.com 7734 2
iwtaskvariable
Creates, deletes, sets, and retrieves values of variables on a TeamSite task.
Workflow/Job.
Usage
iwtaskvariable [-h|-v] [-q] [-s servername] (-g name|-c key value|-t key
value|-d key value) taskid
Example
% iwtaskvariable -c superhero Spider-Man 111
Creates a task variable with the key “superhero” and the value “Spider-Man” in task
111.
iwundochoice
When a user chooses a transition from a usertask or grouptask, that choice can be taken
back. iwundochoice reverses one such task. The iwundochoice CLT cannot reverse a
transition for a task with multiple successors.
Workflow/Job.
Usage
iwundochoice [-h|-v] [-s servername] taskID
Example
The following command reverses the transition from task 7734 on the server
production.example.com:
% iwundochoice -s production.example.com 7734
iwunlock
Unlocks any file or directory in any TeamSite workarea. See the ContentCenter online
help for a full description of unlocking files.
Workarea Operation.
Usage
iwunlock [-h|-v] vpath
Example
% iwunlock main/branch1/WORKAREA/wa1/index.html
Unlocks the file index.html in the workarea wa1 on the subbranch branch1. Only one
file may be unlocked at a time with this command.
iwuntaketask
Removes the ownership of an active group task.
Workflow/Job.
Usage
iwuntaketask [-h|-v] [-s servername] taskID
Example
% iwuntaketask 1250
where 1250 is a grouptask of which someone has already taken ownership (by either
using the GUI, or the iwtaketask CLT).
iwupdate
Updates any TeamSite file, directory, or workarea with the latest version of any file
system element. This command acts like the Copy To or (if vpath_from specifies the
staging area on that branch) the Get Latest command. See the ContentCenter online
help for more information about these commands.
Workarea Operation.
Usage
iwupdate [-h|-v] [-w|-x|-s] [-o] [-r] {src_vpath}+ dst_vpath
Where src_vpath specifies a path to a file, directory, or area and dst_vpath specifies a
path to a workarea (dst_vpath may specify a path to a file or directory in a workarea if
the area-relative portions of dst_vpath and src_vpath are the same).
Example
% iwupdate -x main/branch1/WORKAREA/wa1 main/branch1/WORKAREA/wa2
copies all the files that are different in workarea wa1 to workarea wa2, overriding any
conflicts.
iwvpath
Prints all or parts of the version path of the specified object.
General Development.
Usage
iwvpath [-h|-v] [-p|-b|-d|[-s][-a]] objectvpath
iwvpath [-h|-v] [-p|-b|-d|[-s][-a]] -o objid
Examples
% iwvpath -d main/WORKAREA/andre/htdocs/index.html
Returns:
/htdocs/index.html
Returns:
chocolate
default
/main
WORKAREA
andre
/htdocs/index.html
Returns:
/main
Returns:
/htdocs/index.html
Command Triggers
This chapter also contains man pages for all supported command triggers. All man
pages in this chapter are presented as one group, arranged alphabetically:
NOTE
Not all events are logged by default in the event log. If an iwat command relies on an
event being logged, and if TeamSite is not configured to log that event, the iwat
command will fail or not run properly. For example, the iwatcreate command looks for
CreateFSE events in the event log. However, CreateFSE events are logged only if you
set log_modifyfse=yes in the iwserver section of the iw.cfg file.
Because they are non-terminating, command triggers are usually included in a script that
starts and stops the process and its tail.
By default, the iwat command triggers invoke user scripts synchronously. That is, they
wait for the scripts to return before handling the next event. You can use the syntax
shown in the following example to configure an iwat trigger to run a script
asynchronously:
iwatserver.ipl "progname progargs ... &"
NOTE
The ampersand is inside the quotation marks that encase the command. This prevents
the shell from running iwatserver itself in the background. As coded above, progname
runs in the background when executed. The iwatserver command trigger is just used as
an example here. You can use this syntax with any iwat command trigger.
You now need to log in as root, and stop and start /etc/init.d/iw.local:
% cd /etc/init.d
% ./iw.local stop
% ./iw.local start
iw.local will reread the configuration file and start the command triggers as specified.
Environment Variables
When using command triggers, environment variables are set before the program
progname is run. The events and their values are described under the appropriate
command trigger in the following table. Note that some of the events listed in the Event
column do not result in IW_EVENT being set. Because those events also do not have a
command trigger to control the setting of any environment variables, no value is shown
for them in the Command Trigger column. For example, the DeleteEA event does not
set the IW_EVENT variable, and there is no corresponding command trigger to perform
that setting. To make DeleteEA set IW_EVENT, you would have to write a custom script
and then register the event and script through the iwat command.
Values shown in the Event column are the strings used both internally and on the
command line for the corresponding event. If the event has a value in the Command
Trigger column, the string in the Event column is also the value to which the command
trigger sets IW_EVENT. All events, including those without an entry in the Command
Trigger column, can be monitored using iwat.
iwat
This program is used to register an event handler for events that do not have a specific
command trigger program.
Usage
iwat [-h|-v] [-s servername] eventpattern program
Example
% iwat CreateWorkarea /usr/ucb/echo
iwat-env
This program is used for testing the command triggers. It returns a list of environment
variables for the command trigger, and their current states.
Usage:
iwat-env [-h|-v] progargs...
Examples:
% iwat-env
will return (as soon as a file is assigned) output that looks like this:
iwat-env: ==========================================================
iwat-env: IW_EVENT = AssignFile
iwat-env: IW_SUBMITID =
iwat-env: IW_AREA = /default/main/WORKAREA/andre
iwat-env: IW_ASSIGNEE = pat
iwat-env: IW_BRANCH =
iwat-env: IW_COMMENTS = Locked by launching edit
iwat-env: IW_EDITION =
iwatcreate
iwatcreate is a non-terminating script that executes the custom script progname once
each time a file or a directory has been created.
Usage
iwatcreate [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “CreateFSE”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_FILE vpath of file (rooted at the archive).
iwatlock
iwatlock is a non-terminating script that executes the custom script progname once each
time a file or a directory is locked.
Usage
iwatlock [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “Lock”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_FILE vpath of file (rooted at the archive).
IW_EDITOR Workarea owner.
iwatmkbr
iwatmkbr is a non-terminating script that executes the custom script progname once each
time a new branch is created.
Usage
iwatmkbr [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “CreateBranch”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_BRANCH vpath of branch (rooted at the archive).
iwatmkwa
iwatmkwa is a non-terminating script that executes the custom script progname once each
time a new workarea is created.
Usage
iwatmkwa [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “CreateWorkarea”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_WORKAREA vpath of workarea (rooted at the archive).
iwatpub
iwatpub is a non-terminating script that executes the custom script progname once each
time a new edition is published.
Usage
iwatpub [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “PublishStagingArea”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_EDITION vpath of edition (rooted at the archive).
IW_STAGINGAREA Version path of the staging area published.
IW_WORKAREA Version path of the workarea published.
iwatrmbr
iwatrmbr is a non-terminating script that executes the custom script progname once each
time a branch is deleted.
Usage
iwatrmbr [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “DestroyBranch”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_BRANCH vpath of branch (rooted at the archive).
iwatrmed
iwatrmed is a non-terminating script that executes the custom script progname once each
time an edition is deleted.
Usage
iwatrmed [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “DestroyEdition”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_EDITION vpath of edition (rooted at the archive).
iwatrmwa
iwatrmwa is a non-terminating script that executes the custom script progname once each
time a workarea is deleted.
Usage
iwatrmwa [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “DestroyWorkarea”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_WORKAREA vpath of workarea (rooted at the archive).
iwatserver
The iwatserver CLT is a non-terminating script that executes progname once each time
after one of the following events has occurred: StartUp, ShutDown, Freeze, Thaw,
DiskLow, DiskFail, ActivateStore, DeactivateStore, OutOfMemory.
Usage
iwatserver [-h|-p|-v] progname progargs
The following environment variables are set (to the described values) before progname
is run:
iwatsub
iwatsub is a non-terminating script that executes the custom script progname once each
time a file or a directory is submitted.
Triggers an event (custom script) upon submission of any file system element.
Usage
iwatsub [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “Submit”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTLINE Copy of the line from the event log that originally triggered the
event.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_WORKAREA vpath of workarea (rooted at the archive) (same as IW_AREA and
IW_VPATH).
IW_SUBMITID objid associated with the submit event.
IW_EDITOR Workarea owner.
iwatunlock
iwatunlock is a non-terminating script that executes the custom script progname once
each time a file or a directory is unlocked.
Usage
iwatunlock [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “Unlock”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_FILE vpath of file (rooted at the archive).
IW_EDITOR Workarea owner.
iwatupdate
iwatupdate is a non-terminating script which executes the custom script progname once
each time a Copy To or Get Latest update event occurs.
Usage
iwatupdate [-h|-v] [-p] progname progargs...
The following environment variables are set (to the described values) before the
program progname is run:
IW_EVENT “Update”
IW_TIMESTAMP Time when the event occurred.
IW_EVENTUSER Username of person who performed the operation.
IW_EVENTROLE Role IW_EVENTUSER was in during the operation.
IW_WORKAREA Version path of workarea (rooted at the archive).
IW_UPDATEID objid associated with the update event.
IW_EDITOR Workarea owner.
iwlsat
iwlsat lists registered iwat programs, their IDs, and their event regular expressions.
Usage
iwlsat [-h|-v] [-s servername]
Example
% iwlsat
iwrmat
iwrmat unregisters programs that have been added using the iwat command.
Usage
iwrmat [-h|-v] [-s servername] ID
Example
% iwrmat 1234
Master List
The following is an alphabetized master list of all the CLTs and command triggers
described in this manual:
This appendix contains the following sample command trigger Perl scripts:
email_to.ipl – sends email to a list of users when a triggering event occurs.
replicate_tobranch.ipl – replicates submitted files and directories from a
workarea to the staging area of a specified branch.
#!/usr/local/bin/perl
# email_to.ipl
#
# Usage:
# iwatasgn email_to.ipl tolist
# iwatlock email_to.ipl tolist
# iwatmkbr email_to.ipl tolist
# iwatmkwa email_to.ipl tolist
# iwatpub email_to.ipl tolist
# iwatrmbr email_to.ipl tolist
# iwatrmed email_to.ipl tolist
# iwatrmwa email_to.ipl tolist
# iwatsub email_to.ipl tolist
# iwatunlock email_to.ipl tolist
#
# (Unix)
# Example : iwatpub email_to.pl 'mktg,staff,$IW_EVENTUSER'
# Example : iwatasgn email_to.pl '$IW_ASSIGNEE,$IW_EDITOR'
# Example : iwatsub email_to.pl '$IW_EVENTUSER,mktg'
#
# (NT)
# Example : perl iwatpub perl email_to.pl mktg,staff,$IW_EVENTUSER
# Example : perl iwatasgn perl email_to.pl $IW_ASSIGNEE,$IW_EDITOR
$| = 1;
use Config;
if ($Config{osname} eq "MSWin32") {
$MAILER = 'blat.exe - -t';
} else {
$MAILER = '/usr/lib/sendmail';
}
use File::Basename;
$MYNAME = basename($0, ".pl" );
use Env qw(PATH IWDEBUGERR IWDEBUGMAIL IW_EVENT IW_TIMESTAMP
IW_EVENTUSER IW_EVENTROLE IW_AREA IW_FILEPATH IW_OBJID
IW_ASSIGNEE IW_COMMENTS);
$SIG{__DIE__} = sub {
open(STDERR, ">&SAVESTDERR");
die "$MYNAME: " . $_[0];
};
}
sub MailTolist {
my $maillist_p = $_[0];
my $maillist = join ",", map "$_$DEFDOMAIN", keys %$maillist_p;
return $maillist;
}
sub MailTo {
my $maillist = MailTolist($_[0]);
my $oldfh;
unless ($IWDEBUGMAIL) {
open (MAIL, "| $MAILER $maillist")
or die "Couldn't open pipe to $MAILER $maillist\n";
$oldfh = select MAIL;
}
else {
print "Pipe to $MAILER $maillist\n";
}
print "$IW_COMMENTS\n";
&DumpAll;
print "$SIGNATURE\n";
unless ($IWDEBUGMAIL) {
close (MAIL);
select $oldfh;
}
}
sub MailAssign {
print "Subject: File assigned to $IW_ASSIGNEE: $IW_FILEPATH\n\n";
print "Timestamp: $IW_TIMESTAMP\n";
print "Branch: $IW_BRANCH\n";
print "Workarea: $IW_AREA\n";
print "Workarea owner: $IW_EDITOR\n";
print "Assigned by user: $IW_EVENTUSER\n";
print "File path: $IW_FILEPATH\n";
print "\nAssignment comments:\n" . "-" x 60 . "\n";
}
sub MailApprove {
print "Subject: File approved by $IW_EVENTUSER: $IW_FILEPATH\n\n";
print "Timestamp: $IW_TIMESTAMP\n";
print "Branch: $IW_BRANCH\n";
print "Workarea: $IW_AREA\n";
print "Workarea owner: $IW_EDITOR\n";
print "Approved by: $IW_EVENTUSER\n";
print "File path: $IW_FILEPATH\n";
print "\nApproval comments:\n" . "-" x 60 . "\n";
}
sub MailReject {
print "Subject: File rejected by $IW_EVENTUSER: $IW_FILEPATH\n\n";
print "Timestamp: $IW_TIMESTAMP\n";
print "Branch: $IW_BRANCH\n";
print "Workarea: $IW_AREA\n";
print "Workarea owner: $IW_EDITOR\n";
print "Rejected by: $IW_EVENTUSER\n";
print "File path: $IW_FILEPATH\n";
print "\nRejection comments:\n" . "-" x 60 . "\n";
}
sub MailUnassign {
print "Subject: File unassigned by $IW_EVENTUSER:
$IW_FILEPATH\n\n";
print "Timestamp: $IW_TIMESTAMP\n";
print "Branch: $IW_BRANCH\n";
print "Workarea: $IW_AREA\n";
print "Workarea owner: $IW_EDITOR\n";
print "Unassigned by: $IW_EVENTUSER\n";
print "File path: $IW_FILEPATH\n";
print "\nUnassignment comments:\n" . "-" x 60 . "\n";
}
sub MailMarkDone {
print "Subject: File marked done by $IW_EVENTUSER:
$IW_FILEPATH\n\n";
sub DumpAll {
@vars = qw(
IW_TIMESTAMP IW_EVENTUSER IW_EVENTROLE IW_EVENT
IW_VPATH IW_EVENTLINE IW_BRANCH IW_EDITION
IW_STAGINGAREA IW_WORKAREA IW_AREA IW_FILE
IW_FILEPATH IW_OBJID IW_ASSIGNEE IW_EDITOR
IW_COMMENTS IW_SUBMITID);
for ($i=0; $i<=$#vars; $i++) {
$v = $vars[$i];
if (! $ENV{$v}) { next; }
print "$v : $ENV{$v}\n";
}
}
# MAIN code
#
MailTo(\%emaillist);
Replication Script
The following Perl script, replicate_tobranch.pl, replicates files and directories to
the staging area of a specified branch. Replication is triggered whenever the files or
directories are submitted to their original workarea. This script is designed for use with
the iwatsub command trigger and is typically used to integrate content from one or
more subbranches back to a parent branch. Syntax and an example are included in
comment lines. Due to this document’s formatting constraints, some individual lines are
depicted below as two or more lines. These lines are indicated by a large, bold-face
exclamation point (!). A line ending with this character should be joined with the next
line to form a single line of code.
#!/usr/local/bin/perl
#replicate_tobranch.pl
##This program replicates submitted files/dirs from a workarea
##to the staging area of a specified branch. This can be useful
##when integrating content from subbranches back to parent
##branches.
##Example:
##Given Teamsite directory layout:
##main->dev1
## EDITION
## STAGING
## WORKAREA
## ->dev2
## EDITION
## STAGING
## WORKAREA
## user1
## file1
##
##> iwatsub replicate_tobranch.pl dev1
##
##When file1 is submitted to dev2 STAGING, a submit event
##will be generated, and file1 will also get submitted to
##STAGING in dev1.
push @INC, "/usr/local/lib/perl5";
if ($#ARGV >=0) {
$submitto_branch="//IWSERVER/default/main/". @ARGV[0];
} else {
$submitto_branch="//IWSERVER/default/main/acmetest/A"; #default
}
# testing only, get the last event, assume it's submit for now
if ($event eq "") {
$eventlog=`$iwhomebin/iwgetelog`;
chop($eventlog);
$tailevent=`grep Submit $eventlog |tail -1`;
@tailevent=split("\t",$tailevent);
$event=@tailevent[3];
$timestamp = @tailevent[0];
$user = @tailevent[1];
$role = @tailevent[2];
$objid = @tailevent[5];
chop($objid);
$path = @tailevent[4];
}
#
#iwlist makes sure the branch is valid
#
#
#iwlist makes sure the replicated workarea exists in
#submitto_branch
#
$existreparea=`$iwhomebin/iwlist $replicate_workarea 2>&1`;
chop($existreparea);
exit(0);
}
";
#
#find parentbranch from the path in the submit event
#
print "$parentbranch\n";
$submit_objs="";
while (<SUBLOG>) {
@result = split('\t', $_);
$action = $result[1];
$obj_type = $result[2];
($filename) = &URLDecode($result[3]);
($description) = &URLDecode($result[5]);
$description =~ s/(\s)+/ /g; # loose newlines/tabs
if ($description eq "<none>") {
$description = "[no comment specified]";
}
print "DEBUG:filename : $filename\n";
print "DEBUG:obj_type : $obj_type $action\n";
print "DEBUG:Individual Comment: $description\n\n";
$submitrtn=`$submitcmd`;
print "DEBUG: submit rtn=$submitrtn\n";
sub URLDecode
{
#Decode a URL encoded string or array of strings
#+ is converted to space
#%NN is converted from hex
foreach (@_) {
s/%0D%0A/ /g;
tr/+/ /;
s/%(..)/pack("c", hex($1))/ge;
}
@_;
}
Error Codes
This table lists all the possible error codes that can be returned by a TeamSite
command-line tool. Most of them are standard errors, but there are also many
TeamSite-specific error codes. The list of TeamSite-specific error codes starts on
page 273.
0 psx_YES
This appendix contains the following search query XML schemas, which are used with
the iwsrchquery CLT:
BaseQueryLanguage.xsd – the basic search query schema.
FullTextQueryElements.xsd – extends BaseQueryLanguage.xsd to support
full-test searches for documents and attributes.
TeamSiteSearch.xsd – extends BaseQueryLanguage.xsd to support searches for
FormsPublisher templating attributes.
BaseQueryLanguage.xsd
<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:group name="attributeSpecifier">
<xs:annotation>
<xs:documentation>
Used to refer to attributes in attributeConstraints, selectors
and ordering clauses
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="name" type="xs:string" />
<!-- dataType is normally string/int/long/date and is optional
<xs:complexType name="attribute">
<xs:annotation>
<xs:documentation>
Used to refer to attributes in select and ordering clauses
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:group ref="attributeSpecifier"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="and">
<xs:annotation>
<xs:documentation>
A constraint formed by logically 'AND'ing a set of constraints.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="constraint">
<xs:sequence>
<xs:element ref="constraint" maxOccurs="unbounded" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="or">
<xs:annotation>
<xs:documentation>
A constraint formed by logically 'OR'ing a set of constraints
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="constraint">
<xs:sequence>
<xs:element ref="constraint" maxOccurs="unbounded" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="accrue">
<xs:annotation>
<xs:documentation>
A constraint whose relevance is determined by the number
of sub-constraints that match.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="constraint">
<xs:sequence>
<xs:element ref="constraint" maxOccurs="unbounded" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="not">
<xs:annotation>
<xs:documentation>Negates a constraint</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="constraint">
<xs:sequence>
<xs:element ref="constraint" minOccurs="1" maxOccurs="1" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:annotation>
<xs:documentation>
An operator for logical attribute comparisons
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="LT" />
<xs:enumeration value="GT" />
<xs:enumeration value="EQ" />
<xs:enumeration value="NEQ" />
<xs:enumeration value="GE" />
<xs:enumeration value="LE" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="attributeComparison">
<xs:annotation>
<xs:documentation>
Used to logically compare a attribute to a constant
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="attributeConstraint">
<xs:sequence>
<xs:element name="operator" type="operator" />
<xs:element name="value" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!--
This is how you construct a search predicate. A search predicate is
a constraint. This constraint may be any subtype of the abstract
"constraint" type, including the compound (and, or) constraints that
allow logical grouping of atomic constraints. Some search systems
will only support documents that are of type predicate. Others will
support full-fledged queries (defined in the element "query"
-->
<xs:element name="predicate">
<xs:annotation>
<xs:documentation>The root of a query predicate</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element ref="constraint" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:complexType name="selector">
<xs:annotation>
<xs:documentation>
An abstract element that defines the selector portion of a query
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="attribute" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ordering">
<xs:annotation>
<xs:documentation>
An abstract element that defines how to order results
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="attribute" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<!--
This is how you construct a full-fledged query. Note that some
query APIs will not support the full query, but instead support
only subsets of it.
-->
<xs:element name="query">
<xs:annotation>
<xs:documentation>A full query.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="selector" minOccurs="0"/>
<xs:element ref="predicate" minOccurs="0"/>
<xs:element ref="ordering" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<!--
Substitution groups define the ability to use the various constraints
in place of the abstract bases "constraint" and
"attributeConstraint".
-->
<xs:annotation>
<xs:documentation>
The abstract substitution group for any constraint
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>
FullTextQueryElements.xsd
<?xml version="1.0" encoding="UTF-8" ?>
<!--
Full-Text components of the Interwoven Query Language.
The elements here extend the base query language and add
full-text search ability for documents and attributes.
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:include schemaLocation="BaseQueryLanguage.xsd"/>
</xs:annotation>
<xs:complexContent>
<xs:extension base="constraint" />
</xs:complexContent>
</xs:complexType>
<xs:complexType name="fulltext-any">
<xs:annotation>
<xs:documentation>
A fulltext constraint that searches for any of the terms
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fulltext">
<xs:sequence>
<xs:element name="term" type="xs:string" maxOccurs="unbounded" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="fulltext-accrue">
<xs:annotation>
<xs:documentation>
A fulltext constraint that searches for any of the terms
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fulltext">
<xs:sequence>
<xs:element name="term" type="xs:string" maxOccurs="unbounded" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="fulltext-all">
<xs:annotation>
<xs:documentation>
A fulltext constraint that searches for all of the terms
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fulltext">
<xs:sequence>
<xs:element name="term" type="xs:string" maxOccurs="unbounded" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="fulltext-phrase">
<xs:annotation>
<xs:documentation>
A fulltext constraint that searches for a phrase
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fulltext">
<xs:sequence>
<xs:element name="term" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="fulltext-sentence">
<xs:annotation>
<xs:documentation>
A fulltext constraint that searches for its terms in the
same sentence
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fulltext">
<xs:sequence>
<xs:element name="term" type="xs:string" maxOccurs="unbounded" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="fulltext-near">
<xs:annotation>
<xs:documentation>
A fulltext constraint that searches for its terms based
on their proximity
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fulltext">
<xs:sequence>
<xs:element name="ordered" type="xs:boolean" />
<xs:element name="proximity" type="xs:int" />
<xs:element name="term" type="xs:string" maxOccurs="unbounded" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="fulltext-stem">
<xs:annotation>
<xs:documentation>
A fulltext constraint that searches for a word and its stems
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fulltext">
<xs:sequence>
<xs:element name="term" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="fulltext-wildcard">
<xs:annotation>
<xs:documentation>
A fulltext constraint based on a wildcard expression
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="term" type="xs:string" />
</xs:all>
</xs:complexType>
<xs:complexType name="fulltext-attribute">
<xs:annotation>
<xs:documentation>
A fulltext constraint that is applied to a attribute.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="attributeConstraint">
<xs:sequence>
<xs:element ref="fulltext" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
substitutionGroup="fulltext" />
<xs:element name="fulltext-any" type="fulltext-any"
substitutionGroup="fulltext" />
<xs:element name="fulltext-all" type="fulltext-all"
substitutionGroup="fulltext" />
<xs:element name="fulltext-phrase" type="fulltext-phrase"
substitutionGroup="fulltext" />
<xs:element name="fulltext-sentence" type="fulltext-sentence"
substitutionGroup="fulltext" />
<xs:element name="fulltext-near" type="fulltext-near"
substitutionGroup="fulltext" />
<xs:element name="fulltext-stem" type="fulltext-stem"
substitutionGroup="fulltext" />
<xs:element name="fulltext-wildcard" type="fulltext-wildcard"
substitutionGroup="fulltext" />
<xs:element name="fulltext-attribute" type="fulltext-attribute"
substitutionGroup="attributeConstraint"/>
</xs:schema>
TeamSiteSearch.xsd
<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:include schemaLocation="FullTextQueryElements.xsd"/>
<!--
Extension that allows restriction of scope to files that have a
given file extension.
-->
<xs:complexType name="scope-fileExt">
<xs:annotation>
<xs:documentation>
A constraint that restricts the search to the specified
file extensions
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="extension" type="xs:string" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<!--
Extension that allws restriction of the scope to files that live
under a given directory (and its subdirectories)
-->
<xs:complexType name="scope-location">
<xs:annotation>
<xs:documentation>
A constraint that restrics the search to a location
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="constraint">
<xs:sequence maxOccurs="unbounded">
<xs:element name="location" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!--
Wildcard matching on area-relative-path
-->
<xs:complexType name="areaRelativePath">
<xs:annotation>
<xs:documentation>
A constraint that restrics the search to a location
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="constraint">
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="wildcard" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- Substitution groups for query elements added in this file -->
<xs:element name="templatingAttribute" type="templatingAttribute"
substitutionGroup="constraint" />
<xs:element name="scope-fileExt" type="scope-fileExt"
substitutionGroup="constraint" />
<xs:element name="scope-location" type="scope-location"
substitutionGroup="constraint" />
<xs:element name="areaRelativePath" type="areaRelativePath"
substitutionGroup="constraint" />
</xs:schema>
iwprefconv 66 iwuseradm 87
iwprop 174 iwutildreset 91
iwproxy 67 iwutildstat 92
iwprv 176 iwversion 93
iwpublish 177 iwvpath 225
iwqueryjobs 178
iwquerytasks 179 J
iwrcsdiff 181
iwrecentusers 68 job
iwrename 183 change description 195
iwreset 69 change owner 196
iwretryjobop 184 instantiating 141
iwrevert 185 querying 178
iwrlog 186 removing from server 190
iwrmat 248 running 140
iwrmbr 188
iwrmed 189 L
iwrmjob 190 LDAP configuration 144
iwrmtaskfile 191 LDAP query 146
iwrmtaskgroup 192 LDAP users 150
iwrmtaskuser 193 Linux-specific error codes 271, 272
iwrmwa 194 location 53
iwroleadm 71 locking 156
iwsetjobdescription 195 locking files 155
iwsetjobowner 196 locks 153
iwsettaskattrib 197 directory 236
iwsettaskcomment 198 log
iwsettaskdescription 199 file locations 50
iwsettaskfilecomment 200 revision 186
iwsettaskownerandarea 201 server 52
iwsettasktimeout 202 trace 55
iwsi 75
iwsrchattrib 203
iwsrchgethome 206
M
iwsrchgetpage 207 mapping
iwsrchmgrping 209 changing 63
iwsrchmgrstop 210 metadata
iwsrchndxstatus 211 obtaining 105
iwsrchndxstatuschg 213 modifications
iwsrchquery 214 list of 118
iwstat 77 mount point 53
iwstoreadm 80
iwsubmit 217 N
iwtaketask 218 NSF error codes 275
iwtaskselect 219
iwtaskvariable 220
iwtestcfg 81 O
iwtock 82 object IDs 18
iwuidname 83 objids 18
iwundochoice 221 ODBC error codes 274
iwunlock 222 operational error codes 271
iwuntasktask 223 operations
iwupdate 224 deleting from server 24
iwuser 84 OSF/AXP error codes 272
P iwndxmgrstop 166
paths iwsrchattrib 203
directory 17 iwsrchgethome 206
version 15, 16 iwsrchgetpage 207
permissions iwsrchmgrping 209
control 25 iwsrchmgrstop 210
migrating 30 iwsrchndxstatus 211
print iwsrchndxstatuschg 213
version path 225 iwsrchquery 214
private workareas 176 search manager
program stop 210
executing 115 server
unregistering 248 log 52
proxy server 67 proxy 67
publishing staging area 177 removing job 190
server operation
terminating 24
Q server workflow
query displaying 139
LDAP 146 server workflow event
query results displaying 136
display 207 service monitor 82
querying jobs 178 shared library error codes 270
querying tasks 179 shared task 218
staging
R publishing 177
submitting to 217
relative vpaths 16 statistics
release information 93 utility daemon 92
removing branch 188 status 211
rename file 160 stopping index manager 166
reporting stream problem error codes 269
configuring 37 submit
reverse task transition 221 resolving conflicts 184
revert file to previous version 185 submit filtering 81
revision log 186 submit to staging 217
roles submit.cfg 69
administer 71 SunOS4 error codes 272
user 117 synchronizing directories 125
system activity 77
S system information 21
script iwgetelog 47
email notification 257 iwgetfilejobs 48
replication 262 iwgethome 49
search 203, 207, 210, 211, 213 iwgetlocation 50
home directory 206 iwgetlog 52
query 214 iwgetmount 53
response time 209 iwgetstore 54
search and index iwgettrace 55
iwndxaddbr 161 iwrecentusers 68
iwndxfreezebr 162 iwstat 77
iwndxlistbr 163 iwuser 84
iwndxmgrfreeze 164 iwversion 93
iwndxmgrstatus 165
system services 22 U
iwabort 24 unfreeze 40
iwaccess 25 unlock 245
iwaccessmigrate 31 update tasks
iwancestor 34 resolving conflicts 184
iwchgrp 35 user properties 174
iwconfig 36 user_databases.xml 144, 146, 150
iwconfigtsreport 37 users
iwfreeze 40 add to task 104
iwgroup 56 authenticating 113
iwprefconv 66 list of 68
iwproxy 67 login name 83
iwreset 69 manage 87
iwroleadm 71 role 117
iwsi 75 utility daemon
iwtestcfg 81 configuring 91
iwtock 82 statistics 92
iwuidname 83
iwuseradm 87
iwutildreset 91
V
iwutildstat 92 version management 98
iwcat 116
iwcmp 118
T iwdiffapply 125
task iwdiffdir 126
add users 104 iwrcsdiff 181
adding file 102 iwrevert 185
assigning 218 iwrlog 186
attribute 197 version paths 15
comment 198 printing 225
delete file 124 relative 16
description 199 vpaths 15, 116
file comment 200 relative 16
finishing 219
information 138
owner 201, 223 W
querying 179 workarea
remove group 192 changing group ownership 35
remove users 193 creating 159, 238
removing a file from 191 deleting 242
rename file 160 history 128
reverse transition 221 locking 156
variables 220 locks 153
TeamSite private 176
service monitor 75 removing 194
TeamSite program files renaming 183
location 49 submitting 217
timeout 202 update 224
tracelogs workarea operation 97
location 55 iwevents 128
iwlistlocks 153
iwlistmod 154
iwlock 155
iwlockinfo 156
iwmkwa 159
iwprv 176
iwrmwa 194
iwsubmit 217
iwunlock 222
iwupdate 224
workflow
job and task IDs 48
workflow event 137
workflow variables
manipulating 142
workflow/job 99
iwaddtaskfile 102
iwaddtaskgroup 103
iwaddtaskuser 104
iwcallback 115
iwdeltaskfile 124
iwgeteventcomments 136
iwgeteventfiles 137
iwgettaskbyname 138
iwgetwfobj 139
iwinvokejob 140
iwjobc 141
iwjobvariable 142
iwmvtaskfile 160
iwqueryjobs 178
iwquerytasks 179
iwretryjobop 184
iwrmjob 190
iwrmtaskfile 191
iwrmtaskgroup 192
iwrmtaskuser 193
iwsetjobdescription 195
iwsetjobowner 196
iwsettaskattrib 197
iwsettaskcomment 198
iwsettaskdescription 199
iwsettaskfilecomment 200
iwsettaskownerandarea 201
iwsettasktimeouttask 202
iwtaketask 218
iwtaskselect 219
iwtaskvariable 220
iwundochoice 221
iwuntaketask 223