remoteware server reference manual - help.sap.com · iv remoteware server reference guide chapter...

RemoteWare®

Server Reference GuideV e r s i o n 4 . 3 S P 3

RemoteWare Server Reference GuideVersion 4.3 SP3 Document version 4.33.01 Copyright © 2010 iAnywhere Solutions, Inc. All rights reserved. iAnywhere and RemoteWare are trademarks of Sybase, Inc. or its subsidiaries. ® indicates registration in the United States of America. ® indicates regis-tration in the United States of America.

C O N T E N T S

Table of Contents

Preface: Using this Guide xv

Revisions for document version 4.33.01. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Revisions for product version 4.3 SP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi

SPX and IPX protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi

RemoteWare Support Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Related publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiiAdministrator guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiiClient guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix

Chapter 1: RemoteWare Interface 21

User interface components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22RemoteWare Server programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

RemoteWare program overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 2: RemoteWare Menu 37

RemoteWare Menu at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Menu commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

RemoteWare Menu main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Exiting RemoteWare Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

iv R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

Chapter 3: Administrator 43

RemoteWare security introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Administrator main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Add or remove application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Applications and rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Server Control and Options window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54System Control property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Command Options property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Log Files property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Registry Settings property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Data Sources property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Scheduler Control property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Chapter 4: Server Profile 65

Server Profile at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Property pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Information property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Settings property page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Cluster property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Long Distance property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Network Groups property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Resources property page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Limit Outbound property page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Dial Scripts property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Modem Types property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Protocol property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Alarms property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Logging property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Licensing property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Portable Security page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Chapter 5: Client Profile 123

Client Profile at a glance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Ta b l e o f C o n t e n t s v

Property pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Client List property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129General property page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Client property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Server property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Assignments property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Information property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Comments property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Members property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Parents property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Objects property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Sessions property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Make-Kit Installation Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Template Installation Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Run Client As Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Regular Client makekit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Create 32-bit Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Files created in a makekit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Registration menu overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Client Registration Options window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Manual verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Schedule Registration Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Chapter 6: Work Object Editor 179

Work Object Editor at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Work object types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181When an object doesn’t execute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Property pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Objects property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186General Attributes property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Application Attributes property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Events property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Members property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Sessions property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Clients property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Users property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Parents property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

vi R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

Chapter 7: Worklist Editor 213

Worklist Editor at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Worklist Editor main window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217Find option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218Replace option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Chapter 8: Session Editor 221

Session Editor at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Session tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Property pages in Session Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Property pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Sessions property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Schedule property page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230Objects property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238Clients property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240Options property page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Chapter 9: Schedule Manager 245

Schedule Manager at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Command menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247View menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249Filter menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249Scheduler menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

Schedule Manager main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

Details for Session window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254General property page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254Objects property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256Options property page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259Dependent Session Details property page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Loss of Scheduler Database Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

Ta b l e o f C o n t e n t s v i i

Chapter 10: Network Status 263

Network Status at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

Network Status main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Resource information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267RemoteWare Servers item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Server Name item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270Active Sessions item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Alarms item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272Resources item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273Individual resource items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Chapter 11: Log Viewer 283

Log Viewer at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284Quick Filter Views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287File menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

Log Viewer main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291View Properties window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Item detail dialog boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303Row Detail dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303Select Detail Type dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

Logging database schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

Chapter 12: Session Recovery 311

Session Recovery at a glance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313Command menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315View menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Filter menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Session Recovery main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325Client Information window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

Troubleshooting unsuccessful restarts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

viii R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

Chapter 13: Report Manager 329

Report Manager at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330Report execution fundamentals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335File menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336Command menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

Report filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

Generating reports in CSV file format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339Viewing enhanced CSV file reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

Report Manager main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

Reports in Report Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343Administration report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343Client Communications report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343Client Detail report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345Client Groups report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348Clients report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350File Transfer Log report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351Long Distance Service Usage report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352Long Distance Services report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353Messaging Listing report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354Modems report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354Network Group report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355Port Communications report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Ports report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357Portable Security Users report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358Protocols report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359Server Log report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360Session Event Log report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361Session Log report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364Session Recovery report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365Sessions report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366System report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369User Group Listing report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371User Listing report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372Work Objects report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

Session Log error types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

Ta b l e o f C o n t e n t s i x

Chapter 14: Interactive Session 379

Interactive Session at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381File menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383Edit menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383View menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384Command menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385Options menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386Client Commands menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387Server Commands menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390Other commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

Interactive Session main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393Encrypting a session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393Initiating a session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

Remote Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395Using the pcAnywhere toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397Exiting Remote Control - pcAnywhere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398Uninstalling Remote Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

Remote Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

Chapter 15: Messaging Administration 401

Messaging Administration at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

Messaging Administration main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

Messaging Services fundamentals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

Messaging and open systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404Address book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404Message store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405Tracking and reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Property pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408Database Subsystems page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408Messaging Log page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410Directory Synchronization page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412Non-Delivery Receipt page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414Gateway Manager page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

x R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

Personal Folders (Message Store service) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

Personal Address Book service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

Chapter 16: Directory Manager 423

Directory Manager at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424User group fundamentals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424User fundamentals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

Menu commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

Directory Manager main window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428Profile window (user) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429Profile window (user group) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

Appendix A: Events 441

Event types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

Event Details window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

Event specific fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447Options area. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454Execute area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

Optimizing event execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459Preprocessing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459Execution optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460Worklist optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

Event properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466APPEND file(s) to another . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466ASCII APPEND file(s) to another . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469begin QUOTA block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471CHECK DISK. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475* CHECK file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477* CHECK SEND file(s) to Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479* COMMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481COPY file(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482CREATE REGISTRY KEY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484† DELETE file(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486DELETE INI FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488DELETE REGISTRY KEY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491DELETE REGISTRY VALUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493

Ta b l e o f C o n t e n t s xi

DIRectory listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495END <event> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497ELSE IF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497END IF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497END QUOTA block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498END REPEAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498END SESSION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499END WORK OBJect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500EXCEPTION worklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502† EXECUTE program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503GET file(s) from Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506get FILE STATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509GET REGISTRY VALUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511GET VARiable from SCRIPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513IF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515insert WORKLIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518LOAD SCRIPT file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520* MAKE DIRectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522MESSAGE EXCHANGE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524NOTIFY nt server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525READ INI FILE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529REBOOT Client at end of session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531RELEASE SCRIPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532REMOVE DIRectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534RENAME file(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536REPeat IF previous event FALSE / TRUE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538RUN SCRIPT FUNCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541*† SEND file(s) to Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543SET Client TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547SET file ATTRIButes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548SET REGISTRY VALUE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550SET VARiable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552SET VARiable in SCRIPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554TEST if Client is in GROUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556TEST VARiable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558UNASSIGN from client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560USER defined ALARM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562WAIT for file to exist. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564WRITE INI FILE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566

Appendix B: RemoteWare System Limits 569

Work Object Editor Limits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570

xii R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

Session Editor Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571

Schedule Manager Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572

Appendix C: External Configuration Files 573

ECFs at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574ECF Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575

Guidelines for using ECFs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577Understanding the Action keywords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577Linking ECFs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577Building ECFs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578

ECF properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580Dial Script ECF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580Long Distance Service ECF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582Modem ECF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583Client ECF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586Client Group ECF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593Portable Security ECF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595Protocol ECF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596Resource ECF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598Scheduler ECF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602Session ECF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604Work Object ECF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609System ECF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613Worklist ECF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617Messaging Administration ECF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625User ECF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627User Group ECFs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629

The GEN utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630Precedence of GEN utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632

Appendix D: Kernel Command Line Switches 633

RWKernel.exe Command Line Switches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634

Appendix E: RemoteWare Database Maintenance 635

Log maintenance process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636

Ta b l e o f C o n t e n t s xi i i

Maintaining SQL Server databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637

INDEX 639

xiv R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

P R E F A C E

Using this Guide

This guide introduces you to installing RemoteWare, a remote systems management tool specifically designed to automate data collection and systems management with mobile systems. It contains fundamental information necessary to install the software, including a conceptual overview and step-by-step procedures.

We recommend you print this guide so it is readily available as you perform your tasks. If you prefer to use this guide online, you may find it helpful to zoom to 150% for enhanced readability.

Revisions for document version 4.33.01This document is updated for corrections and clarifications.

• Corrected variable resolution and clarified descriptions for predefined variables <WindowsSysDir>, <WindowsESD>, and <WindowsSysESD>. See “Predefined variables” on page 447.

• Relating to using a template installation kit, corrected a control file’s client name truncation length from 9 characters to 8 characters. See “Control file (Silent.ini) format” on page 164.

• Relating to Append file and ASCII Append file events, corrected temporary file use key name “Do_Not_Use_Temp_File” to “DoNotUseTempFile.” See “APPEND file(s) to another” on page 466 and “ASCII APPEND file(s) to another” on page 469.

xvi R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

Revisions for product version 4.3 SP3

This document is updated for corrections, clarifications, and to reflect the new features introduced with product version 4.3 SP3.

• Updated Server Profile Logging property page’s list of session log data elements to include a check box for logging files that were declared by a wildcard but do not require update. See “Logging property page” on page 115.

• Change file transfer logging to include attempted and actual file transfers, rather than just actual.

• “File Transfer Quick Filters” on page 284

• “File Transfer Logs” on page 291

• Updated the list of event predefined variables:

• Added variables GetFilesAttempted, GetFilesFailed, and GetFilesSuccessful.

• Clarified descriptions for variables SendFilesAttempted, SendFilesFailed, and SendFilesSuccessful to state that these variables populate with session values, rather than work object values.

See “Predefined variables” on page 447.

• Clarified information for using database down popup alarms between computers with different operating systems. See “Alarms property page” on page 113.

• Updated the list of ECFs to include PORTABLE_SECURITY. See “Portable Security ECF” on page 595.

• Corrected the list of Worklist ECF valid options for keyword “Options” to include BYTE_LEVEL_DIFFERENCING. See “Worklist ECF” on page 617.

• Clarified the definition for the QUOTA block event’s data limit attribute to consider data compression. See “begin QUOTA block” on page 471.

SPX and IPX protocolThroughout this document are textual and graphical representations of the user interface related to Sequenced Packet Exchange (SPX) and Internetwork Packet Exchange (IPX) protocols. Although these representations are included in this document, and also appear in the RemoteWare application, this version of RemoteWare no longer supports these protocols. The next full release of RemoteWare will be updated accordingly.

R e m o t e Wa r e S u p p o r t S e r v i c e s xv i i

RemoteWare Support ServicesRegister at our technical support site to always get the latest information on your product version. This site is available only to maintenance customers.

Visit the Technical Support site for product-specific technical information.

www.sybase.com/support or frontline.sybase.com/support

http://www.sybase.com/support

http://frontline.sybase.com/support

xviii R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

Related publicationsThe following manuals are available in electronic format on the RemoteWare product image.

Administrator guides

• RemoteWare Server Installation Guide — Contains detailed information about installing your RemoteWare Server and its components. The guide also discusses environment and network considerations, configuring your database, cluster tuning, and uninstalling RemoteWare.

• RemoteWare Server Administrator’s Guide — Explains how to operate and maintain a RemoteWare system. It takes a task-oriented approach to describing features.

• RemoteWare Server Reference Guide — Contains a detailed description of every application, facility, window, menu, and control present in the RemoteWare Server. Use this book when you want to know what something does, how it is used, or why it behaves as it does.

• Portable Interactive Session — Introduces you to RemoteWare Portable Interactive Session, also known as “Portable.” Portable provides a secure and restricted method for communicating with the RemoteWare Clients. It contains fundamental information necessary to use the software, including a conceptual overview and highly interactive walkthroughs.

• RemoteWare Database Schema Guide — Describes the characteristics of the RemoteWare SQL database tables.

• RemoteWare Workshop Developer’s Guide — Explains how to use RemoteWare Workshop to create and publish customized desktop-style Workshop applications.

• RemoteWare Subscriber Administrator’s Guide — Shows how to build and deploy lists of files and applications to the Client. It also explains how to use the Subscriber Lists at the RemoteWare Client.

• RemoteWare Inventory Manager Administrator’s Guide — Explains how to use Inventory Manager for centralized monitoring and reporting of hardware and software resources on RemoteWare Clients. Instructions include how to create Inventory Manager Profiles that control the operating and scheduling of Client inventory scans, and how to assign those Profiles to Clients. The guide also describes how to view and interpret the centrally stored resource information for each Client.

R e l a t e d p u b l i c a t i o n s x ix

• RemoteWare Software Manager Administrator’s Guide — Explains how to use Software Manager to efficiently and securely distribute, install, and manage software for enterprise system users. Includes how to create and define software package contents and then assign that package to a RemoteWare Client.

• RemoteWare Migration Guide — Explains how to plan and implement many aspects of migration from RemoteWare for OS/2 to RemoteWare.

• RemoteWare Multicast System Administrator’s Guide — Explains how to use RemoteWare Multicast. Multicast allows administrators to distribute files to a large number of RemoteWare Clients with a single communication session from the Server. It contains fundamental information necessary to use the software, including a conceptual overview and highly interactive walkthroughs.

• RemoteWare ActiveX Controls Reference Manual — Presents the 32-bit ActiveX controls that are included with the RemoteWare 32-bit Client software. These controls add selected Client functionality to ActiveX or OLE container applications.

• RemoteWare API Manual — Describes the RemoteWare Application Programming Interfaces (APIs) that allows you to control and configure the RemoteWare Server and Clients using a third-party programming language such as Microsoft Visual C++ or Microsoft Visual Basic.

• RemoteWare Workshop Programmer’s Guide — Describes optional programmatic extensions that enhance Workshop environments.

• Summit BasicScript Reference Manual and Summit BasicScript User’s Guide — Provides information on the options and structure for RemoteWare scripting. These documents are available in the \Document\Development Tool Administrator Guides\Summit BasicScript Documentation directory on the RemoteWare CD.

• NetOp™ — Assists you in using NetOp with RemoteWare Remote Control.

Client guides

• RemoteWare 32-Bit Windows Client User’s Guide — Helps the Windows Client user install, set up, and understand the functionality in the RemoteWare Client.

• RemoteWare OS/2 Client User’s Guide — Presents the features, setup procedures, available options, and connection methods for the OS/2 Client software.

• Linux Client User’s Guide — Assists the Linux Client user install and use the RemoteWare Linux Client.

• RemoteWare Text-Based Clients User’s Guide — Explains how to use the UNIX, VMS, 4690 and DOS Clients to communicate with the RemoteWare Server.

xx R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

• RemoteWare Software Manager Client User’s Guide — Describes how Client users can subscribe to Software Manager packages and then communicate with a RemoteWare Server to receive those packages.

C H A P T E R

1

RemoteWare Interface

The RemoteWare interface is similar to other Windows applications. All of the interface

elements, dialog box controls, and applications are covered in this chapter.

If you are familiar with Windows, you will quickly feel comfortable with RemoteWare

and the organization of its commands and interface components. Users new to the

Windows interface may want to use this chapter along with a Windows User’s Guide to

acquaint themselves with the tools and controls used to perform everyday tasks.

Use the Glossary in the RemoteWare Server Administrator’s Guide to find the meanings

of terms related to RemoteWare, Windows, and communications.

This chapter includes:

• “User interface components” on page 22

• “RemoteWare program overview” on page 31

Note: Some of the window, dialog box, and icon appearances may differ from what you see in this manual depending on your operating system.

22 R e m o t e Wa r e S e r v e r R e f e r e n c e G u i d e

User interface componentsRemoteWare uses graphical elements in the

Windows operating system to promote a productive visual and functional environment. These elements are illustrated and discussed in the following pages.

RemoteWare Server programsYou can access the RemoteWare Server from the RemoteWare Menu desktop icon which is created upon installation. The RemoteWare Menu is also available from the Start menu. The individual Server programs have icons within the RemoteWare Menu program.

To start RemoteWare Menu, go to the Start menu, point to Programs, then to RemoteWare Server. Next, click RemoteWare Menu.

Alternatively, you can double-click the RemoteWare Menu icon on the desktop. For more information about this program, see “RemoteWare Menu” on page 37.

WindowsWindows provides the fundamental way for you to view and interact with RemoteWare. Because windows provides access to different types of information, they can be

Start menu

Taskbar

U s e r i n t e r f a c e c o m p o n e n t s 23

classified according to common usage. Interacting with RemoteWare applications generally involves a window with one or more components, such as pages, dialog boxes, menus, toolbar buttons, and status bars.

Examples of the common window components are discussed in the following sections.

Property pagesMost RemoteWare applications use property pages to organize sections of related information within the same window. When you click a page tab with the left mouse button, the corresponding page appears.

For a description of the controls used on the pages, see “Controls” on page 29.

MenusMenus are a common way of presenting commands in a graphical interface. They permit you to see the available commands within a context without having to remember the specific names or details of those commands.

There are several types of menus, including items such as the menu bar, shortcut menus, and cascading menus. The following sections cover these menus in more detail.

Title barMenu bar

Toolbar

Tabs

Column size adjustments

List box

Status bar

Status and brief help

Active list item


Menu bar itemsThe menu bar is located at the top of a window below the title bar. It provides access to drop-down menus – collections of commands displayed when you select a particular item (such as the File menu) on the menu bar.

Some menu commands have submenus, which are additional commands related to the menu item. A right arrow indicates that a menu command has a submenu; clicking the arrow displays more choices.

Shortcut menusShortcut menus provide an efficient way for you to work with objects in a window. When you right-click an item in a window, a shortcut menu appears (if one is available for the specific item). Because shortcuts are displayed at the pointer’s current location, they eliminate the need to move the pointer to the menu bar or a toolbar. And since shortcuts contain commands specific to the object under the pointer, they reduce the effort it takes to move and select a command from the menu bar.


Menu commands common to most programsEach of the RemoteWare programs uses a similar menu structure and identical commands for consistency and ease of use. The commands and toolbar buttons described in the following table are found in most of the Server applications.

Toolbars and status barsThe toolbar is a set of controls that approximately duplicates to the menu bar, providing quick access to frequently used commands or actions. Toolbars may be “torn” away from their normal position and moved anywhere in the window. To do this, place the cursor

Table 1. Menu commands common to most RemoteWare programs

Menu Command Button Description

File New Creates a new item.

Copy Duplicates an existing item and places the copy on the Clipboard.

Delete Removes an existing item.

Rename Changes the name or description of an existing item.

Update Views and optionally changes the item’s details.

Exit Stops the program and closes the window.

View Toolbar Displays or hides the toolbar buttons. The toolbar gives you quick access to frequently used commands and features.

Status Bar Hides or displays the bar at the bottom of the application window. This bar displays information about the selected menu item or toolbar button; it also may display information about the current status or activity of the application.

Help Topics Displays the list of Help topics for this application.Context-sensitive Help does not have a menu item.

Displays specific Help for the item you click with the mouse pointer.

About Provides program, version, and copyright information about the RemoteWare application.

Using Help Explains how to use Windows Help.


in the region surrounding the toolbar icons, then click and drag the toolbar to a new position. You can also “dock” the toolbar on any edge of the window, providing several access methods for your convenience.

A status bar displays information at the bottom of most RemoteWare application windows. Typically, this includes information on what is being viewed and a brief description of items as you point to them with the mouse.

Dialog boxesA dialog box provides an exchange of information (or a “dialog”) between you and RemoteWare. RemoteWare provides several general dialog boxes for common


operations, such as setting options, saving files, and displaying messages.

Dialog boxes for setting optionsVarious dialog boxes allow you to configure and edit resources, set date and times, and create objects (such as Clients, work objects, sessions, and so on). These dialog boxes usually appear when you choose to create or modify an object from the menu bar, toolbar, shortcut menu, or by selecting an object.

For more details about the different controls used in RemoteWare, see “Controls” on page 29.

Many of the controls in a dialog box are similar to those in windows and pages, although there are no controls to resize the dialog box.

When you are finished using a dialog box, you usually either click OK to apply current settings or Cancel to ignore changes.

Directory dialog boxes for opening or saving filesWhen you open or save files, different types of dialog boxes appear. The standard open/save dialog box and the basic file dialog box allow to you select files that contain Server related information.

The illustration on the right shows the standard open/save dialog box. You use this dialog box to select drives, directories, and file names when opening or saving files.


The basic save dialog box is typically used to copy files. You must provide the full path name and file name for the destination file. When you are finished using this dialog box, you usually either click OK to apply current settings or Cancel to ignore changes.

Message boxesMessage boxes display warnings, critical information, or messages that require your acknowledgment. The following buttons can appear in a message box and allow you to select the appropriate action:

• OK. Acknowledges an informational message, or verifies an action should take place. In the illustration on the right, the RWS code signifies a RemoteWare message, while the System Error Message is returned from Windows.

• Yes. Appears in warning messages. When you click this button, RemoteWare completes the action stated in the message.

• No. Appears in warning messages. When you click this button, RemoteWare does not apply the action stated in the message. This button is similar to Cancel, but does not return to the previous operation.

• Cancel. Appears in warning messages or dialog boxes. Aborts the action and returns to the previous operation.

Note: Using Cancel in a dialog box discards all changes, including those made on other property pages in the dialog box.


ControlsControls are used in every window, dialog box, and message box to provide a specific form of interaction. Some controls display or allow editing of particular values, while others direct the system to start commands.

Some of the common types of controls are described and illustrated in the following list:

• Tab. This control appears at the top of the window and divides sections of information in the same window. If there are more tabs than will fit in the window,

scroll buttons appear at the right of the tabs.

• Text box (field). This control is a box where you can view, enter, or edit text.

• Check box. This control is a square box that you can select or clear to turn an option on or off. You can select zero or more check boxes for an associated object.

• Command button. Usually called a “button.” Click to perform an action.

• Option button. This control is a round button; you can select only one option for an associated object.

• Spin box. A combination of a text box and a pair of up-down buttons that allow you to either type in a value or use the buttons to increment or decrement the value.

Tabs

Text boxes (or fields)

Check boxes

Command buttons

Option buttons

Spin box


• Column headings. Also called header controls, these appear above columns of text in list boxes. Click and drag the header divisions to size the columns.

• Tree control. Displays objects in a hierarchical relationship, usually in the left pane of a window. You can expand or collapse items in the tree by clicking the or

controls, respectively. Clicking individual objects displays information about that object in another window pane.

• List box. Depending on the context, this control displays or allows you to select one or more items from a list.

• Split bar control. This is a horizontal or vertical edge that can be used to resize adjacent regions in the window. Moving the pointer over a split bar changes the cursor to a split line. You can then drag the split bar to resize the panes.

• Scroll bar. This is a horizontal or vertical control used to view other areas of a window or list box that are not currently visible. A scroll bar is made up of scroll arrows, a scroll box, and a scroll bar shaft. Use the scroll arrows to scroll one item at a time, or click in the scroll box below or above the scroll bar shaft to scroll a page at a time. You can also click and drag the scroll bar shaft to move to a region of the list.

• Drop-down list box. Click the current item or the arrow to display the list; select from the choices to set the current value. The item displayed is the active choice.

Column headings

Tree control

List box

Left paneRight pane

Scroll barSplit bar

R e m o t e Wa r e p r o g r a m o v e r v i e w 31

RemoteWare program overviewThe following table lists and briefly describes all of the programs available in RemoteWare Server. Some of these programs are optional or may be installed as stand-alone programs. Therefore, your Server may not include all of the programs listed in the following table.

Table 2. RemoteWare Server programs

This icon Represents Usage

Administrator Give System Administrator rights to RemoteWare applications.

Set up: Windows users or groups on Servers or Workstations.

Specify: permitted applications and actions for any user or group to the RemoteWare system.

Control: Server operational status; options for ECF and Execution servers; options for logs and processes.

Server Profile View or configure Server specific parameters.

Display system parameters: serial number, version, release date, licensing values, and installation drives.

Set system-wide options: system name, Client behavior, system date and time, connection behavior, logging options, and alarm thresholds.

Monitor status: for this Server and other Servers in a cluster.

Define communications resources: long distance scripts, asynchronous, TCP/IP, SPX, and NetBIOS resources, dial scripts, modem types, and protocols.

View and adjust: licensing values, Inbound/Outbound Server operation.

Client Profile Define remote communication stations.

Set Client parameters: Client name, description, password, base operating system, time zone, permitted connections with other Servers, and file transfer options.

Specify Client connection method: protocols to use, modem or protocol details, connection number or addresses, and schedule.


Specify Server connection method: resources used to access Client and work objects to transact during session.

View Client information: total/free storage and memory statistics.

Work Object Editor

Define and organize tasks to execute.

Create tasks and task groups: ESD, worklist, application, groups of applications, or groups of worklists.

Specify attributes: execution options, times for execution, activation/deactivation timeframe, and limit execution by Client type.

Assign to: sessions, Clients, and other work objects.

Worklist Editor Create or modify task lists.

Manipulate: events, options, and settings for events.

Session Editor Schedule and organize how and when work objects will execute.

Set specifics: name and description, enabled state, and start date/time.

Define behavior: session type, schedule, calendar exceptions, frequency, dependencies on other sessions, initiation, retries, and inbound connection criteria.

Assign tasks: all work objects, work object groups, Clients, or Client groups.

View and set options: ESD and application behavior for assigned Clients; work object, application, and ESD behavior for this session.

Schedule Manager

Monitor and deploy sessions.

View sessions: in progress, blocked for resources, and pending.

Session details: status, times and ranges, destination, retries, resource requested, matching resource, objects executed/not executed, and options for this session and Client.

Table 2. RemoteWare Server programs (Continued)



Network Status Monitor communications activity and Server status.

Status hierarchy: for all Servers, active sessions, alarms, and resources.

View and clear alarms.

Monitor: file transfer conditions by files sent, event progress, bytes transferred, and packets retried.

Session Recovery

Identify Clients whose sessions ended with a certain completion status and resubmit sessions that were problematic or unsuccessful.

Request details: for any Client associated with a session.

Filter information by: Client, session, time, ECF, and session status.

Restart: failed or missing sessions.

Log Viewer View all RemoteWare logs.

Filter information by: a variety of options (such as Client, Server, time range, completion status, or resource) depending on the database field being viewed.

Request: details for any log item.

Report Manager Generate and view Server information.

Organize reports: export to text or spreadsheet.

Customize: specific filters appropriate to the report.

Interactive Session

Establish an interactive link with a Client.

Interact: diagnose Client disks, set Client time, navigate file system, display and alter directory structure.

Send: files and operating system commands.

Receive: files, Client, and file status.

Messaging Administration

Adjust the Message Transfer Agent’s (MTA) operating parameters.




View: current SQL database assignments, time of most recent update.

Retain information: for a set number of days, for errors only.

Set interval: update user directory, non-delivery receipts (NDRs).

Immediately execute: directory synchronization, NDR processing.

Directory Manager

Create and manage RemoteWare users.

Create users and user groups: name or description, password, address, assigned Client.

Specify: synchronization, member groups, attributes and values.

Monitor: unsynchronized items, group affiliation, address types.

Execute: directory synchronization.

Subscriber Editor

Compile and publish collections of files that are available to the Client.

Maintain: list libraries of working and published lists, groups of related files, archives of previous list versions.

Organize: any file type, associated descriptions, and groups.

Distribute: some or all files in lists by user group, archived versions, and recent changes to published lists.

Workshop Editor

Develop and deploy custom operating environments to Clients.

Build: applications, forms, and custom layouts consisting of graphical elements, images, lists, and other controls.

Modify: applications in a development and test environment.

Deploy: import, export, publish, and pull applications between Clients and other Servers.

Integrate: Subscriber lists, OLE and ActiveX controls.




Software Manager

Distribute, install, and manage software for Clients.

Create and distribute: software packages which contain custom or commercial applications.

Customize: distribution and installation of software.

Optimize communications: compression, checkpoint restart, and off-line installation of software.

Inventory Manager

Retrieve and report essential software and hardware inventory information that resides on your Clients’ machines.

Scan and collect: inventory information at scheduled times or during sessions.

View: inventory information, including software, hardware, directory structure, and configuration files, on a per-Client basis.

Create and add: Custom entries to the software catalog; Custom Views and Custom Fields of inventory information; and Client Groups or SQL Views based on the results of a Custom View.



C H A P T E R

2

RemoteWare Menu

RemoteWare Menu is a convenient starting point for RemoteWare Server operations.

Use the Menu to access all RemoteWare Server programs.


• “RemoteWare Menu at a glance” on page 38

• “RemoteWare Menu main window” on page 40


RemoteWare Menu at a glanceRemoteWare Menu has a Windows Explorer-style interface; it lists groups of RemoteWare programs in the left pane, and in the right pane it lists the individual programs available to the current user. Program availability depends on the products installed on the RemoteWare Server computer as well as the program access rights assigned to the current user in the Administrator program. To view the available programs, select a program group in the left pane; double-click a program icon in the right pane to start the program. You can use the menus and toolbar buttons to customize the window.

Menu commandsRemoteWare Menu uses menu, toolbar, and shortcut commands to manage the Server service and customize the main window components. The following table lists the menu commands and provides a brief description of each.

Note: The table does not contain the commands common to most RemoteWare programs. For a list of general menu commands, see “Menu commands common to most programs” on page 25.

Table 3. RemoteWare Menu commands


File Exit Closes the RemoteWare Menu.

Group All Utilities Displays every RemoteWare program.

Server Setup Displays programs that create or modify Server resources.

Server Operations Displays programs that monitor and manage the Server environment.

Server Logs Displays programs that record past activity, including Report Manager.

Messaging Operations Displays RemoteWare Messaging Services programs.

Information Management Utilities

Displays tools to manage the Client-user environment.

View Icon View Displays the programs as large icons.

R e m o t e Wa r e M e n u a t a g l a n c e 39

Small Icon View Displays the programs as small icons, arranged across the window.

View List View Displays the programs as small icons, arranged down the window.

Report View Displays the programs as small icons with descriptions.

Toolbar Displays or hides the toolbar and its buttons.

Status Bar Displays or hides the status bar at the bottom of the window.

Help Help Topics Opens the table of contents for the RemoteWare Server Help.

Using Help Opens the standard Windows Help window which explains how to use the Help system.

Install Notes Opens the Readme file containing additional information.

About RemoteWare Menu

Displays copyright and version information for this program.

Table 3. RemoteWare Menu commands (Continued)



RemoteWare Menu main windowTo start RemoteWare Menu, double-click the RemoteWare Menu icon on the desktop. The main window of program groups and icons appears.

The left pane displays program groups. These groups contain the RemoteWare programs that are related to each other. To view the programs in a group, select the group in the left pane; the right pane displays the contents of the selected group.

The following table lists the groups and their programs. Some of these programs are optional or may be installed as stand-alone programs; your RemoteWare Menu may not contain all of the programs listed in the table. For more information about each application, see “RemoteWare program overview” on page 31. You can also refer to the appropriate chapter later in this manual.

Table 4. RemoteWare Menu programs

Program group Program name Use this program to...

All Utilities Display every utility listed below.

Server Setup Administrator View, grant, and deny access to RemoteWare programs.

Server Profile Configure the Server attributes and resources.

R e m o t e Wa r e M e n u m a i n w i n d o w 41

Server Setup (continued)

Client Profile Define Client characteristics, preferences, assignments, and groupings.

Work Object Editor

Create and modify objects that carry out tasks during a session.

Worklist Editor

Create a sequence of events for a work object.

Session Editor Assign and schedule when work objects execute.

Software Manager

Distribute, install, and manage software for remote users.

Server Operations

Network Status

View current system activity.

Schedule Manager

Display and control the execution of enabled sessions.

Interactive Session

Communicate with Clients in real time.

Session Recovery

Identify Client sessions by completion status and restart failed or missing sessions.

Server Logs Log Viewer Access the Server logs.

Report Manager

Access every log and Server configuration information in a report form.

Messaging Operations


Configure messaging attributes and resources.

Directory Manager

Define user characteristics, Client assignments, and groupings.

Information Management Utilities

Subscriber Editor

Organize and distribute collections of files upon request

Workshop Editor

Develop custom operating environments for Clients.

Inventory Manager

Scan, retrieve, and report essential software and hardware inventory information from RemoteWare Clients.

Table 4. RemoteWare Menu programs (Continued)

Program group Program name Use this program to...


Exiting RemoteWare Menu Close all RemoteWare programs before you exit the RemoteWare Menu.

C H A P T E R

3

Administrator

The Administrator program provides sophisticated system security for your

RemoteWare Server. The Administrator ensures authorized access to each RemoteWare

program based on the Windows user account structure, and simplifies use by providing

only the functions administrators need to perform their duties.


• “RemoteWare security introduction” on page 44

• “Menu commands” on page 45

• “Administrator main window” on page 46

• “Server Control and Options window” on page 54


RemoteWare security introductionAll RemoteWare Server programs have multiple levels of security designed to make administration easier. These levels allow access to authorized individuals and explicitly specify which functions each administrative user or group can perform. This security builds upon the Windows security model, but adds several powerful features that would be difficult or impossible to accomplish using standard file and directory based security.

The Administrator program allows authorized users to view, grant, and deny access to RemoteWare programs. In addition to granting access to Server programs, Administrator can grant access to specific tasks that can be performed by each user for each program. For example, one group may be able to make schedule changes in the Session Editor, but cannot delete sessions. The ability to specify tasks also ensures that the users have exactly what they need to do their job, without extra complexity.

When RemoteWare is first installed, access to all programs is granted to the installing user. In addition, any member of the Administrators group may grant or deny RemoteWare Server program or task permissions to administrative users or groups using Administrator. Changes to user or group permissions are implemented the next time the program is launched.

In addition to the applications and task based security, RemoteWare implements security between Servers and between Servers and Clients. For more information on these types of security, see “Client Profile” on page 123.

M e n u c o m m a n d s 45

Menu commandsThe following table lists the menu commands specific to the Administrator program.

Note: For a list of general menu commands, see “Table 1. Menu commands common to most RemoteWare programs” on page 25.

Table 5. Administrator menu commands


File Server Control and Options

Opens the Server Control and Options window. Use this window to start and stop the RemoteWare Server service, modify command options, modify log file sizes, or view Server-related Windows registry values.Note: For details about this function, see “Server Control and Options window” on page 54.

User Access Grant Permits user access to a RemoteWare program.

Deny Disables all access to applications, but does not delete any existing settings.

Clear Disables access to all applications and deletes any existing settings.

Application Add Adds applications to user or group access list.

Remove Removes the selected application from the group access list and clears rights.

Enable Right/Disable Right

Grants or denies access to the selected right.


Administrator main windowThe main portion of the Administrator window consists of two panes. The tree control in the left pane displays a hierarchical list of the visible domains, the users, and the groups defined by each operating system’s User Manager program.

The right pane displays programs and specific rights granted or denied to the user or group account selected in the left pane. For each selected item, the toolbar menu displays available options. If nothing appears in the right pane, then that user or group has minimal or no access to RemoteWare programs.

Assigned programs and the corresponding application rights are visible in the right pane for the user or group selected in the left pane.

There are several modes available for configuring program access rights. The symbols and items which appear in the left and right panes of Administrator provide information about how rights have been assigned, as illustrated in the following examples. Generally, disabled users and groups possess inactive symbols, while active users and groups display active symbols.

A d m i n i s t r a t o r m a i n w i n d o w 47

Inactive (Disabled) / No programs or rights assigned

An inactive user or user group symbol indicates that the user or group is disabled. Nothing appears in the right pane, therefore programs and rights are not assigned. Prior programs and rights may have been deleted by a Deny and Clear command. No access to RemoteWare programs is allowed.

Inactive (Disabled) / Program and rights assigned

This illustration shows a disabled user with programs and rights displayed in the right pane. Although this user is disabled, application assignments and rights have been preserved. No access to these RemoteWare programs is permitted, but displayed applications and rights may be reinstated by clicking Grant. This option is helpful to configure users and enable them in the future, or to deny access temporarily to RemoteWare Server programs while performing maintenance.

Active (Enabled) / No programs or rights assigned

An active icon indicates that the user or user group is enabled, however in this illustration, no programs or rights are displayed in the right pane. Therefore, no programs or rights are assigned.

Active (Enabled) / Programs and rights assigned

This illustration shows an active user group that has assigned applications and rights. The program is available, and users can perform tasks corresponding to the assigned rights.


Add or remove applicationFor enabled users or groups, you can expand access to RemoteWare Server programs by clicking

Grant (or selecting Grant on the User menu). You can also click Add Application (or select Add on the Application menu) to add a new program to the user or group access list.

If the user or group already has access to a program, adding the application again does not change the current application rights. Adding a new application, however, enables all rights to that application. For a discussion of application rights, see “Applications and rights” on page 50.

To remove access to the selected RemoteWare application, click Remove Application (or select Remove on the Application menu).

Changes to applications and their rights take effect immediately. RemoteWare administrative users experience any access changes the next time they launch the affected program.

The following table lists each application and explains the typical reason for granting access to a user.

Table 6. Applications and reasons for user access

Application Typically assigned to this type of user

Administrator Top level RemoteWare administrator who maintains access and security for the RemoteWare Server systems. Is able to modify user access and alter Server status.

Client Profile Administrator who creates and maintains Client definitions. May create, delete, and modify settings for Clients. Some Operators may need the Able to reset security changes right in the event a Client damages or loses its security token.

Directory Manager Any administrator who needs access to RemoteWare users, including individuals responsible for managing MAPI and RemoteWare Messaging Services.

Interactive Session Administrator requiring direct, on-the-fly communications with Client computers and their file systems. Access allows complete control of any Client and Remote Control of Windows Clients.


Inventory Manager Operators or administrators who need to access information about hardware, software, and file configurations of their Clients.

Log Viewer Operators or administrators who need to view and maintain the Server logs.


Operators or administrators performing synchronization or setting Message Transfer Agent operational parameters.

Network Status Operators who need to view the real-time status of any Server in this system and of communications. May also be allowed to clear minor alarms.

Report Manager Operators and others who need to display system statistics. Change access allows individuals to delete or create custom reports.

Schedule Manager Operators and others who need to display sessions and their status. May also change Scheduler status, abort active sessions, or suspend or execute pending sessions.

Server Profile Administrators who maintain the Server and its resources. May create, delete, and disable resources, change alarm or logging thresholds, or change attributes on a property page. Operators may need the Make Resource Changes right so that they can reset modems from the Server in the event of a resource lockup.

Session Editor Administrators who create and maintain sessions and their schedules.

Session Recovery Administrators and operators who need to identify failed or missing sessions. Optionally may restart failed or missing sessions, if given the right.

Software Manager Administrators and creators of software packages that maintain and distribute software to the Client user base.

Subscriber Editor Administrators and creators of Subscription Lists that need to organize lists of files and publish them to the Client user base.

Work Object Editor Administrators who define tasks and assign objects to sessions, Clients, and users.

Worklist Editor For those who create worklists that can be imported or inserted into work objects.

Workshop Editor Administrators and developers who create and maintain custom user environments for the Client user base.

Table 6. Applications and reasons for user access (Continued)

Application Typically assigned to this type of user


Applications and rightsEach RemoteWare Server program may be assigned to a Windows user or group, permitting administrative users to access the application and administer the RemoteWare system. Specific tasks can be delegated to administrators by granting one or more rights for each program. Initially, the user account that installs RemoteWare has access to the Administrator program and all other programs. Every administrative user or group that needs to access RemoteWare must be granted rights to each program, including users in the Administrators group.

Rights are often interrelated, and placing too many restrictions may not grant the access a user needs to complete tasks. For example, denying the Allowed to make modifications item overrides any other assigned right, and will not allow the user to make any changes.

By default, assigning a program assigns all rights; specific rights within each program must be individually disabled.

When you select a user or group in the Administrator left pane, its available applications are listed in alphabetical order in the right pane. To display the assignable rights for an application, double-click the application in the right pane or click the symbol next to the application name.

Note: To simplify configuration and maintenance, assign applications and rights to local or domain groups, and not to individual users.


See the other chapters in this manual for information about menu commands, facilities, and settings.

The applications and their assignable rights are listed in the following table.

Table 7. RemoteWare application rights

Application Available rights Description

Administrator Allowed to make modifications Able to modify user and group access.

Client Profile Allowed to make modificationsCan create New itemCan copy an existing itemDeleteCan Enable/Disable current itemsMake Assignment changes Make Event Changes Able to reset security changesMake Installation KitModify commentsModify or make general changesMake Client changesMake Server changes

Able to modify settings for existing Clients. (When disabled, overrides other rights.)

Access to the New Client, New Group, and Copy functions.

Access to the Delete command.Able to Enable or Disable a Client.Can add or delete work objects for

Client.Right to modify events within a Work

Object assigned to a clientAccess to the Reset Security command.Access to the Make Installation Kit

command.Can change settings on the Comments,

General, Client, and Server pages.

Directory Manager

Allowed to make modifications Can modify users, groups, and assignments.

Interactive Session

Controls access only.

Inventory Manager


Log Viewer Allowed to make modifications. Can change views and filters.


Allowed to open MAPI address Book settings

Allowed to open MAPI Message Store settings

Change address book file, change the order for displaying names, and add comments.

Change message store password, compact messages, and add comments.

Network Status Allowed to make modifications Able to clear alarms, suspend the Scheduler, and reset transfer statistics.

Report Manager

Allowed to make modifications May copy, delete, and generate reports. Access to the Report Definition functions.


Schedule Manager

Allowed to make modifications Allowed to suspend or resume the Scheduler. May run, suspend, resume, or terminate scheduled or active sessions on any Server.

Server Profile Allowed to make modificationsCan create New item (or copy an

existing item)RenameDeleteCan Enable/Disable current itemsMake Settings changesMake Cluster changesMake Long Distance changes

Make Network Group changesa

Make Resource changesLimit Outbound Connections Make Dial Script changesMake Modem Type changesMake Protocol changesMake Alarm changesMake Logging changesMake Licensing changes

Able to modify settings for existing resources. (When disabled, overrides other rights.)

May use the Copy and New commands, when available.

Can change any resource name.Permanently remove any unassigned

resource.Set a resource’s availability.May change settings on the Settings,

Cluster, Long Distance, Network Groups, Resource, Limit Outbound, Dial Scripts, Modem Types, Logging, and Protocol pages.

Modify alarm thresholds.Update licensing values.

Session Editor Allowed to make modificationsCan create New itemRenameDeleteCan Enable/Disable current itemsMake Schedule changesMake Assignment changesEdit Options

Able to modify settings for existing resources. (When disabled, overrides other rights.)

May create or copy sessions (or copy an existing item).

May change the name of any existing session.

Permanently remove any unassigned session.

Set session availability for the Scheduler.

May change settings on the Schedule, Assignments, and Options pages.

Session Recovery

Allowed to make modifications Ability to restart failed or missing sessions.

Software Manager


Subscriber Editor


Table 7. RemoteWare application rights (Continued)



Work Object Editor

Allowed to make modificationsCan create New item (or copy an

existing item)RenameDeleteCan Enable/Disable current itemsMake Attribute changesMake Event changesMake Assignment changes

May create or copy work objects.May change the work object’s name.Permanently remove unassigned work

objects.Able to set work object availability for

Sessions and Clients.May change settings on the General

Attributes, Events, Sessions, Clients, and Parents pages.

Worklist Editor Controls access only.

Workshop Editor


a. Network group “Default” is protected and not eligible for editing.

Table 7. RemoteWare application rights (Continued)



Server Control and Options windowThe Server Control and Options features enable you to view and modify critical Server functions and values. Open the File menu and select Server Control and Options to open the Server Control and Options windows. The window includes the following property pages:

• System Control

• Command Options

• Log Files

• Registry Settings

• Data Sources

• Scheduler Control

S e r v e r C o n t r o l a n d O p t i o n s w i n d o w 55

System Control property page

To display this page, click the System Control tab.

Use the System Control property page to display the Windows service information for RemoteWare and to start or stop a selected Server. Functions on this page consolidate those available in Control Panel Services for each Server in your cluster.

The list box displays each Server on a separate line. The list box provides the following:

• Type. Indicates whether this service is a Server or a Workstation.

• Name. Displays the Local Server Name set from the Network Settings icon in Control Panel.

• Service Name. Displays the name used in the Services icon in Control Panel.

• Service Status. Indicates the Server’s state. Status may be Running, Stopped, or System Unavailable.

The Server Control and Options feature for starting a local RemoteWare Server is only applicable to remote Servers and Workstations in a RemoteWare cluster.

When you select any Server in the list box, the Start and Stop buttons control the state of the Server and change the Service Status value. Changing the Server status from these Start and Stop buttons terminates the Administrator program. To continue working with the program or to view results, you can restart Administrator from the Windows Start menu. Point to RemoteWare Server, and then select RemoteWare Administrator. Alternatively, you can double-click Rwadmin.exe in the Server’s \System directory.

Note: Stopping a Server may interrupt communications sessions or lose scheduling data. You should first stop the Scheduler and verify no external processes are dependent on the RemoteWare Server service before using the Stop button.


Command Options property pageTo display this property page, click the Command Options tab.

The Command Options page displays the programs and associated command options for major RemoteWare subsystems. Each subsystem appears on a separate line in the list box.

The following attributes appear for each item in the list box:

• Program. Displays the name of the RemoteWare subsystem. This is not necessarily the name of the program or executable file.

• Command Line. Displays options or command line switches associated with the program. These are the same options you enter on a command line when starting the program.

Options are applied only when the local RemoteWare Server service is not in a Running status. Set the options by selecting the program line and clicking Modify, or by double-clicking the item. The program displays its Options window. For information about the Options windows for an ECF Server, see “ECF Server Options dialog box” on page 57. For details about an Execution Server’s Options window, see “Execution Server Options dialog box” on page 58.


ECF Server Options dialog boxThe External Configuration File (ECF) Server interprets specially formatted text files (ECF files) and performs many of the commands available in the RemoteWare Server user interface. This system is especially powerful when linked with external systems (such as minicomputers, Clients, and custom applications) which can submit ECFs to automatically control or modify RemoteWare Server behavior.

To change the operating parameters for the ECF Server, use the ECF Server Options dialog box. You access this dialog box from the Command Options page in the Server and Control options window. On the Command Options page, double-click an ECF Server item, or select the item and click Modify.

In the ECF Server Options dialog box, you can modify the following parameters:

• Serialize Between Clustered Servers. Serializing Servers prevents two or more ECFs from trying to simultaneously modify items on the Server. If you clear this option, one ECF would fail when it tries to access an item that is in use. This option has no effect when run on a stand-alone Server.

• Quiet Mode, No Messages Logged To Server Log. Processing a large amount of ECFs tends to fill the Server Log. Select this check box to prevent ECF related messages from appearing in the Server Log.

• Use A Custom Update Time. By default, the ECF Server checks for pending ECFs every 60 seconds. To process files more or less frequently, select this check box and use the spin box to specify a new time in seconds. Times may be set from 10 to 3600 seconds (1 hour).

• Use A Custom ECF Data File Directory. By default, the ECF Server looks for ECF files in the \ECF directory on the Server’s data drive. To change this directory, select this check box and specify the path and directory name for the new directory. The system assumes the Server data drive (that is, <ServerData>\) if no explicit volume or path name is given.

For information about ECFs, see “External Configuration Files” on page 573.

Note: The Modify command is available only when the local RemoteWare Server service is not running.


Execution Server Options dialog boxThe Execution Server is a RemoteWare subsystem that processes EXECUTE and NOTIFY commands on the RemoteWare Server. This subsystem allows these events to reach beyond the local machine and may access other clustered Servers or other computers on the LAN.

To change the operating parameters for the Execution Server, use the Execution Server Options dialog box. You access this dialog box from the Command Options page in the Server and Control options window. On the Command Options page, double-click an Execution Server item, or select the item and click Modify.

You can set the following options in the Execution Server Options dialog box:

• Serialize Between Clustered Servers. Serializing prevents two or more Execution Server processes from modifying items on the Server at the same time. Select this check box to allow an Execution Server to wait if it tries to access an item that is in use. This option has no effect when run on a stand-alone Server.

• Specify Maximum Number of Concurrent Processes. By default, the Execution Server has a maximum of two (2) concurrent processes. Select this check box to change this value from 1 to 20 maximum concurrent processes.

Note: The Modify command is available only when the local RemoteWare Server service is not running.


Log Files property pageTo display the Log property page, click the Log Files tab.

For more information about configuring the logs, see “Log maintenance process” on page 636.

Use the Log Files page to view or change the number of entries for any RemoteWare log file. Log file sizes are set during RemoteWare installation.

Each log and its associated information appears on a separate line in the list box1. For each log file, the list box provides the following:

• Description. Indicates the commonly used name for this log file.

• Log Table. Displays the name of the log table that contains the log file records.

• Threshold (recs). Displays the maximum number of entries currently allocated to this log file. This value ranges from 100 to the Max Threshold value. Logs discard the oldest entries once the current number of entries have been used. Use the Modify button to change the current size. Changing the size of a log erases any existing log entries.

• Max Threshold (recs). Lists maximum number of entries allowed for this log file.

• Modify. Displays the Log File Setup dialog box, where you can change the number of entries in one or more of the log files. You can also use this dialog box to delete all information in the file. For details, see “Log File Setup dialog box” on page 60.

Before modifying a log file’s current size, you must stop all RemoteWare Server services that access the selected log. If the Modify button is unavailable, go to the System Control page and verify all Server services are off. Changing the Server status from these Start and Stop buttons terminates the Administrator program. To restart Administrator, double-click Rwadmin.exe in the Server’s \System directory.

1. The values that you define for the Session History Log are simultaneously appliedto the File Transfer Log and the Multicast Log.


Log File Setup dialog boxThe Log File Setup dialog box appears when you click Modify on the Log Files page (Server Control and Options dialog box). Use the Log File Setup dialog box to change the number of current entries in a specific log file, or to delete all the entries in a log.

The Log File Setup dialog box includes:

• Minimum. Displays the smallest possible number of records in the log file.

• Maximum. Displays the largest possible number of records in the log file.

• Number of Records. Displays the number of records in the log; the value originates from the Current Size column on the Log Files page. To change the current value, type the new value in this field. The modified number of records is not applied until the Log Maintenance session is executed.

• Overwrite all entries in the selected log table. Select this check box to delete all entries for the selected log file.

Note: The Log File Setup dialog box is not available until all RemoteWare Server services have been stopped. If the Modify button is unavailable, go to the System Control page and verify that all Server services are off.

Important: The oldest records in the selected log are deleted when you change the log size or Number of Records.

If the database, for example, has 90,000 records, and you want to back up the database to hold only 50,000 records, the oldest 40,000 records will be deleted.


Registry Settings property pageTo display this page, click the Registry Settings tab.

Use the Registry Settings page to view RemoteWare-related settings in the Registry Editor. Each Registry setting appears on a separate line in the list box. The Registry Settings page contains the following information and controls:

• System. Displays the RemoteWare Server name. The Registry variable names and values that appear in the list box are associated with this Server.

• Select System. Click this button to select another clustered Server. Stand-alone Servers display only one choice in the Select Server window.

• Name. Displays the Server’s data path, its execution path, and the Server name. These values represent system defined variables that are used throughout your worklists. For more information on variables, see “Events” on page 441.

• Value. Provides the information associated with the Name field.


Data Sources property pageClick the Data Sources tab to display this page.

Use the Data Sources page to view database message logs and scheduler/server data information for major RemoteWare subsystems. Each subsystem appears on a separate line in the list box.


• Subsystem. Displays the name of the subsystem message log.

• SQL Server. Displays the SQL server name.

• Database. Displays the database name.

• Login. Displays the name used to login to the SQL database.

• Modify. Displays the Datasource dialog box where you can change the SQL server login and password for the selected log.

Before modifying SQL server login information, you must stop all RemoteWare Server services that access the selected log. If the Modify button is unavailable, go to the System Control page and verify all Server services are off. Changing the Server status from these Start and Stop buttons terminates the Administrator program. To restart Administrator, double-click Rwadmin.exe in the Server’s \System directory.


Datasource dialog boxClick Modify on the Data Sources page to view the Datasource dialog box. Use the Datasource dialog box to view SQL server and database names and select whether to use Windows authentication or SQL server login and password information.

The Datasource dialog box includes:

SQL Server. Displays the SQL server name.

Database. Displays the SQL server database name.

Use Windows Authentication. Activates Windows authentication for accessing SQL server. Select this check box to allow Windows authentication to access the SQL database. This check box is not available for all subsystems listed.

SQL Server Login. Allows you to change the SQL server login name.

Password/Confirm Password. Allows you to change the SQL server password.

Note: The Datasource dialog box is not available until all RemoteWare Server services have been stopped. If the Modify button is unavailable, go to the System Control page and verify that all Server services are off.


Scheduler Control property pageClick the Scheduler Control tab to display this page.

Use the Scheduler Control page to view and control Scheduler states for all Servers in your cluster.


• Name — Server name.

• Suspend Scheduler on Restart — Indicates whether the Server’s Scheduler is planned to enter a suspended state upon its next and subsequent restarts.

Scheduler state controlsUse the following controls to manage Scheduler states after a Server’s next and subsequent restarts. A Scheduler’s current state, on or off, is not impacted by these commands.

• Suspend on restart — Stops the Scheduler from processing new sessions on the selected Server after the next and any subsequent restarts until the Resume on restart command is invoked.

• Resume on restart — Reactivates the Scheduler on the selected Server after the next and any subsequent restarts.

• Suspend all on restart — Stops the Scheduler from processing new sessions on all clustered Servers after the next and any subsequent restarts until the Resume all on restart command is invoked.

• Resume all on restart — Stops the Scheduler from processing new sessions on all clustered Server after the next and any subsequent restarts.

C H A P T E R

4

Server Profile

Use the Server Profile program to configure the RemoteWare Server and associated

clustered Servers and Workstations.


• “Server Profile at a glance” on page 66


• “Property pages” on page 70


Server Profile at a glanceServer Profile consists of the property pages listed in the following table. These property pages enable you to configure global system settings, define the resources used during communications between the Server and Clients, modify and monitor communication resources, set alarms, configure logs, and view and update licensing.

Using Server Profile, the administrator can configure the Server’s attributes, the status of other Servers in this cluster (if applicable), long distance services, communication, connection, and network resources, dial scripts, modem profiles, protocol settings, alarm and logging thresholds, and licensing values.

Server Profile is available in the RemoteWare Menu, where it appears in the All Utilities and Server Setup groups.

Note: The property pages available are determined by the components for which you are licensed.

Table 8. Server Profile property pages

Property page Description Details on page

Information Display system information, including serial number, version number, release date, and number of licensed and defined sessions and Clients.

70

Settings View and modify system-wide values, such as system name and time, connection behavior, and compression options across all Clients.

72

Cluster Display the operational status of every Server and Workstation in the network, and configure Servers for Inbound only or Inbound/Outbound operation.

75

Long Distance List and build dialing strings for asynchronous connections using dialing prefixes, account codes, and scripting. These services are used on the Resources page and on the Server page in Client Profile.

77

Network Groups Create, modify, enable, disable, and delete Network Groups. Network Groups are collections of Clients that can be associated with Port Groups to manage port usage by various resources.

80

S e r v e r P r o f i l e a t a g l a n c e 67

Resources Define and configure connection resources on local or clustered Servers. Resources include internal (process only), asynchronous, and network devices. Create Port Groups and assign them to Network Groups. Assign protocols to resources through the Protocol page and to Clients via the Server page in Client Profile.

81

Limit Outbound Limit the number of outbound connections (Async, NetBIOS, SPX, and/or TCP/IP) that can occur within a certain period of time.

96

Dial Scripts Build a sequence of events to assist a Server or Client connection. Assign scripts to connection resources via the Long Distance page or to a Client using the Client page in Client Profile.

97

Modem Types View and define data rates, result codes, and command strings that interface with asynchronous devices. Use modem configurations on the Resources page for the Server, and on the Client page in Client Profile for the Client’s modem choices.

102

Protocol Define the packet level values, compression, and timing parameters for any connection transport. Protocol resources allow optimum transfer efficiency for any transport mechanism. Assign protocols to resources through the Protocol page and to Clients via the Server page in Client Profile.

109

Alarms Set and display thresholds for storage and connection related events. Exceeding a threshold logs a warning to the Server Log, displays alerts in the Network Status, or disables a faulty connection.

113

Logging Select the level of session and file level logging detail necessary for your needs. Settings affect the Session History log and File Transfer log.

115

Licensing View current licensing, update the licensing of any component, or view the log of license modifications for this Server configuration.

118

Portable Security

Add, modify and delete Portable Security users, limiting Portable Interactive Sessions to Clients where login is now required.

120

Table 8. Server Profile property pages (Continued)



Menu commands Commands marked with an * asterisk are also available from a shortcut menu.

The menu commands specific to Server Profile are listed below.


Table 9. Server Profile menu commands

Menu Command Button Is available on page(s)

Description

File New Long DistanceNetwork GroupsResourcesDial ScriptsModem TypesProtocol

Creates a new item.

*Copy Long DistanceResourcesDial ScriptsModem TypesProtocol

Duplicates an existing item’s configuration under a different name.

*Delete Long DistanceNetwork GroupsResourcesDial ScriptsModem TypesProtocol

Permanently removes this item and its settings. Assignable items cannot be removed until they are completely unassigned.

*Rename Long DistanceNetwork GroupsModem TypesProtocol

Changes the item’s name or description.

*Update Long DistanceResourcesDial ScriptsModem TypesProtocolLicensing

Changes or displays the item’s settings.


Command *Enable Long DistanceNetwork GroupsResources

Makes this item available to other resources.

Command *Disable Long DistanceNetwork GroupsResources

Prevents this item from being used. The item’s configuration is not altered while it is disabled.

Inbound Only

Cluster Configures a Server to only accept (but not initiate) connections.

Inbound/Outbound

Cluster Configures a Server to initiate and accept connections.

View License Log

Licensing Lists changes to the licensing values by action and date.

View Other Server Resources

Resources Displays resource devices and their configurations on other clustered Servers. (Only available on clustered Servers.)

Pages ... All Displays the selected property page.

Table 9. Server Profile menu commands (Continued)


Description


Property pagesThe following topics provide information about the Server Profile property pages.

Information property pageIn Server Profile, to display the Information property page click the Information tab; alternatively, you can select Information on the Pages menu. Use the Information page to display registration information and communication resource usage. The following sections describe the various items on the Information page.

System InformationUnder System Information, you can view the Server’s serial number that has been licensed to you, the system data disk where your RemoteWare data files reside, and the version number of the RemoteWare software you have installed.

• Server Serial Number. This number corresponds to the license number stamped on the licensing installation disk. Serial numbers are unique to your Server installation, but are the same across clusters and Workstations.

• System Data Path. The drive and optional directory path indicates the directory that contains the Server data directory structures. This path should be identical for multiple Servers in a cluster.

P r o p e r t y p a g e s 71

• Version Number. Indicates the latest release of software installed on this system.

SessionsUnder Sessions, you can view the Concurrent, Defined, and Enabled numbers of communications sessions on your system.

• Concurrent. Shows the maximum number of simultaneous sessions that may be actively processed on your Server. This limit is set by the Server’s model. Additional Servers can be added in a cluster configuration for additional concurrent sessions and communication redundancy.

• Defined. Displays the number of defined sessions available in the Session Editor. The initial value is one (1), indicating the Sample Session that is defined when you first install your Server. You can define a maximum of 8,000 sessions.

• Enabled. Displays the number of defined sessions that have been enabled in the Session Editor. You can enable as many sessions as you define.

Local Server NameThe Local Server Name is used to associate this individual Server with other Servers (clustered or nonclustered) on the network. The name is automatically set at each Server startup from the Windows Computer Name in Control Panel Network. Each Local Server Name must be unique to your system, and can be up to fifteen (15) characters long.

The Local Server names for all Servers appear on the Cluster page. You can modify the Local Server name in Control Panel Network.

ClientsThe Clients area displays Maximum, Defined, and Enabled Client counts for the RemoteWare system. These numbers are also displayed on the List page in Client Profile.

• Maximum. Displays the maximum number of Clients you can define based on your Server’s licensing. This value can range from 1 to approximately 17,000 Clients, and can be modified on the Licensing page or via the installation program.

• Defined. Shows the total Clients created in Client Profile, including disabled Clients. This value does not contain deleted Clients and can range up to the number listed in the Maximum value.

• Enabled. Displays the number of enabled Clients in the Client Profile program.


Settings property pageIn Server Profile, to display the Settings property page click the Settings tab; alternatively, you can select Settings from the Pages menu. Use the Settings page to set systemwide Server, Client, and Communications settings.

SystemUse the System area to specify the System Name and the Date/Time for the RemoteWare Server.

• Name. Type up to 31 characters in this field. The System Name is the same for all Servers and Workstations clustered on a network; modifying the name changes it for all clustered Servers. The System Name is associated with the Serial Number to uniquely identify this Server network to other Servers and Clients. All Servers in a cluster have the same serial number and System Name.

Note: System Name is not necessarily the same as the Local Server Name displayed at the top of this page, the Information page, and the Cluster page. The Local Server Name defines an individual Server and its computer to other Servers in the cluster.


• Date/Time. To set the Date/Time, click the button displaying the current date and time. The Enter Date and Time dialog box appears. Select the portion of the date or time you want to change, and then either type the new value or use the spin boxes to set the new value.

Maintain Dial Connection

When this feature is active, connections are maintained across all communication transports.

By default, connections to Clients are maintained until all active and blocked sessions in the queue are processed for that Client. This helps to reduce processing time and connect costs by eliminating the need for separate calls for each session.

For accounting or other reasons, your site may require a separate connection for all sessions or for those below a designated session priority. In the Maintain Dial Connection area, select one of the following options that best meets your needs:

• Always. This default setting does not drop the connection if another session is waiting to access the Client, regardless of other sessions or priorities in the Schedule Manager queue.

• Never. Instructs the Server to disconnect and reconnect for each scheduled session, regardless of priority or position in the scheduled queue.

• For sessions with priority greater than or equal to. The Server does not disconnect and reconnect between active sessions above a set priority. Priorities are originally set for each session on the Schedule page in the Session Editor, and may range from 0 (lowest) to 9 (highest). For information about setting session priority, see “Schedule property page” on page 230.

Use the spin box to set the minimum priority which should maintain a dial connection. For example, select this option and set the priority to 4. Sessions with priorities 0 through 3 require separate connections, while sessions with priorities from 4 to 9 are processed in one connection, starting with priority 9 sessions first.

Important: Suspend the Scheduler (from Schedule Manager) before modifying the date or time. Failure to do so may cause pending sessions to execute at the wrong time, or not at all. Turn on the Scheduler after you have set the new date and time.

Note: Clustered Servers and Workstations cannot use Date/Time. To synchronize multiple system clocks, run the Windows net time command from a command line.


For all Clients, enableThe options in this area override the settings on all enabled Clients, regardless of the settings specified in Client Profile, Work Object Editor, or Session Editor. All options are initially enabled when you install the Server:

• ESD. When this check box is selected, all ESD work objects execute as defined on the work object, session, or Client level. Clearing this option prevents all ESD work objects from executing.

• Applications. Selecting this check box allows all Application work objects to execute as defined. Clear this option to inhibit the execution of any Application work objects, regardless of their settings.

• Compression. All file transfers to and from Clients are compressed when this check box is selected. This option controls compression throughout the system.

Clear the check box to disable compression for all Clients, regardless of other settings. Letting the modems perform compression, or transferring previously compressed data are other reasons for disabling compression.

• Extensions Not To Compress. Under Extensions Not To Compress, you can designate which files are not to be compressed based on their extensions. By not compressing files with specific extensions (such as .zip or .exe files), you avoid the additional processor load, duplication of effort, and sometimes larger files when trying to compress the data more than once.

To add an extension to the list, type it without the separator (for example, exe) in the text box and click Add. The extension appears in alphabetical order in the list box. To remove an extension from the list, select it in the list box and click Delete.


Cluster property pageRemoteWare provides the ability to link two to five RemoteWare Servers into a cluster. Each Server machine uses the same data path. By setting up a cluster, you can increase the number of available communication resources. A cluster also provides fault tolerance for your system. If the primary Server goes down, you can use another RemoteWare Server in the cluster. For information about setting up and tuning a cluster, see the RemoteWare Installation Guide and the RemoteWare Server Administrator’s Guide.

Use the Cluster page to view every RemoteWare Server’s statistics and set the local Server’s name or communications type. In Server Profile, to display the Cluster property page click the Cluster tab; alternatively, you can select Cluster from the Pages menu.

The list box displays each Server on a separate line. If your site has one Server, or if each Server is stand-alone, then there will only be one entry in this list box. Otherwise, clustered Servers should be listed. For each Server, the following information appears:

• Name. Displays the Local Server Name unique to each Server in your network. Each Local Server Name should match its Windows Computer Name.

• Status. Indicates which Servers are Enabled or Disabled. To enable or disable a clustered Server, select Enable or Disable on the Command menu.

Note: It is not possible to disable a stand-alone Server, since at least one Server must be enabled at all times. Disabled Servers are only possible within a RemoteWare cluster.


• State. Indicates whether the Server is Running or Down. The running state is required (in conjunction with an Enabled status) for a functional Server. A down state may indicate a problem with the Server service, that processes are still starting up, or that one or more key processes are missing. The Server Log contains information about a Server with a Down state.

• Type. Displays In/Out (Inbound/Outbound) or Inbound only. For more information on these Server types, see “Server types” on page 76.

• Time Up. Displays the elapsed time (in days, hours, and minutes) since the Server service was last activated. Activation usually coincides with a computer shutdown or restart, or can occur by stopping and starting the RemoteWare Server service.

Server typesServers can be set to accept or initiate connections depending on your configurations and connection requirements.

A default Server operates in the In/Out communications mode. In/Out permits the Server to place and accept calls as they occur. Any stand-alone or clustered Server can be set up as Inbound Only, where the Server only accepts calls but never initiates a connection.

To specify an Inbound Server, select Command Inbound Only on the Cluster page. Select Command Inbound/Outbound to switch from the Inbound Only mode to In/Out. Changes to the Server type take effect when the RemoteWare Server service is restarted.

Inbound Servers behave as stand-alone Servers, and they maintain separate schedules from the clustered Servers. As a result, Inbound only Servers cannot use or view other Server resources or perform load balancing like In/Out type Servers. Other Servers cannot access the Inbound Server, and if an Inbound Server should fail, there is no automatic method for the clustered Servers to detect the failure and recover the partially completed sessions as with a clustered configuration.


Long Distance property pageLong Distance Services are dialing strings or scripts that the Server uses to place an outbound call to a Client. The Long Distance property page simplifies the connection procedure for PBXs, long distance services, packet networks, and other service providers by providing a means of attaching additional information or actions to the connection sequence. The entries you define can contain actions defined in a dial script on the Dial Scripts page, or any sequence of numbers, characters and placeholders (such as the <Phone #> variable).

To access the Long Distance page, click the Long Distance tab or select Pages Long Distance.

The list box displays each Long Distance Service on a separate line. These services are available to every clustered Server in your RemoteWare system. For each Long Distance Service, the following information appears:

• Name. You specify the Long Distance Service name when you create the service (by selecting New or Copy on the File menu) or rename it (by selecting Rename or Update on the File menu). You can assign this Long Distance Service to asynchronous Server resources on the Resources page, and to Clients on the Server page in Client Profile.

• Status. Indicates whether the Service is Enabled or Disabled. Change the status by selecting the entry; on the Command menu, click Disable or Enable. You can also double-click the entry to display the Long Distance Service Detail dialog box. Select or clear the Enable this Service check box. (For more information about this dialog box, see “Long Distance Service Detail dialog box” on page 78.)


• Dial String/@Dial Script. Displays the entire dial string, or the dial script name defined on the Dial Scripts page. For more information, see “Dial Scripts property page” on page 97.

Long Distance Service Detail dialog boxThe Long Distance Service Detail dialog box appears when you:

• create a new Long Distance Service; • assign a dial script; • double-click an existing service; or • click New, Copy, Rename, or Update

on the File menu.Use this dialog box to set up Long Distance Services and assign dial strings or dial scripts to them. You can also use the dialog box to enable or disable the Long Distance Service selected on the Long Distance property page. Items in this dialog box include:

• Name. In the text box provided, type the name of the Long Distance Service. The name can include up to 20 characters and appears on the Resources page and the Server page in Client Profile.

• Dial String. To use a dial string, select this option. In the text box, type additional numbers and special characters before and after the <Phone #> variable to define prefixes, carrier codes, accounts, and special actions. By default, the string uses the <Phone #> variable so that it can be used to initiate a call to multiple Clients. The dial string can contain up to 80 characters.


The following table defines the characters reserved for special actions.

• Dial Script. To use a dial script, click this option and select a dial script from the drop-down list. The list displays all the dial scripts which have already been defined on the Dial Scripts page. If no dial scripts have been defined on the Dial Scripts page, the option and its associated controls are unavailable.

For more information about the Dial Script Editor, see “Dial Scripts property page” on page 97.

• Edit. Click this button to open the Dial Script Editor, where you can compile or make changes to the selected dial script. The Edit button is unavailable if there are no defined dial scripts on the Dial Scripts property page.

• Enable this Service. Select this check box to enable the selected Long Distance Service. The service does not appear on other pages and programs if it is disabled.

Table 10. Dial string special action characters

Character Description

! (exclamation mark) Inserts a carriage return in the dial string. Instructs the asynchronous device to begin processing the dial string up to

the exclamation mark.

, (comma) The comma inserts a 2 second (default) pause. This duration varies depending on the modem configuration.

Note: Dial strings cannot be used to transmit alphabetic characters or complicated connection sequences. Use the Dial Script facility to set up connection procedures.


Network Groups property page For information about Port Groups, see “Resources property page” on page 81.

Use the Network Groups page to create, rename, enable, disable, and delete Network Groups, which are collections of Clients that you can associate with Port Groups. Network Groups and Port Groups work together to manage the number and priority of outbound connections over individual IP ports.

To view the Network Groups page, click the Network Groups tab; you can also select Network Groups from the Pages menu.

Columns on this page include:

• Name. Lists the name of each Network Group. One Network Group named “Default” is provided for you; you cannot modify or delete this group.

• Enabled. Indicates whether the group is available or unavailable for use.

After you create a Network Group, you can assign individual Clients to it on the Server page in Client Profile. For details, see page 142.

You can create up to 64 Network Groups per RemoteWare Server, which is the maximum number of concurrent sessions. Each Server in a cluster can have up to 64 Network Groups.

When you create or edit a Network Group, the Network Group Details dialog box appears.

In the Name field, specify a name for the selected group. By default, the Network Group is enabled. However, you can select the Disabled option to make the selected Network Group unavailable to other resources.


Resources property pageUse the Resources page to define and configure resources for any Server in your RemoteWare system. A resource is any virtual or physical network connection to the Server that is used to communicate with Clients on the LAN or over an asynchronous line. To view the Resources page, click the Resources tab; you can also select Resources from the Pages menu.

The Resources for RemoteWare Server field at the bottom of the property page indicates which Server’s resources are displayed in the list box. This name will be different if you are viewing another Server’s resources in the same cluster.

For an overview of the resource types, see “Resource overview” on page 82.

The list includes each asynchronous resource or available LAN transports on a separate line. For each active resource, the list box displays the following information:

• Port #. The Port number is assigned automatically to async resources and used exclusively by RemoteWare. It is referenced in the Port# field in Network Status, the Rsc/Port field in Session Log, and the Matching ASYNC ports in the Schedule Manager. For network resources (TCP/IP, SPX, NetBIOS), this column lists the next assigned IP group number.

• Device. Indicates the physical device on the computer used as a communications or networking resource. RemoteWare recognizes the following resource types:

• NetBIOS

• Process Only

• Multicast

• COM


• SPX

• TCP/IP

“n” represents the COM port in the case of COMn, and the number of active resources for all other resource types.

For information about the Async Resource Detail dialog box, see “Async Resource Detail dialog box” on page 84.

• Max bps. (Asynchronous resources only) Indicates the maximum outbound data rate in bits per second (bps) for this resource. This value originates from the modem you select and is set in the Async Resource Detail dialog box.

• Status. Either Enabled or Disabled, the status indicates whether the resource is available for use. Select Command Enable to make a resource available. See the Server Log if a resource unexpectedly switches to a disabled state.

• Usage. Indicates whether the resource is available to initiate an outbound call or accept an inbound call from a Client.

• Client. (Asynchronous resources only) A Client name appears in this field only if the Modem Type is DIRECT CONNECT. A Client name must be chosen when connected via serial cable to an asynchronous resource.

• Modem Type. (Asynchronous resources only) Displays the modem name and parameters assigned to this serial port. The modem name originates from the Modem Types property page; for details, see “Modem Types property page” on page 102.

Resource overviewUse the resources displayed on the Resources page to communicate with Clients, the Server computer, and other computers in the LAN. The type of resources available depend upon the protocols installed in your Windows environment and the physical devices present on the computer. The following table lists the resource types available in the RemoteWare system.

Table 11. Resource types

Resource type Device designation Description

Asynchronous COM(n) Serial protocols (generally RS-232) using one or more modems to communicate over telephone lines.

NetBIOS NETBIOS(n) Network Basic Input Output System allows LAN- based Clients to communicate via Window’s NetBIOS Interface software.

Process Only PROCESS ONLY(n) A RemoteWare-only resource that allows sessions to perform tasks on the Server computer or other accessible LAN-based computers.


Each of the commands in Table 14 is also available on a shortcut menu. To use the shortcut menu, right-click the item.

You can add, delete, or modify resources using the dialog boxes in the following table.

SPX SPX(n) The Sequenced Packet Exchange protocol is Novell NetWare’s service. Using Window’s NWLink IPX/SPX Compatible Transport, LAN-based Clients can communicate with the Server.

TCP/IP TCP/IP(n) Transmission Control Protocol/Internet Protocol permits connections across most computer platforms and network topologies. In the Windows environment, use the TCP/IP Protocol software to activate this resource.

Multicast Multicast (n) Multicast transport protocol allows for transferring files to multiple Clients during one optimized session.

Table 11. Resource types (Continued)

Resource type Device designation Description

Table 12. Using resources

To Do this See dialog box & section

Add async resources Select File New. “Async Resource Detail dialog box”

Add other resources Double-click resource, or select resource and then select File Update.

“NetBIOS Detail dialog box”“PROCESS ONLY Detail dialog box”“TCP/IP Detail dialog box”“SPX Detail dialog box”

Copy async resources Select resource; then select File Copy.

“Async Resource Detail dialog box”

Modify (update) any resource

Double-click resource, or select resource and then select File Update.

“Async Resource Detail dialog box”“NetBIOS Detail dialog box”“PROCESS ONLY Detail dialog box”“TCP/IP Detail dialog box”“SPX Detail dialog box”

Delete async resources Select resource; then select File Delete.

Disable resources Select resource; then select Command Disable.


Async Resource Detail dialog box

If your RemoteWare Server has trouble acquiring an async resource, another program (such as Hyperterminal) or service (such as the Remote Access Connection Manager) may have started before the Server service. To resolve this issue, stop the non-RemoteWare program, start the RemoteWare service, and restart the other program.

Use this dialog box to set up asynchronous serial ports for the first time, or to modify asynchronous resources once they are defined. You can define up to 64 asynchronous resources. This dialog box appears when you do the following:

• Create new asynchronous serial ports.

• Define a new asynchronous resource based on an existing asynchronous resource.

• Modify existing asynchronous serial ports (device name of COMn, where n is a number).

The Async Resource Detail dialog box includes:

• Port Number. Displays the next available RemoteWare port or the port assigned to an existing asynchronous resource. When you create or copy a resource the available port numbers display. If you modify an existing resource only the port number displays.

The Network Status refers to the port number in the Resources tree list, and Schedule Manager uses the port number in the Matching ASYNC ports field on the General page of the Details for Session dialog box. For details, see “Details for Session window” on page 254.

• Device. Shows the currently assigned physical asynchronous (COM) port for existing resources, or the next available port for new resources. Click the arrow to choose another COM port. Your Windows environment and communication hardware (for example, multichannel communication cards) determine which resources are available.

Enable resources Select resource; then select Command Enable.

Table 12. Using resources (Continued)

To Do this See dialog box & section


For details about the Edit Modem dialog box, see “Modem Types property page” on page 102.

• Max Data Rate. Displays the maximum outbound rate for the modem in bits per second (bps). This is the rate the Server modem uses to connect to a Client. Max Data Rate determines its default value from the Maximum Data Rate field on the Settings page of the Edit Modem dialog box. To change the value, click the arrow and select a new data rate from the list. The Max Data Rate value also sets the maximum setting for the Inbound Data Rate.

For a Direct Connect Async connection, the Data Rate setting for the Server’s Async resource must match the Data Rate of the Async resource defined for the Client.

• Inbound Data Rate. The Server modem attached to this device uses the Inbound Data Rate to “listen” for a Client calling the Server. It is only used for ports accepting inbound calls. This value is initially set to the Max Data Rate value, and should be set to the maximum speed used by the majority of your Clients’ modems.

To modify modem settings directly from the Select Modem dialog box, click Item Detail. For more information, see “Select Modem window” on page 87.

• Modem Type. Displays the modem name (or DIRECT CONNECT) from the Modem Types page. The name establishes the default data rates and the Direct Connect Client based on the characteristics set from the Modem Types page.

To change the modem type, click the button to display the Select Modem dialog box. Or, if the modem type is DIRECT CONNECT, then the Select Client dialog box appears. DIRECT CONNECT requires a Client name to be specified for the Direct Connect Client field.

• Direct Connect Client. (Available only when the Modem Type is DIRECT CONNECT.) Displays the Client with which the device expects to communicate. Click this button to choose a Client. If the Client has not been defined in Client Profile, then return to this dialog box to select the Client once it has been defined.

• Port Phone Number. Enter the telephone number (up to 32 numbers) associated with this port. A list of Port Phone Number values appears in the Server Phone Numbers area on the Client page in Client Profile; for details, see “Client property page” on page 137. This is the number a Client calls when attempting to connect with the Server. Remember to fully qualify the phone number; enter country codes, area codes, and any other information needed by the Client to access the Server. This field is unavailable if the modem type is DIRECT CONNECT.

Note: Setting a correct matching inbound rate minimizes the negotiation time needed between the Server and Client modems. Connection data rates for the inbound caller may be adjustable (also called autobaud) if the modem has this feature and if flow control is turned off on the Command Strings page in the Edit Modem dialog box. Flow control disables autobaud and uses a constant speed between the modem and the serial port.

Note: The modem types originally installed with your system have been configured and tested for RemoteWare. If your modem is not in this list, contact your RemoteWare support provider to determine if a customized definition already exists.


• Status. Indicates whether the port is enabled or disabled; it is enabled by default. To enable or disable the resource, select or clear the Enable Port check box. Enabled resources make the port available for communication; disabled ports are not accessible by Clients or the Server.

• Usage. Indicates whether the port can send or receive calls, or both. Select the Outbound and Inbound check boxes to specify whether this port can originate and accept calls, respectively. By default, the Outbound check box is selected. Selecting both check boxes makes the resource available for both inbound and outbound communication.

• Port Priority. Reserves the port for sessions whose priorities match or exceed this value. If you want a port dedicated to Outbound communications, keep the Outbound check box, and clear the Inbound check box. The default is zero (0); nine (9) is the highest priority. For example, a Port Priority setting of 7 permits sessions with priorities of 7, 8, or 9 to use the resource. You can assign priorities to sessions on the Schedule page in the Session Editor program; for details, see “Schedule property page” on page 230.

• Long Distance Service. Assign one or more Long Distance services to this asynchronous resource. The Server can use this resource to originate outbound calls to Clients that also have the same long distance resource assigned to it. This area and its controls are unavailable if the Modem Type is DIRECT CONNECT.

The Defined list box (on the right) contains enabled Long Distance services which are defined on the Long Distance page. The Assigned to Port list box (on the left) lists the Long Distance services this resource can use when matching the resource to the session characteristics.

To assign one or more Long Distance services to this resource, select the entries in the Defined list box and click Assign. To remove one or more Long Distance services from this resource, select the entries in the Assigned to Port list box and click Unassign.

Note: Port Priority is ignored for Inbound only resources. Inbound communications always has the highest priority.


Select Modem window


The Select Modem window appears when you click the Modem Type button in the Async Resource Detail dialog box. Use the Select Modem window to choose an existing modem definition for the asynchronous resource. This modem definition should correspond to the modem on the selected port.

The list box displays all the modem names defined on the Modem Types page. (For more information, see “Modem Types property page” on page 102.) In addition to the list box, the following controls are available:

• Search/Select. Use the Search/Select text box to locate a specific modem name. Type the first few characters of the modem name and press [Enter]. The list box displays the first modem name that most closely matches the text you entered.

• Item Detail. Click this button to display the Edit Modem dialog box, where you can modify the modem definition as necessary. For more information, see “Edit Modem dialog box” on page 104.

Select Client window


The Select Client window appears after you select DIRECT CONNECT as the Modem Type, or if you click Direct Connect Client in the Async Resource Detail dialog box.


Use the Select Client window to select one Client for a Direct Connect resource.

The list box displays the Name, Description, and Status for each Client listed in the Client Profile program.

• Search/Select. Use the Search/Select text box to locate a specific Client name. Type the first few characters of the Client name and press [Enter]. The list box displays the first Client name that most closely matches the text you enter.

• Item Detail. Displays the Client Information message box for the chosen Client. The fields in this detail window originate from various property pages in Client Profile.

NetBIOS Detail dialog boxThe Server displays the NetBIOS Detail dialog box when you double-click a NetBIOS resource on the Resources page, or select the NetBIOS resource and click Update on the File menu.


Use NetBIOS resources if your Clients are LAN based and are to be connected to the Server via the NetBIOS network protocol. You can define up to 32 NetBIOS resources.

The NetBIOS Detail dialog box includes:

• Enable resource. Select this check box to permit NetBIOS based communications. This option is enabled by default.

• Number of Resources. Use the spin box to allocate from 0 to 32 resources. The default value is one (1) NetBIOS resource.

Tip: You can modify the Default Port Group, but you cannot delete it.

• Port Groups. Displays the available collections of NetBIOS resources; this list always includes a Default group. You can create up to 32 Port Groups for the NetBIOS resource, which is the maximum number of concurrent sessions. Port Groups only affect outbound sessions. To modify any Port Group, double-click it, or select the item and click Edit Port Group.

• Group. Indicates the port group name. The name defaults to Default1.

• Port Count. Indicates the number of ports for the selected NetBIOS Port Group. The total number of all ports in this column should match the value in the Number of Resources field.

• Priority. Specifies the priority of the selected port(s). To modify port priority, click the number in this column and use the control that appears to edit it.

• Usage. Indicates whether the Port Group can accept (Inbound) and/or originate (Outbound) calls. By default, both are selected (In/Out), which makes the resource available for both inbound and outbound communication.

• Network Groups. Displays the Network Group associated with an individual Port Group. Network Groups are collections of Clients that can use this Port Group’s port(s); for more information, see “Network Groups property page” on page 80.

Note: If you set the Number of Resources to zero (0) this has the same effect as disabling the resource. When you restart the Server, this resource remains unloaded until you enable it.


• Add Port Group. Use to create a new Port Group for the NetBIOS resource.

• Remove Port Group. Deletes the selected Port Group from the list.

• Edit Port Group. Use this button to modify the current settings.

Port Group Detail dialog boxThis dialog box appears when you create or modify a NetBIOS, SPX, or TCP/IP Port Group. Use it to specify new settings for the selected Port Group.

• Group Name. Use this field to enter a port group name.

• Usage. Select the Inbound and Outbound check boxes to allow all resources in this group to accept and originate calls, respectively. By default, both check boxes are selected.

If the Outbound check box is not selected, most of the other options in this dialog box will be unavailable. You can specify Port Groups and port priority only to outbound sessions.

• Assigned Network Groups. Lists the Network Groups currently assigned to this Port Group. Network Groups are collections of Clients who can use the ports allocated to this Port Group. By default, the Default Network Group is assigned to new Port Groups you create. You can remove the Default Network Group, but you must assign at least one other Network Group to the Port Group. For more information about Network Groups, see “Network Groups property page” on page 80.

• Available Network Groups. Lists the available Network Groups that can be assigned to this Port Group. This list originates from the Network Groups page; for details, see “Network Groups property page” on page 80.

• Number of Ports. Indicates the number of ports reserved for the selected Port Group. The number of available ports cannot exceed the number of unused ports in the NetBIOS (or TCP/IP, or SPX) Detail dialog box.

Note: Any changes you make to Port Groups do not take effect until after you restart the RemoteWare Server.


• Port Priority. Specifies the priority of the port(s) allocated to this Port Group. Reserves the port(s) for sessions whose priorities match or exceed this value. Use this option to reserve some resources for high priority outbound communications. The default is zero (0); nine (9) is the highest priority. For example, a Port Priority setting of 7 permits sessions with priorities of 7, 8, or 9 to use the resource. You can assign priorities to sessions on the Schedule page in the Session Editor program; for details, see “Schedule property page” on page 230.

PROCESS ONLY Detail dialog boxThe PROCESS ONLY Detail dialog box appears when you double-click a PROCESS ONLY resource on the Resources page, or when you select a PROCESS ONLY resource and then select Update from the File menu.

You can set up sessions to use Process Only resources when no Client communication is required. Process Only resources allow rapid session execution on the Server and other computers visible to the Server on the network without occupying an asynchronous or network resource. You can define up to 32 concurrent Process Only resources.

The Process Only Detail dialog box includes:

• Enable resource. Select this check box to permit Process Only sessions to execute. This option is selected by default.

• Number of Resources. Use the spin box to allocate from 0 to 32 Process Only resources. The default value is set to one (1) Process Only resource.

Note: To reserve this resource for high priority communications, you must also set the Usage to Outbound and clear the Inbound check box. Port Priority is ignored for Inbound only resources; the port will accept any inbound connection if its Usage is Inbound/Outbound.

Note: If you set the number of resources to zero (0) this has the same effect as disabling the resource. When you restart the Server, this resource remains unloaded until you enable it.


On the Resources page, the Usage displayed for Process Only resources is always Outbound and cannot be changed from the dialog box. You also cannot specify Port Groups or Network Groups for Process Only sessions; therefore, those options are unavailable in this dialog box.

SPX Detail dialog boxThe SPX Detail dialog box appears when you double-click an SPX resource on the Resources page, or when you select an SPX resource and then click Update on the File menu.

Use SPX resources when your Clients are LAN based and will communicate with the Server using the IPX/SPX Transport. You can allocate a maximum of 32 concurrent SPX resources.

The dialog box includes:

• Enable resource. Select this check box to permit SPX communications. This option is selected by default.

• Number of Resources. Use the spin box to allocate from 0 to 32 resources. The default value is one (1) SPX resource.


• Port Groups. Displays the available collections of SPX resources; this list always includes a Default group. You can create up to 32 Port Groups for the SPX resource, which is the maximum number of concurrent sessions. Port Groups only affect outbound sessions. To modify any Port Group, double-click it, or select the item and click Edit Port Group.


• Port Count. Indicates the number of ports for the selected SPX Port Group. The total number of all ports in this column should match the value in the Number of Resources field.



• Priority. Specifies the priority of the selected port(s). To modify port priority, click the number in this column and use the control that appears to edit it directly.



• Add Port Group. Displays the Port Group Detail dialog box, where you can create a new Port Group for the SPX resource. For details, see “Port Group Detail dialog box” on page 90.


• Edit Port Group. Displays the Port Group Detail dialog box for the selected group. Use this dialog box to modify the current settings. For details, see “Port Group Detail dialog box” on page 90.

• Server Address. Specify the SPX address for this Server. The Client Profile program uses this address for Clients configured to use SPX as an inbound resource. The value is automatically set to the first specified valid address when the service starts up. If the Server computer uses multiple addresses, see “Multiple network addresses” on page 95.



TCP/IP Detail dialog boxThe TCP/IP Detail dialog box appears when you double-click a TCP/IP device on the Resources page, or when you select a TCP/IP device and then select Update on the File menu.

TCP/IP resources are useful for LAN based Clients that communicate with the Server using the TCP/IP Protocol. You can allocate a maximum of 64 concurrent TCP/IP resources.

The TCP/IP Detail dialog box includes:

• Enable resource. Select this check box to permit TCP/IP communications. This option is enabled by default.

• Number of Resources. Use the spin box to allocate from 0 to 64 TCP/IP resources. The default value is one (1) TCP/IP resource.


• Port Groups. Displays the available collections of TCP/IP resources; this list always includes a Default group. You can create up to 64 Port Groups for the TCP/IP resource, which is the maximum number of concurrent sessions. Port Groups only affect outbound sessions. To modify any Port Group, double-click it, or select the item and click Edit Port Group.


• Port Count. Indicates the number of ports for the selected TCP/IP Port Group. The total number of all ports in this column should match the value in the Number of Resources field.

• Priority. Specifies the priority of the selected port(s). To modify port priority, click the number in this column and use the control that appears to edit it directly.





• Add Port Group. Use this button to create a new Port Group for the TCP/IP resource. For details, see “Port Group Detail dialog box” on page 90.


• Edit Port Group. Use this button to modify the current settings. For details, see “Port Group Detail dialog box” on page 90.

• Server Address. Type the IP address (as four octets separated by periods; as in the example 200.200.200.10) or DNS name (such as rw01.companyname.com) for this Server. The Client Profile program uses this address for Clients configured to use TCP/IP as an inbound resource. The value is automatically set to the first specified valid address when the service starts up. If the Server computer uses multiple addresses, refer to the following section.

Multiple network addresses

For RemoteWare Servers with one network card, the Server Address field for TCP/IP and SPX transports is automatically set to an appropriate value each time the RemoteWare Server service starts. If you provide a different value, RemoteWare will verify and, if necessary, change the value if it does not match one of the network addresses on this computer. An RWS1378 message is logged in the Server Log when the Server modifies the address.

Since RemoteWare allows you to enter a Domain Name Server (DNS) name in the TCP/IP Server Address field, Clients can contact the Server by name (such as rw01.companyname.com) instead of by IP address, allowing more flexibility. A DNS name also allows load balancing on a multiple interface Server or a cluster by assigning a name that is mapped to all of the IP addresses of your Servers.


Note: The information in this section applies only to a RemoteWare cluster or a RemoteWare Server computer with multiple network cards.


Limit Outbound property pageUse this page to limit the number of outbound connections that can occur within a certain period of time. You can specify limits for one or more resource types (although you cannot limit Process Only sessions). When you limit the number of connections, the Server only initiates the number of sessions you specify; all other sessions of the same type are blocked, even if resources are available.

To display the Limit Outbound page, click the Limit Outbound tab or select Limit Outbound from the Pages menu.

• Limit Outbound Connections. Limits the number of outbound connections for one or more resource types. When you select this check box, the four resource check boxes become available.

• Limit connections to n new sessions per second. Specifies whether to limit outbound sessions for each resource type (Async, NetBIOS, TCP/IP, SPX). You can select multiple check boxes, if necessary. When you select the check box for a particular resource, its spin box becomes available; use it to specify the maximum number of connections that are allowed to occur each second.

Note: If you make changes on this property page, you must restart the RemoteWare Server before they take effect.


Dial Scripts property pageA dial script consists of commands used to place calls or complete a logon sequence on a network provider or communication service. These commands are executed in order and can be used from the Server or the Client. Dial scripts are used in Long Distance Services for outbound communication, or may be assigned to Clients for inbound connections via the Server property page in Client Profile.

The Dial Scripts property page displays a list of dial scripts and provides access to the Dial Script Editor. To display the Dial Scripts page, click the Dial Scripts tab or select Dial Scripts on the Pages menu.

The list box displays each dial script on a separate line. For clustered configurations, the dial scripts are visible and available to all Servers.

• Name. Displays the name of the dial script; you specify this name when you create a new dial script using the New or Copy command on the File menu. The name must be unique and cannot be changed for that dial script once it is defined.

For details about compiled and uncompiled dial scripts, see “Dial script compilation” on page 101.

• Last Modified. Indicates the date and time the dial script was created, or when it was last saved. The date and time does not necessarily indicate when it was compiled, unless the dial script was compiled and saved at the same time.

• Last Compiled. Displays the most recent date and time when the dial script was compiled. An asterisk “*” in this column indicates an uncompiled dial script.


Dial Script Editor

For instructions on opening the Dial Scripts page, see “Dial Scripts property page” on page 97.

The Dial Script Editor displays whenever you modify an existing dial script. To modify double-click the script on the Dial Scripts page, or select it and select File Update. The Dial Script Editor also appears when you create a new dial script (File New) or copy an existing script (File Copy).

The Dial Script Editor includes:

• Dial Script Name. The name given to the dial script appears in the title bar. This name is referenced any time a dial script is used.

The text box displays the dial script commands. Type the commands and their arguments directly into this box as you would with an editor or word processor. For an explanation of these commands, see “Table 13. Dial script commands” on page 99.

• Save. Writes any dial script changes to disk. This button is available only when the dial script changes.

• Close. Click to exit the Dial Script Editor with or without saving changes you have made.

• Compile. Click this button to check the dial script for invalid syntax and create a copy that the Server can use. Uncompiled dial scripts are not available to the system. Use the Compile button to automatically save and compile the script in one step.

• Help. Provides assistance with using the Dial Script Editor.

• Font. Displays the Font dialog box, where you can change the font, style, size, effects, and color of the script text in the Dial Script Editor.

• Undo. Toggles the changes from the last operation.

Note: To exit the Editor, click Close, Save does not close the Editor.

Note: Font settings are reset to the default each time you start the Dial Script Editor.


Dial script fundamentalsDial scripts sequentially execute the commands in the following table.

Note: For a list of special characters used in dial scripts, see “Table 14. Dial script special characters and variables” on page 100.

Table 13. Dial script commands

Command Examples

Description

; or REM ; This is a comment REM Call next; send name.

Text that follows a semicolon or REM is not executed. Use these commands to add comments to a script or deactivate script commands. REM or “;” must be the first item on the line. A comment cannot follow a command on the same line.

DIAL "{string}" DIAL "ATDT9,5551212,,2001!"

Transmits a string and waits for a return code. The string can consist of AT modem commands, which may include the special characters, <phone #> variable, and an exclamation mark “!” at the end of the command as a carriage return. Use DIAL instead of TRANSMIT when you want the Server to process result codes (for example, “13” for “CONNECT 9600”) returned from the modem.

DLLCALL {command} ["string"] DLLCALL 101 "NOWAIT"

DLLCALL executes an external routine supplied by the administrator. A programmer creates DialScriptExternalCommand() and compiles it into the RWWDSEXT.DLL module. Command is an integer identifying a specific action in the function, and string optionally passes an argument to the function.Note: See the RemoteWare Developer’s API Manual for more information about DLLCALL.

PAUSE {seconds} PAUSE 60

Inserts a delay from 0 to 65,535 seconds.

MODEMINIT ["{string}"] MODEMINIT MODEMINIT "AT&F1S0=0!"

Transmits a string and waits for an “OK” return code from the serial device. Specifying no string transmits the default Modem Init value for the assigned modem from the Modem Types property page. For outbound calls, the Server uses the modem assigned to the resource. For inbound calls, the Client uses the modem assigned to the current connection configuration. The string can consist of AT modem commands, which may include special characters, the <phone #> variable, and an exclamation mark “!” at the end of the command as a carriage return.

Key: { } Required argument [ ] Optional argument


Special characters and variables

For a list of general dial script commands, see “Table 18. Logging trade-offs” on page 117.

Use the characters and variables in Table 16 to insert delays, special characters, and phone numbers with the DIAL, MODEMINIT, or TRANSMIT commands.

TRANSMIT "{string}"TRANSMIT "ready"

Transmits a string and continues without waiting for a reply. TRANSMIT is usually used to send login information to another system. The string can consist of any text, which may include special characters, the <phone #> variable, and an exclamation mark “!” at the end of the command as a carriage return.

WAITFOR {seconds} "{string}" WAITFOR 400 "log in:"

Delays execution from 0 to 65,535 seconds, or until the serial device returns the value in string. String is case sensitive. WAITFOR returns a TIMEOUT if no match occurs before the time expires. To ensure a correct comparison, WAITFOR ignores parity when comparing strings.

Key: { } Required argument [ ] Optional argument

Table 13. Dial script commands (Continued)

Command Examples

Description

Table 14. Dial script special characters and variables

Character or variable

Example Description

, (comma) DIAL "ATDT9,11031,,,55 0032"

Inserts a pause in a dial string. Use one or more commas to instruct the serial device to wait while the communications network is occupied. The delay time depends on the number of commas and the serial device. With modems, the S8 register typically defines the delay time for one comma.

! (exclamation mark) MODEMINIT "AT&F1!" DIAL "ATDT 5551212!"

Inserts a carriage return. This is often required to start processing a command on serial devices or networks. The “!” may be used anywhere in the string, but the MODEMINIT and DIAL commands may require “!” at the end of the string for modems or other devices that need a carriage return to recognize the end of the command.


Dial script compilationDial scripts may exist in an uncompiled or compiled form. To be visible to the Dial Script Editor, all scripts must be stored in the \SYSFILES\SCRIPTS directory.

" " (quotation marks) TRANSMIT "Hello" Strings must begin and end with quotation marks. To specify a quotation mark in a string, use the literal character “\"“.

\ (backslash) TRANSMIT "\! \\ \ff \!"

Uses the literal character or a hexadecimal value that immediately follows the backslash. Some common literal characters are “\,” for comma, “\"“ for quotation marks, “\!” for exclamation mark, and “\\” for backslash. Use two hexadecimal characters to transmit that value; “\ff” sends FF hex or 255 decimal.

<phone #> DIAL "<phone #>" This variable is a placeholder for the Client’s phone number. During execution, RemoteWare replaces <phone #> with the Client’s number. This variable cannot be used at the Client.

Table 15. Uncompiled and compiled dial scripts

Script type Extension Description

Uncompiled .DS Consists of plain text and can be created or edited with any text editor. These scripts may be viewed, but cannot be used as a resource until they are successfully compiled. An asterisk “*” appears in the Last Compiled column on the Dial Scripts property page if the dial script was never compiled or if it has been changed without recompiling.

Compiled .CDS Compilation detects any syntax errors and converts the .DS file into a .CDS file. Files consist of binary (non-text) information that can be viewed and edited only from the Dial Script Editor. Any saved modification to a dial script requires recompilation before the script can be used again.

Note: Dial scripts manipulated from the ECF facility are automatically compiled or rejected if a compilation error occurs. For information about Dial Script ECFs, see “Dial Script ECF” on page 580.

Table 14. Dial script special characters and variables (Continued)

Character or variable

Example Description


Modem Types property pageThe Modem Types property page lists many predefined modem configurations that are used by the Server or Client to communicate; use this page to create or modify definitions to match your connection needs.

To view the Modem Types property page, click the Modem Types tab in Server Profile, or click Modem Types on the Pages menu.

RemoteWare provides support for European ISDN through the RVS-COM Modem definition. This definition enables RemoteWare to access and drive CAPI-compliant ISDN cards.

The list box displays each modem definition on a separate line. For each definition, the the following information appears:

• Name. Displays the name of the modem definition. The modem or configuration name refers to the settings and parameters in the Edit Modem dialog box; for more information, see “Edit Modem dialog box” on page 104. This name appears in multiple programs on the Server and the Client.

• Max Data Rate. Displays the maximum transmission speed supported by this modem in bits per second (bps). For the Server, this is the default rate used on the Resources property page when the definition is chosen for the Modem Type field. At the Client, the value sets the upper limit for communications.

• Flow Control. Indicates the state of the Enable Modem Flow Control check box, which is located on the Command Strings page in the Edit Modem dialog box. For details about this setting, see “Command Strings property page” on page 105.

• Answer on ring. Indicates the state of the Enable Answer on Ring check box, which is located on the Command Strings page in the Edit Modem dialog box. When this option is selected, the serial device will not accept the call until the


Server transmits the specified information. (For details about this setting, see “Command Strings property page” on page 105.)

Modem Type dialog boxes (New, Copy, Rename)Three dialog boxes request a new unique modem name: New, Copy, and Rename Modem Type. This modem name can range from 1 to 30 characters. It refers to the settings and parameters on the Edit Modem property pages; for information about these pages, see “Table 16. Edit Modem property pages” on page 104. The modem name appears in multiple programs on the Server and the Client.

Existing modem definitions usually describe the modem model and special settings. Custom definitions you create could use the name to specify special applications, alternate configurations, assignments to specific Clients, or optimized settings based on certain environments.

In Server Profile, the Modem Type dialog boxes appear when you click the following commands on the File menu:

• New. In the New Modem Type dialog box, enter a unique name in the text box. Click OK to display the Edit Modem dialog box, where you can further define the new modem type.

For information about the Edit Modem dialog box, see “Edit Modem dialog box” on page 104.

• Copy. The Copy Modem Type dialog box displays the source definition in the From Modem Type field. In the To Modem Type field, enter a unique name for the new modem type. When you click OK, RemoteWare copies the source definition’s settings to the new modem definition; it then displays the Edit Modem dialog box.

• Rename. The Rename Modem Type dialog box displays the source definition in the From Modem Type field. Typing a unique name in the To Modem Type field changes the name, inserting it in alphabetical order on the Modem Types property page.


Edit Modem dialog box

For details about the Modem Types page, see “Modem Types property page” on page 102.

The Edit Modem dialog box appears when you perform these actions on the Modem Types property page:

• Create a new modem definition.• Modify an existing modem definition.

Note: You cannot copy, rename, or update the DIRECT CONNECT modem type.

Table 16. Edit Modem property pages


Command Strings Defines AT-level modem strings: Modem Init, Modem Answer, No Answer, Modem Dial, Modem Escape, Modem Hangup, and Answer on Ring.

Enables or disables the Flow Control option. Enables or disables the Answer on Ring option.

105

Result Codes Lists numeric result codes and corresponding verbose result strings.

Changes result code when needed.

107

Settings Defines timing related values. Sets the Maximum Data Rate, Modem Delay, and Modem

Timeout values.

108


Command Strings property page

For details about the Edit Modem dialog box, see “Edit Modem dialog box” on page 104.

Command Strings is the first property page in the Edit Modem dialog box. To view this page, click the Command Strings tab.

The Command Strings page defines the modem or serial device characteristics used when initializing or sending commands. For most serial devices, AT-style modem commands populate the text fields. These commands set, activate, or deactivate features on the serial device.

• Modem Init. Use up to 60 characters to set up operating conditions for dialing and listening. This string is commonly used to set timeout values, disable flow control, enable compression, and so on. An exclamation mark “!” must always be used at the end of the line to specify a carriage return.

• Auto Answer. Specifies conditions for letting the serial device answer incoming calls. Standard formats are usually provided by the serial device manufacturer, and include enabling the auto answer function, setting the number of rings before a connection, and other answering options. If the Enable answer on ring check box is not selected, the Server sends this string to the serial device after a connection has ended. An exclamation mark “!” must always be used at the end of the line to specify a carriage return.

• No Answer. Specifies conditions to not answer incoming calls. If the Enable answer on ring check box is selected, then the Server (not the serial device) intends to answer incoming calls manually. The Server sends this string to the serial device after a connection has ended. An exclamation mark “!” must always be used at the end of the line to specify a carriage return.


• Modem Dial. Use up to 9 characters to define the AT command that is used to dial the number. This string is added in front of the phone number, and generally instructs the modem to use pulse or tone dialing.

• Modem Escape. Enter up to 9 characters to place the serial device into the command mode. This string is usually sent to prepare the serial device for additional commands (such as the Modem Init or Modem Hangup).

• Modem Hangup. Type a maximum of 9 characters to instruct the serial device to terminate the connection. An exclamation mark “!” must always be used at the end of the line to specify a carriage return.

• Answer on Ring. When the Enable Answer on Ring check box is selected, the Server sends up to 9 characters to the serial device to instruct the modem to answer the incoming call. The Enable Answer on Ring option and the Answer on Ring field save connection costs since the modem does not accept the call if the Server is down or the Scheduler is disabled.

• Enable modem flow control. Select this check box to enable hardware flow control between the Server and the modem. Hardware flow control prevents the modems and serial ports from being overrun with data, allows the Server to transmit at the highest possible data speed, and automatically adjusts for conditions such as line quality, busy destinations, and modem limitations.

• Enable answer on ring. When you select this check box, the serial device will not accept a call until the Server transmits the contents of the Answer on Ring field. If the Server is down or the Scheduler is disabled, then an incoming call will go unanswered. Selecting this check box can result in significant cost and time savings, since a Client can connect only when the Server is ready to accept the call.


Result Codes property page


Result Codes is the second property page in the Edit Modem dialog box. To view this page, click the Result Codes tab.

Modems and serial devices send numeric or text result codes to the Server in response to commands. The Server always expects the modem to return an appropriate numeric result code after it transmits a command. The set of result codes used by the Server and the serial device must be identical in order for the Server to correctly interpret the code. Although the default result codes are sufficient for most modems, there are some instances where you may need to modify a code definition.

Use the following controls on the Result Codes page to modify code definitions:

• Result Code/String. Displays each numeric and text return code used by the Server. To edit a result code, select it in the list; use the spin box to specify a new code number.

• New Result Code. Changes the value for the selected entry in the Result Code/String list box. You can select any number from 0 to 99 as the result code value.

Note: Be careful not to inadvertently define duplicate numeric values for more than one result code.


Settings property page


Settings is the third property page in the Edit Modem dialog box; it defines the timing parameters for the serial device. To view this page, click the Settings tab.

The Settings property page contains the following controls:

• Maximum Data Rate. Displays the maximum transmission speed supported by this modem in bits per second (bps). Choose a value from 1200 to 57600 bps. This value is the default rate on the Resources property page when the definition is chosen for the Modem Type field, and appears as the Max Data Rate in the Client’s Setup dialog. If you are using a high speed transport such as an ISDN driver, RemoteWare ignores this data rate and sends the data as fast as possible.

• Modem Delay. Displays the number of milliseconds the Server will wait before sending another command to the modem. Values range from 500 to 5000 msec. The default setting of 1500 msec is sufficient for most modems, although you may need to increase the value for older modems if they cannot process commands in the allotted time.

• Modem Timeout. Determines how long (in seconds) the Server waits for the presence of a carrier signal. If the modem does not complete its handshaking and negotiation process, then the modem will hang up. Use the spin box to select a value from 30 to 255 seconds. The default value of 60 seconds is adequate for most domestic long distance connections. You may need to increase this value when placing international calls or if the modem often fails to make a connection in time. The Modem Timeout value should match the S7= value in the Modem Init string on the Command Strings property page; for details, see “Command Strings property page” on page 105..


Protocol property pageUse the Protocol page to define custom asynchronous and network resources to optimize the transfer efficiency on your communication services. To display this page, click the Protocol tab or select Protocol on the Pages menu.

The list box displays each protocol definition on a separate line. The Client Profile program uses these definitions to define how the Server and Client will communicate. Definitions chosen on the Client page (Client Profile) are then available on the Server page (Client Profile) in the Matching Client Configuration field, as well as at the Client in the Dialing Directory.

RemoteWare includes default protocol definitions designed to operate with most network configurations. These may be used as templates to specify special scenarios, alternate network configurations, assignment to specific Clients, or optimized settings based on network requirements.

For each protocol definition, the following appears:

For an overview of the available transports, see “Resource overview” on page 82.

• Resource. Displays the communications protocol for this entry. Can be ASYNC (asynchronous), NETBIOS, SPX, TCP/IP, or Multicast.

Note: You can copy and update Default protocols, but you cannot delete or rename them. In addition, you cannot rename or delete protocols until you unassign them from all Clients.


• Description. Represents the protocol’s settings. This description is used on the Client and Server property pages in Client Profile as well as the Client’s Dialing Directory.

• Packet Size. Displays the number of bytes sent in one packet. A packet can contain from 128 to 16384 bytes. The Window Size field determines which values are available; see the following note for more details.

• Window Size. Specifies the maximum number of packets transmitted before the Server waits for an acknowledgment. The window size can be from 1 to 8 packets.

• ReXmit. Indicates the number of seconds to wait before retransmitting unacknowledged data.

• Session. Determines the number of seconds a connected session continues without a successfully acknowledged packet. After this time elapses, the session times out.

• Compression. Indicates whether compression is turned On or Off. When enabled, the Server automatically compresses data to maximize the data throughput.

To permanently remove the selected protocol definition, select Delete on the File menu. The protocol you want to delete must not be assigned to a Client. Use the Clients report in Report Manager to list the Clients using this protocol; for details, see “Clients report” on page 350.

To modify the selected protocol definition, select Update on the File menu. The Protocol Service Detail dialog box appears. For information about this dialog box, see “Protocol Service Detail dialog box” on page 111.

Rename Protocol dialog box

For information about the Protocol page, see “Protocol property page” on page 109.

On the Protocol page, to display the Rename Protocol dialog box select Rename on the File menu. This dialog box displays the current protocol name in the From Protocol field.

To change this name, type a unique name in the To Protocol field and click OK. (The name can range from 1 to 31 characters.)

Note: The Packet and Window Size values are related and affect the available values. The product of these two fields cannot exceed 65536 bytes (65K). Attempting to select a larger value will automatically round down the other value to meet the maximum limit.


RemoteWare inserts the new name in alphabetical order on the Protocol page.

Protocol Service Detail dialog boxThe Protocol Service Detail dialog box appears when you create, copy, or update a protocol definition. Use this dialog box to define the protocol name, set the resource type, and adjust protocol parameters.

• Description. Enter up to 31 characters to refer to the protocol’s settings. This description appears on the Client and Server pages in Client Profile as well as in the Client’s Dialing Directory.

To make the protocol definition more descriptive, include information such as connection type (for example, “SPX” or “Async”), characteristics (“640x4” or “uncompressed”), and usage conditions (“Internat'l” or “bad weather”).

For an overview of the available transports, see “Resource overview” on page 82.

• Resource. Select the communications protocol for this entry. Choices are ASYNC (asynchronous), NETBIOS, SPX, or TCP/IP.

• Packet Size. Select the number of bytes sent in one packet. A packet contains from 128 to 16384 bytes; the default value depends on the resource. Available values vary depending on the Window Size. Adjust this value according to your network’s requirements, or to optimize throughput for high-speed or adverse network conditions. Larger values increase performance on networks that support large packet sizes and exhibit high reliability.

• Window Size. Specify the maximum number of packets transmitted before the Server waits for an acknowledgment of receipt. The value may range from 1 to 8 packets. Available values depend on the Packet Size value.

Note: You can copy and update the Default protocols, but you cannot delete or rename them. In addition, you cannot rename or delete protocols until you unassign them from all Clients.

Note: If you are using a device that buffers or stores the data before transmitting it to the destination, then the total bytes transferred (which is Packet Size Window Size) for the device and the Server must match or a timeout may occur.


• ReXmit Timeout. (For ASYNC resources) Defines the number of seconds to wait before retransmitting unacknowledged data. This value ranges from 10 to 60 seconds; the default is 15 seconds.

• Session Timeout. Determines how long a connected session continues without a successfully acknowledged packet. This value ranges from 30 to 120 seconds; 60 seconds is the default setting.

• Enable Compression. Specifies whether compression is turned on or off. This check box is selected by default for the asynchronous protocols, which automatically compresses data to maximize the data throughput. Clear this check box if the modem possesses compression, if data is already compressed, or if you are using a network based protocol (such as NetBIOS, SPX, or TCP/IP).

Note: The Packet Size and Window Size fields work together to define the total number of bytes in transit. The multiple of these two values cannot exceed 65536 (65K) bytes; therefore, some values may not be available in one field until you reduce the value in the other field. For example, when the Packet Size is set to 16384, Window Size values from 5 to 8 are not available. The Server rounds down any values that exceed 65K.


Alarms property pageUse the Alarms page to view or adjust warning values for specific system occurrences. To display this page, click the Alarms tab, or on the Pages menu, click Alarms.

The percentage spin boxes can be set from 20 to 99%. The port alarms value ranges from 0 to 20. A value of zero (0) instructs the Server to never deactivate the port.

These alarm thresholds control the functions and produce the following warning messages:

Table 17. Alarm options, impact, and resolutions

Alarm label System actions Resolution(s)

Activate alarm when % of Server disk filled reaches...

Server Log: RWS0011: Server Data Drive Full.

Network Status: Server Disk Full.

Free some Server disk space. Increase threshold.

Activate alarm when % of Client disk filled reaches...

Server Log: RWS0012: Client ClientName Drive x: Full.

Network Status: Client Disk Full.

Advise Client user to free some disk space.Move Client to another disk or partition

with more free space.Use Interactive Session to examine disk and

move or delete Client files. Increase Client disk threshold.

Disable port when number of alarms for port reaches...

Server Log: RWS00xx: Port Threshold reached - port disabled.

Network Status: Port Failure.

Investigate why port is malfunctioning. Isolate and test cables, connections, and

equipment between Server and Client.


Use the Additional Popup Alarm Configuration to turn on a pop up warning dialog box when a specifically-named database is down or otherwise not functioning properly.

If the Remoteware Servers are running Windows 2003 or later operating system, the Remoteware Database popup alarm is changed to use Microsoft's newer message commands that display only on Windows XP and later operating systems. If the Remoteware Servers are Windows 2000, the popup alarm displays only on operating systems older than Windows 2003.


Logging property pageUse the Logging property page to limit the amount of detail you need when logging system events to the Session History Log and File Transfer Log. These settings apply to all clustered Servers across your RemoteWare network. To display the Logging page, click the Logging tab, or select Pages Logging.

Controls on this page are divided into the Session Log and File Transfer options.

Session Log

For details about the Session History log, see “Log Viewer” on page 283.

The Session Log records information about each session, including its duration, completion status, scheduling information, and object and event level details.

Four options are available to set the level of Session Log activity:

• Disable all session logging. Prevents any session information from being recorded to the Session Log. Selecting this check box disables all other options in the Session Log area. Executed sessions that are not entered in the Session Log cannot be restarted by the Session Log.

• Log only failed sessions. Records information for any session that ended with a FAILED-FINAL or FAILED-ALL status. Does not log SUCCESSFUL or COMPLETED sessions.

• Disable session event logging. Records basic session information (such as session and Client name, status, and date/time), but not work object and event level details.

• Disable comment logging. Omits comments in worklists from being logged in the session details.


• Log ESD Objects not requiring updates. Logs ESD work objects that did not update any data. Session Log records these work objects as NOT EXECUTED.

• (Windows, Linux, DOS IP and 4690 clients) Log wildcard transfers not requiring updates. Logs files that were declared by a wildcard but did not require any update.

File Transfer

For details about the File Transfer log, see “Log Viewer” on page 283.

The File Transfer log records information about communication sessions that use the GET, SEND, and CHECK SEND events to transfer files. For each file transferred, the log displays the time, Client, status, command, and file name.

Three options are available to adjust the level of File Transfer logging:

• Disable all file transfer logging. Does not record any file transfer information. Selecting this check box disables all other options in the File Transfer area.

• Log only failed file transfers. Records information when a file transfer did not complete as expected.

• Disable no execute logging. If a portion of the session is skipped (due to a conditional event), then file transfer events that did not execute will not be logged with a No Execute status.

Multicast Log

• Disable multicast logging. Disables logging of Multicast sessions.

• Log only failed multicast file transfers. Turns off logging for successful Multicast sessions.

Logging option trade-offsThere are trade-offs between the extent of logging activity, log file size, log rollover, available system functions, and system performance. The following table describes

Note: There are some situations in which a session or file transfer does not complete as expected, but is not considered a failure. For example, a file transfer event may be marked as Not required for successful session. These situations are not recorded if the Log only failed file transfers check box is selected.


some of these and how you can set the logging options to achieve the desired results.

Table 18. Logging trade-offs

To optimize Do this

Log file size Decrease or increase the maximum number of log records. Decrease the amount of information logged.Shut down all logging.

Turnover time Log only failed sessions or file transfers. Increase the maximum number of log records.

Session restart function Do not disable session history logging.

Performance Shut down all logging.Log only failed sessions or file transfers. Disable the Update automatically feature in active log programs.View only a small percentage of a log unless necessary.Minimize the number of open programs.


Licensing property pageUse the Licensing property page to view, track, and update Server, Client, and application licensing and quantity values. To display the Licensing page, click the Licensing tab or select Licensing on the Pages menu.

The list box displays each licensed item on a separate line. For each licensed item, the following appears:

• Type. Displays the category of the licensed item. Types include: Clients, Servers, Sessions per Server, Workstations, applications, and users per Client.

• Licensed. Indicates the number of licenses for this item. This is the maximum number of the resource that can be used on this RemoteWare system.

• Actual. Shows the quantity of this item that has been defined on this RemoteWare system. This value includes disabled items but not deleted items. This value may be equal to but may not exceed the Licensed value. If you start to approach the Licensed value, contact your RemoteWare representative for additional licensing.


Update Licensing dialog boxTo display the Update Licensing dialog box, select Update (File menu) or double-click a licensed item on the Licensing page. Use the following controls to add, remove, increment, and decrement items from this RemoteWare Server or cluster.

• Read Update Code(s) from UPD File. Directs the RemoteWare Server to read the licensing information from a file on a disk or other media provided by your RemoteWare representative. Type the path and name of the licensing file in the text box, or click Browse to locate the file on your system.

• Enter Update Code. Select this option to modify licensing by typing an update code provided by your RemoteWare representative. Using this option, you can immediately update your system without having to wait for a licensing disk.

• Serial Number. Displays the serial number of your RemoteWare Server software. You cannot modify this value.

• Update Code. Enter the code provided by your RemoteWare representative to update your licensing immediately.

License Log window

The License Log window lists every license change made to the RemoteWare system. To display this window, select Command View License Log.

The License Log contains one line for each successful licensing operation. For each item, the following appears:

• Date. The month, day, and year when the licensing update occurred.

• Action. Displays what type of licensing occurred and the amount of resources added or removed, if appropriate.

• Licensed. Indicates the new licensed quantity. The most recent value for this License Type appears in the Licensed column on the Licensing page.

• License Type. Displays the name of the item that was updated. The License Type corresponds to the Type on the Licensing page.


Portable Security pageUse the Portable Security page to create, modify and delete Portable Security user’s, rights to connect to Clients via a session using Portable Interactive Session. To display the Portable Security page, click the Portable Security tab.

The list box displays each portable user’s valid login information on a separate line. For each portable user item, the following appears:

• Computer. Displays the computer name for the user as it will appear in the Portable Security User Information dialog box.

• User. Displays the user name for the user as it will appear in the Portable Security User Information dialog box.

Note: The Portable Security page is only available if you are licensed for this component.


Portable Security User Information dialog boxTo display the Portable Security User Information dialog box, select Update from the File menu, or double-click an item on the Portable Security page. The Portable Secuity User Information dialog box contains the following fields:

• Computer. Allows you to create, edit or view the computer name for the user’s account.

• User. Allows you to create, edit, or view the user name for the user’s account.

• Password. Allows you to create a new password, or change password associated with the user’s account.

• Confirm Password. Requires you to verify the password indicated in the Password box.

C H A P T E R

5

Client Profile

The Client Profile program contains the definitions for each RemoteWare Client,

including its specifications, characteristics, contacts, preferences, assignments, and

groupings. In addition, Client Profile provides a location for creating and maintaining

Client groups as well as performing template Client registration for large deployments

of Clients.


• “Client Profile at a glance” on page 124



• “Make-Kit Installation Wizard” on page 161

• “Registration menu overview” on page 174


Client Profile at a glanceA Client consists of the RemoteWare Client software on a computer other than the RemoteWare Server. The Client and Server use the Client software to connect and exchange information.

Client Profile consists of the property pages listed in the following table. Property pages specific to Clients describe the Client operating system, available connection methods, communication session framework, resource information, and optional contact information.

A Client group is a collection of Clients that have common characteristics (for example, the same project, work object, or session requirements, geographical area, or affiliation). Using Client groups simplifies the management of large numbers of Clients. You can assign work objects or sessions once to a Client group instead of having to assign individual Clients to sessions or work objects. The Server then executes sessions or work objects for each Client in the group.

Client group property pages in the following table show assignments and inclusions for Clients, other groups, work objects, and sessions.

Table 19. Client Profile property pages

Property page

Description Details on page

Pages specific to the Client:

Client List Displays Client and Group names, description, and status.Convenient access for status changes, security reset, or installation kit creation.

129

General Modify attributes specific to the Client, not including connection methods.Set Client and secondary Server access options, as well as Client level file transfer options (for example, ESD and Applications).

135

Client Define up to five (5) Client-based connection methods.Set Inbound Schedule, enabling the Client to automatically connect at a preset time.

137

Server Specify the primary and alternate connection methods for outbound connections to the Client, including the Client’s phone number or network address.

142

Assignments Select which work objects or group objects execute each time the Client and Server establish a connection.

144

C l i e n t P r o f i l e a t a g l a n c e 125

Information View Client disk space and memory availability, as well as software and hardware inventory information if RemoteWare Inventory Manager is installed.

151

Comments Optionally specify the Client’s contact information and any other facts pertinent to this Client.

152

Pages specific to Client groups:

Members Display, add, or remove Clients from the selected group. 153

Parents Make this group a member of another group (or groups).View which Client groups contain this group.

155

Objects List which work objects are associated to this group, either directly or through another Client group. Assign work objects, or unassign work objects that have been directly assigned to this group.

157

Sessions Show the session assigned to this group, either by direct assignment or through other Client groups. Assign sessions, or unassign them if they’re directly assigned to the group.

159

Table 19. Client Profile property pages (Continued)

Property page




The following table lists the menu commands specific to Client Profile and provides a brief description of each.


Table 20. Client Profile menu commands


Description

File New Client Client List Creates a new Client.

New Group Client List Creates (or adds Clients or groups to) a new Client group.

*Copy Client List Duplicates a Client or group by copying the assignments of an existing item to the new item.

*Delete Client List Permanently removes the selected Client or group.

Update Client List Defines (and adds Clients or groups to) a new Client group.

Command *Enable Client

Client List Makes this Client available for use.

*Disable Client

Client List Removes (but does not delete) this Client from any activity.

*Make Installation Kit

Client List Collects a Client’s software, settings, and support files for a setup on a Client computer.

*Reset Security

Client List Suspends the security check for the next connection.

*Reset All Security

Client List Suspends the security check for all Clients during their next connection.


Command Export Portable Client List

Client List (Available only for systems with licensing for Portable Interactive Session.) Creates a custom list of Client information that you can import on a stand-alone Portable machine. Portable uses this list to connect with Clients.

Export NetOp Client List

Client List Allows you to export a RemoteWare Client from the RemoteWare Server.

Unregister Client

Client List Unregister the selected template Client. Use this command to quickly recover a lost or missing template Client without having to delete it and recreate the template makekit. An unregistered Client can begin the registration and verification process during a future communication session. For more information about unregistering template Clients, see the RemoteWare Server Administrator’s Guide.

Register Client

Client List Register the selected template Client. Use this command to create a template makekit.

*Change Group Description

Client List Modifies the Description field for the selected Client group.

*Cancel Changes

Client ListClientGeneralServerInformationComments

Discards any Client modifications. Note: This command does not apply to changes made on the Assignments property page and is not available to Client groups.

View Toolbar Client List Displays the toolbar near the top of the page.

Status Bar Client List Displays the status bar at the bottom of the page.

Table 20. Client Profile menu commands (Continued)


Description


View Set Font Client List Displays a dialog box where you can set the display font. Only fonts installed on your computer display properly.

Refresh* Client List Refreshes and updates the information displayed.

Filter Client List Applies various filters to the items in Client Profile. The menu bar indicates whether a filter is currently applied (Filter - ON) or no filters are applied (Filter - OFF). For details about this command, see “Filter menu commands” on page 130.

Registration Options Client List Enables the Client registration option and sets parameters for creating Clients via Registration.

Manual Verification

Client List Selects Clients that have connected and completes the registration process.

Schedule Registration Session

Client List Selects Clients that have not connected and initiates an outbound connection with them.

Pages Client ListGeneralClientServerAssignmentsInformationComments

Allows you to display the corresponding page in the Client Profile.

Table 20. Client Profile menu commands (Continued)


Description


Property pagesThe following topics provide information about the Client Profile property pages.

Client List property page For information about the available filters, see “Filter menu commands” on page 130.

The Client List page appears when you first start the Client Profile program. This page displays all currently defined Clients, or a subset of the Clients or groups if you are using a filter to limit the list of displayed items.

To display this page, click the Client List tab, or select List from the Pages menu.

The top portion of the Client List page provides the following information:

• Client Counts. This area displays values for: • Max – the maximum number of licensed Clients in this RemoteWare network;• Defined – the total number of defined Clients that appear in Client Profile;• Enabled – the number of defined Clients that are able to communicate with

the RemoteWare Server.

• Group Counts. This area displays Max and Defined values for Client groups. The maximum number of Client groups is always 1000. The Defined value displays the total number of defined Client groups in Client Profile.


A newly installed RemoteWare Server will have the SAMPLE Client already defined as an example. Other RemoteWare products may install their own Clients.

The list box displays each Client on a separate line along with the following information:

• Name. Displays the name of the Client or Client group name, which you specify when you create an item. You cannot change the Client or group name once you have created it.

A green indicator to the left of the Client name signals an enabled Client or Client group, and a gray indicator represents a disabled Client or Client group.

• Type. Indicates whether the item is a Client or Group (for a Client group).

• Description. Provides a brief description of the Client or Client group. You can modify this description on the General page. For details, see “General property page” on page 135.

• Status. Indicates whether the Client is available for communication (Enabled) or not available for communication (Disabled). Status is not applicable to Client groups, which display “N/A” in this field.

Filter menu commandsOn the Client List page, you can selectively display certain types of Clients or groups by applying a filter. For example, you can examine all items with a common characteristic, such as all Clients that have a Disabled status.

You can combine filters as needed; each filter is cummulative of any filter already in use until you choose the Remove All Filters command. You also can save Filter settings as files in order to reuse them at a later time.

The following Filter menu commands are available for Clients and Client groups. A few of these commands are described in greater detail in the sections that follow.

Table 21. Filter menu commands in Client Profile

Button Filter menu command Description

by Selected Clients and Groups

Displays or provides detail for any existing Client(s) or Group(s). For more information, see “Filter by Selected Clients and Groups” on page 132.

by Members of Selected Groups

Lists the Clients in one or more Client groups. For details, see “Filter by Members of Selected Groups” on page 133.

by Enabled Clients The green indicator displays only Enabled Clients. Use this command in conjunction with other filters to display only Clients of a certain activation type.


by Disabled Clients The gray indicator displays only Disabled Clients. Use this command in conjunction with other filters to display only Clients of a certain activation type.

by Registered Clients Displays Clients that have successfully connected and completed the registration process.For details on using this filter, see “Registration-based filters” on page 133.

by Unregistered Clients Shows Clients that have not yet connected or have not completed the registration process.For details, see “Registration-based filters” on page 133.

by Clients Requiring Manual Verification

Displays template Clients pending registration and waiting to be verified or deleted.For more information, see “Registration-based filters” on page 133.

Remove All Filters Discards all filter settings and displays every Client and Client Group.For additional details, see “Managing filters” on page 133.

Read Filters Applies a predefined filter file.To learn how to use filter files, see “Managing filters” on page 133.

Write Filters Creates a file that contains the current filter settings.For instructions on saving filter settings, see “Managing filters” on page 133.

Table 21. Filter menu commands in Client Profile (Continued)



Filter by Selected Clients and GroupsUse this menu command to display specific Clients and Client groups on the Client List property page. When you click by Selected Clients and Groups on the Filter menu, the Select Clients and Client Groups window appears:

Use this window to choose one or more items for display. Select your choices by:

• Manually selecting items. Click an item in the list to select it; to deselect an item, press [Ctrl] and click it again. You can select multiple adjacent items with the mouse, or press [Ctrl] to select items that are not next to each other.

• Narrowing the view. By default, the View drop-down list displays all Clients and Groups. To narrow the view, select Clients or Client Groups in the View list.

• Using the Search/Select text box. Use the Search/Select text box to select or deselect one or more items in the list box. Type the first characters of the Client or group name and press [Enter] to select it. Use an exclamation mark “!” as the first character when you want to deselect one or more items. You can repeatedly type characters in this box to select additional items.

The Select Clients and Client Groups window also includes the following buttons:

• Item Detail. Displays Client or group information for the selected item. Each attribute displayed appears on one of the Client Profile property pages.

• Remove Filter. Similar to Cancel, but in addition to discarding changes, also deletes settings from this filter category.

• OK. Accepts your settings and displays the selected items on the Client List page.

• Cancel. Discards selections and changes made in this dialog box. Preserves any filter settings present before you selected the Filter menu command.


Filter by Members of Selected Groups

For descriptions of selection techniques and buttons in this dialog box, see “Filter by Selected Clients and Groups” on page 132.

Use this menu command to display specific members of Client groups on the Client List property page. When you click by Members of Selected Groups on the Filter menu, the Select Client Groups window appears:

This window displays a list of currently defined Client groups. The list box highlights items as you select one or more Client groups to include in the filter.

Registration-based filters

For additional information about registration, template Clients, and manual verification, see “Registration menu overview” on page 174.

On the Filter menu, the following commands reveal which Clients have completed the registration process: by Registered Clients, by Unregistered Clients, and by Clients Requiring Manual Verification.

All Clients complete registration during the first connection. You can require template Clients to undergo manual verification before completing the registration process. To do this, create a template Client and make many copies of the installation kit, instead of defining each Client separately.

Selecting one or more of these filters immediately displays the appropriate Clients on the Client List page.

Managing filtersOn the Client List page, select the following Filter menu commands to deactivate all current filter settings, save a filter combination for later use, and retrieve and apply filter settings.

• Remove All Filters. Immediately removes every filter applied to the Client List page. On the Client Profile menu bar, “Filter – ON” changes to “Filter – OFF.”


• Read Filters. Displays the Select Filter File dialog box, where you can select an existing filter file to filter the items on the Client List page. Use this dialog box to locate the filter you want to apply; then click Open. (Clicking Cancel discards changes and returns you to the Client List property page.)

• Write Filters. Saves the current filter setting to a file for future use. When you want to reuse the filter file, select Read Filters on the Filter menu.


General property pageThe General property page is the second page in Client Profile. It contains general information about an individual Client. This page automatically appears after you create a new Client or when you double-click an existing Client on the Client List page.

To display this page, select a Client on the Client List page and then click the General tab. You can also double-click a Client on the Client List page, or select General from the Pages menu.

The top area of the General page displays the selected Client’s name and its creation date. In addition, you can use this page to view or set the following information:

• Type. Displays the Client’s operating environment. Select the Client’s system in the list. RemoteWare uses this value to determine which files to include in a Makekit, what features are available on the Client, and which work objects are appropriate for the Client.

• Description. Provides a short description of the Client. You can enter up to 22 characters in this field. This information is not used for Client or Server operations.

DOS Clients require a password.

• Password. Displays the password the Client uses to access the Server. By default, this field is blank. Enter up to 10 characters as a Client-to-Server password. The Server checks this password each time a communications session begins.

Note: If you do not specify a password, the Server displays a message each time you access this Client’s property pages. Use a password even if you do not plan to implement any security on your system.


• Install Drive and Path. Designates the drive letter that contains the Client software. The Client’s default drive is “C.” All system ESD occurs to this drive and path; if ESD files are not transferred and you are certain that this path is available and exists on the Client, then verify that the Client user has not moved the Client software to another drive.

The Server also uses this drive for file transfers when the event contains no drive letter in the path name. The Install Path field is the default <ClientInstall>\ path for events if no path appears in the event.

If the Client changes the time zone in the Date/Time Properties of Control Panel without updating the time zone setting in Client Profile, the system sends the full Client system software during the next connection.

• Timezone. Displays the Universal Time Coordinate (UTC) for the selected Client. To select a new time zone for the Client, click this button. The Select Client’s Universal Time Coordinate dialog box appears.

GMT offset values are listed with Client location descriptors. Selecting a location/offset pair stores only the offset value to the database; the location descriptor is not stored and has no effect on RemoteWare operations.

• Other Server Serial Numbers. Lists up to six (6) serial numbers of other RemoteWare Servers that can access this Client. These other Servers access this Client as Secondary Servers.

• Enable Options. This area of the General page contains the following options, the first two of which are selected by default:

• Application Work Objects. When selected, allows the Server to process application work objects assigned to this Client.

• Electronic Software Distribution. When selected, allows the Server to process ESD work objects for this Client.

• Inbound Work Object Selection. When selected, allows the Client user to select objects from a list of assigned work objects while in the Client Dialing Directory. Inbound work object selection is helpful for Client users who understand communications and need to specify exactly what occurs during a communication session. However, this option can confuse less experienced users if they disable work objects and forget to enable them at a later time.


Client property pageThe Client property page is the third page in Client Profile. Use this page to assign communication resources to the selected Client, define the Server phone numbers or addresses that the Client uses to contact the Server, and enable an inbound communications schedule.

To display this page, select a Client on the Client List page; then click the Client tab. Or, on the Pages menu, select Client.

Similar to other Client Profile property pages, the top area of this page displays the Client name and description, which originate on the General page. In addition, the Client page contains the following information and controls:

• Client Configuration. Provides a list of available transport protocols to use for this Client. Click the arrow to display up to five (5) protocol names as listed in the Protocol field. Select an entry to populate the rest of the page with the settings for that transport; if you select an Undefined entry, the other fields remain blank.

The Server sends these configurations to Clients, and Client users can select the configuration that is appropriate for their environment. Changes can include using different communication transports (modem versus network), varying equipment (changes in the modem type), or changing the setup (using different communication ports).

• Use this configuration to listen for connections. (Windows, Linux) Indicates whether the Client’s resource is enabled to listen for a RemoteWare Server’s outbound connection as part of RemoteWare’s multi-transport feature. Only one


resource of each protocol type can be defined for a Client with the listen attribute enabled.

Using this feature provides a backup communications path for when another resource type is in use or is otherwise unavailable. A listening resource can respond to an outbound session only when it is idle and not currently in use for a session. At any given time, only one resource of each transport type can be defined to listen. The listen attribute cannot be modified at the Client.

On the Client page, the Resource Setup area provides options for defining the Client’s communication settings. These include:

In order to use SPX on a Client, the Microsoft Virtual Machine in Internet 5.0 should not be installed on the Client.

• Protocol. Displays available communication selections. Available items are defined on the Protocol page in Server Profile. The choices begin with the transport type (ASYNC, NETBIOS, SPX, TCP/IP) and follow with the protocol’s name.

Select a protocol definition that the Client can use to contact the Server. One of these definitions should be the protocol the Server uses to connect with the Client. This choice is used for the Matching Client Configuration field on the Server page.

• Modem Type (or TCP/IP Type). (Available only for ASYNC or TCP/IP protocols) For ASYNC-based protocols, displays a list of modems; this list originates from the Modem Types page in Server Profile. Click the Modem Type arrow and select a modem in the list provided.

For TCP/IP protocols, the TCP/IP Type field offers Windows Sockets as the only TCP/IP stack. For Clients that are connected directly to the Server, select Direct Connect to define the Client.

• Use Client system defined modem (TAPI). (Available only for ASYNC protocol for Windows Clients) Allows you or the Client to choose a modem supplied by the Windows operating system. These modems and their connections are defined in Control Panel on the Client machine. The Client generates a list of available TAPI modems, and the RemoteWare Server retrieves it during a connection.

If you select this check box, the Modem Port option changes to the following option:

• Use country and area code. Indicates whether the TAPI modem should include the country and area code when dialing. In previous RemoteWare releases, the Client TAPI modem always used these codes; you could not change this setting. In this release, you can specify this modem setting.

Note: Due to performance considerations, we recommend that you do not use the NetBIOS resource during Remote Control sessions.


By default, the Modem Type field displays “Default TAPI modem” when you select the Use Client system defined modem (TAPI) check box. This default setting uses the first system defined TAPI modem it finds on the Client machine. To select a different TAPI modem:

• Select another modem in the list. If the Server has already retrieved the list of TAPI modems from the Client, it displays the available modems in the Modem Type list.

• Type the name of the modem. If you know the specific name of the modem, enter it directly in the Modem Type field. Use this method if you need to set the modem type prior to the first connection with this Client. Make sure to enter the correct name; also, the Client must be a RemoteWare 4.1 Client.

• Modem Port. (Available only for the ASYNC protocol; does not appear if you select a TAPI modem.) Displays the hardware serial port the Client’s modem uses to connect with the Server. Select a port from COM1 to COM20 for Windows Clients.

• Data Rate. (Available only for the ASYNC protocol) Displays the modem data transfer speed. Depending on the modem type, you can choose from 1200 to 57600 bits per second (bps).

For TCP/IP addresses, you can provide either four octets (as in 128.0.0.1) or the DNS name (as in rw01.acme.com).

The Server Phone Numbers (or Server Addresses) area contains two buttons used to specify the phone numbers or network addresses a Client uses to access the Server. For outbound-only Clients, these buttons are blank.

• Primary. Displays the first phone number or address that the Client uses to contact the Server.

• Secondary. Displays the second number or address that the Client uses to contact the Server.

To change the number(s), click the appropriate button. The dialog box that appears depends on the Client protocol. For details, see “Server Phone Number or Address dialog boxes” on page 140. The Client uses the primary and secondary numbers (or addresses) as entries in the Client’s Dialing Directory. Choose from the different entries depending on the Client user’s needs.

Inbound schedule is not available for DOS Clients.

The Inbound Schedule area provides controls to configure the Client to automatically connect to the Server at a specific time each day.

Note: For a Direct Connect Async connection, the Data Rate setting for the Server’s Async resource must match the Data Rate of the Async resource defined for the Client.

Note: The Client software must be active in order for a connection to occur using the Inbound Schedule feature.


There is no visual indication for Windows Clients when Inbound Schedule is enabled, as the schedule is maintained by the communications kernel and not the user interface.

• Enable. Instructs the Client to initiate an inbound connection to the Server each day.

• Time. Indicates the time (in 24-hour format) the Client initiates an inbound connection. To change the time, click this button. Click the hour, minute, or seconds and use the spin box to reset the time.

• Retries. Displays the maximum number of connection attempts. If the Client is not able to connect after this number of retries, then the scheduler marks the session as unsuccessful and tries the next day. Use the spin box to select from 0 to 20 attempts.

• Multicast Enable. Enable Multicast for TCP/IP Client (if licensed for Multicast). RemoteWare Multicast extends traditional point-to-point transmission by transferring outbound data simultaneously to multiple sites.

Server Phone Number or Address dialog boxes

For information about the Client page, see page 137.

Use the Server Phone Number or Server Address dialog boxes to specify the phone number or network address a Client uses to access the Server. One of these dialog boxes appears when you click the Primary or Secondary button on the Client page.

The Server Profile Resources page defines the choices in these dialog boxes. The value in the Protocol field and your Server’s defined resources determine which dialog box appears when you click the Primary or Secondary button.

In the Server Phone Number dialog box, you can select the phone number from the list provided or manually type it in the text box.

• ASYNC Protocol. Use one of the following two dialog boxes to specify how the Client will access the Server. The Enter Server Phone Number dialog box appears if no defined Server asynchronous resources exist.

Note: Choose a phone number or address with the type In or Both. Clients cannot access the Server though an outbound line.


• TCP/IP or SPX Protocol. Use the Server Address dialog box to choose the network address a Client uses to access the Server. Select from a list of addresses, or manually type the network address in the text box.

If the Server’s network address is undefined, specify its address in the Enter Server Address dialog box.

Due to performance considerations, we recommend that you do not use the NetBIOS resource during Remote Control sessions.

• NetBIOS Protocol. In the Server Name dialog box, select the name of the Server in the list provided. Click OK to select your choice, or Cancel to return to the Client page. Clicking Clear removes addresses from the Server address field.


Server property pageUse the Server property page to define the resources and methods the Server uses to connect to the Client. To display this page, select a Client on the Client List page; then click the Server tab. Or, on the Pages menu, select Server.

Similar to other Client Profile property pages, the top area of this page displays the Client name and description, which originate on the General page. Primary and Alternate resource settings make up the rest of the page.

The Server uses the Primary settings for the first connection to the Client. Depending on the session, the Server may switch to the Alternate setting after a specified number of retries have failed. Retry values are set on the Schedule page in Session Editor.

The Primary and Alternate areas each contain the following controls:

• Resource. Displays the resource the Server uses to locate a similar resource during an outbound session. Available resources are ASYNC, NetBIOS, SPX, or TCP/IP.

Note: Due to performance considerations, we recommend that you do not use the NetBIOS resource during Remote Control sessions.


If the Long Distance Service field has not been completed for a Client’s Async resource, when the Server attempts to initiate an outbound session, the attempt will fail with a “blocked” status in Schedule Manager.

• Long Distance Service (or Network Group). For the ASYNC resource, displays the service the Server uses to add the appropriate prefix and suffix to the phone number. Also determines which async resources are compatible with this Client. For network resources (TCP/IP, SPX, or NetBIOS), provides a location for assigning a Network Group to this Client. A Network Group is a collection of Clients grouped together for resource management purposes. After you assign a Network Group to Clients, you then assign it to a Resource Group in Server Profile. Network Groups and Resource Groups work together to manage the number and priority of outbound connections over individual ports. For more information, see “Network Groups property page” on page 80.

Items in the Long Distance Service list originate on the Resources page in Server Profile; for details, see page 81.

• Client Phone Number (or Client Address). Displays the Client’s phone number or network address; you can modify this value by entering a new number or address in the text box. This field is optional for exclusively inbound Clients.

• Matching Client Configuration. Displays all five Client Configuration settings from the Client page. Select the choice that the Server should expect when it calls the Client.


Assignments property pageUse the Assignments property page to assign work objects, sessions, and Client groups to this Client. To display this page, select a Client on the Client List page; then click the Assignments tab. Or, on the Pages menu, select Assignments.

The list box displays any items that are assigned to the selected Client. In addition, the Assignments page contains the following controls:

• View. Displays specific items on the Assignments page. Click the arrow and select an item in the list. Depending on your selection, the Assignments page lists certain types of items assigned to the Client. For details, see “Table 22. View choices and their results” on page 145.

• Search/Select. Use the Search/Select text box to select or deselect one or more items in the list box. To select an item, type the first few characters of its name and press [Enter]. Use an exclamation mark “!” as the first character when you want to deselect one or more items. You can repeatedly type characters in this box to select additional items, or use wildcard characters.

• Item Detail. Displays more information about the selected item. The information varies depending on the type of the chosen item.

• Unassign. Removes an association between the selected item(s) and the Client.

• Unassign All. Removes all associations between displayed items and the Client.


• Assign. Associates this Client with one or more of the items. For a description of the types of possible assignments, see “Client assignment fundamentals” on page 146.

Table 22. View choices and their results

View item Description (see the next table for heading definitions)

Client Groups Lists all Client groups defined in the Client Profile. Headings include: Name, Description, Members, Objects, and Sessions.

Objects (All) Lists every work object from the Work Object Editor. Headings include: Name, Type, and Status.

Objects (App) Lists Application work objects. Headings include: Name, Status, and Users.

Objects (AppGrp) Lists Application Group work objects. Headings include: Name, Status, Members, and Users.

Objects (ESD) Lists ESD work objects. Headings include Name and Status.

Objects (Grp) Lists work object groups. Headings include: Name, Status, Members and Clients.

Objects (Wrk) Lists worklist work objects. Headings include Name and Status.

Sessions Lists all sessions defined in the Session Editor. Headings include: Name, Type, Status, Objects, and Clients.

Users Lists users by their full names, as defined in the Directory Manager program. Headings include: Full Name, Address, and Client.

Table 23. Column headings for the Assignments list box

Column Heading Description

Address Displays the user’s RemoteWare or other messaging address.

Client(s) Displays the number of users assigned to this item.

Description Lists the long description for the Client group.

Full Name Lists the long description for the user.

Members Displays the number of Clients, applications, or objects in a Client group, application group, or work object group.

Name Depending on the view, displays the Client group, object or session name.

Objects Displays the number of work objects assigned to the Client group or session.

Sessions Displays the number of sessions assigned to a Client group.

Status Indicates the Enabled or Disabled status of any object or session.

Type For Objects (All), indicates the work object type: Wrk. ESD, Grp, or MC. For sessions, lists its type: Inbound, Outbound, or Both.


Client assignment fundamentals

This section describes assignment types, implications, and other issues you need to consider when making assignments.

For an outline of the items you can assign to Clients, see “Table 24. Assignments available to Clients” on page 146. Assign items carefully to guarantee expected results. Multiple assignments across sessions, Clients, and so on may cause your sessions to schedule unexpectedly, or sessions and objects may not execute at all. You can assign items to a Client either directly, indirectly, or both:

• Direct assignment. Directly assign items by selecting an individual item and assigning it to a particular Client.

Example: Select Session 1 and assign it to Client A.

• Indirect assignment. Indirectly assign items by assigning a Client to a Client group to which the item is already assigned. You don’t assign these items from the list box; Clients are assigned the item because they are a part of the group. Indirectly assigned items have an asterisk “*” next to their names in the list box.

Example: You have already assigned Session 1 to Client Group B. When you assign Client A to Client Group B, you indirectly assign Session 1 to Client A.

• Direct and indirect assignment. If you have assigned an item to a Client group and then assign another Client to that Client group, that item will be indirectly assigned to the Client. You may also have directly assigned that item to that particular Client. In this case, the Client is both directly and indirectly assigned to the item.

Example: You have assigned Session 1 to Client A. You have also assigned Session 1 to Client Group B. You assign Client Group B to Client A. Therefore, Client A is both directly and indirectly assigned Session 1.

The following table briefly covers the types of assignments available to Clients and their results. The following sections describe in detail each type of assignment and what happens when you assign these types to a Client.

Users Displays the number of users assigned to the application or application group work object.

Table 23. Column headings for the Assignments list box (Continued)

Column Heading Description

Table 24. Assignments available to Clients

Item Results when assigned to Client

Client groups

Work objects assigned to the Client group execute when this Client connects. Executes any Inbound or Both sessions assigned to the Client group. If the Client group includes an Outbound or Both session, then it schedules an outbound session to this Client.


Client group assignmentsAssign one or more Client groups to a Client to make it a member of the group. The Client then appears on the Client group’s Members page. The Client is also indirectly assigned with any sessions or work objects that belong to the Client group.

On the Assignments page, use the Client Groups view to view current assignments or to unassign Client groups.

The list box displays each Client group on a separate line along with its name, description, and number of assigned members, objects, and sessions. An asterisk “*” or ampersand “&” to the left of the name indicates the assignment type. For details, see “Client assignment fundamentals” on page 146.

(Work) Objects

This work object executes when the Client connects or is scheduled for connection by another session. Work objects cannot by themselves schedule an Outbound session.

Sessions The session and its work objects execute when the Client connects. Schedules a connection at the stated time if the session is Outbound or Both.

Users Executes any work objects associated with the user.

Table 24. Assignments available to Clients

Item Results when assigned to Client


On the Assignments page, click Assign to display the Select Client Groups window.

For a description of the other controls in this window, see “Assignments property page” on page 144.

Select defined Client groups in the list box provided. You can select one or more items for assignment.

To display members of the selected group, click Item Detail. You can use this button until you are ready to assign an item to a Client. When finished, click OK.

Object assignments

For a description of each Objects view, see “Table 22. View choices and their results” on page 145.

On the Assignments page, you can use six Objects views to assign or examine work objects or to unassign objects from the Client. Five of these views display a specific object type, and the sixth view displays all assigned work objects. Work objects assigned to a Client execute their tasks every time the Client connects to the Server, unless another system option has disabled the object. Work objects are only executed once a session and do not duplicate their work if assigned to the Client more than once.

The list box displays each work object or group on a separate line. For each object, it lists its name and status; it lists object groups’ members, users, and Clients. An asterisk “*” or ampersand “&” to the left of the name indicates indirect assignments. For details, see “Client assignment fundamentals” on page 146.


For a description of the other controls in the Select Objects window, see “Assignments property page” on page 144.

Click Assign to display the Select Objects window, which lists all objects for the selected view. Select one or more items in the list for assignment.

Click Item Detail to display events for the selected object, or object members for work object groups. In the resulting window, you can click Item Detail until it displays a worklist, ESD, or application work object. To close the windows, click OK.

Session assignmentsOn the Assignments page, use the Sessions view to assign one or more sessions to a Client. The session will execute according to its schedule, or when the Client connects to the Server. If the session is an Outbound or Both type, then it may schedule itself to connect with the Client based on the information on its Schedule page.

The list box displays each session on a separate line along with its name, type, status, and number of assigned objects and Clients.

On the Assignments page, click Assign to display the Select Sessions window.


For a description of the other controls in the Select Sessions window, see “Assignments property page” on page 144.

The list box displays available sessions; select one or more sessions to assign them to a Client.

Clicking Item Detail displays work objects and object groups assigned to the selected session, as well as work object events. To close the detail windows, click OK.

User assignmentsOn the Assignments page, select the Users view to see all users assigned to the Client or to get information on a user. You cannot assign users on this page. If you want to assign a user to a Client, see “Directory Manager” on page 423.

The list box displays each user on a separate line. Each entry shows the user’s full name, address, and Client association.


Information property pageTo view a Client’s storage and memory values, select it on the Client List page and click the Information tab, or on the Pages menu, select Information.

Storage and memory values are marked as Uninitialized until a Client connects and successfully processes the CHECK CLIENT DISK work object.

This page provides the following information:

• Disk Space for <DefaultDrive>. Displays the default installation drive letter; this value originates on the General property page.

• Total. Lists the storage capacity for this drive volume in long form (megabytes plus kilobytes) and in total bytes.

• Free. Lists the available space on this drive volume in long form (megabytes plus kilobytes) and in total bytes.

• Memory. Displays the amount of Total and Free (available) RAM in kilobytes.

Note: If Inventory Manager is installed on the RemoteWare Server, the Information property page displays the selected Client’s hardware, software, and system files detected and reported in the most recent inventory scan. For information about these items, see the RemoteWare Inventory Manager Administrator’s Guide.


Comments property pageThe Comments page includes optional fields for contact and miscellaneous information. Use this page to add notes, contact names, and location information about the selected Client. To display this page, select a Client on the Client List page and click the Comments tab, or on the Pages menu, select Comments.

The RemoteWare system never references the fields on this page, and the Client cannot view them. Use the Name, Phone, Address, City, State, and Zip fields to list up to two contacts at the Client location. In the Miscellaneous text box, list any details about this Client site.

Note: You can provide information on the Comments page to assist in resolving special situations or hardware problems for this Client.


Members property pageThe Members property page lists the Clients and groups that are assigned to a Client group. Use this page to add or remove Clients or groups. To display this page, select a Client group on the Client List page and click the Members tab, or on the Pages menu, select Members.

The top area of this page displays the Client group name. The list box contains an entry for each Client or Client group assigned to this group. For each item, the list box displays the following attributes:

• Name. Displays the Client or group name as it appears on the Client List page. An asterisk (*) or an ampersand (&) indicates that this item is indirectly assigned.

• Type. Indicates whether the item is a Client or Group.

• Description. Displays the free-form description derived from the General page (for Clients) by selecting Change Group Description on the Command menu (for groups).

• Status. For groups, this field is always N/A. For Clients, displays their availability for use (either Enabled or Disabled). Disabled Clients cannot connect to the Server and are not scheduled for a connection.

The Members page also includes these controls:

• View. Displays specific items on the Members page. Click the arrow and select an item in the list. Depending on your selection, the list box displays the entries based on the chosen view (either Client Groups, Clients, or Clients & Groups).


• Search/Select. Use this text box to select or deselect one or more items in the list box. To select an item, type the first few characters of its name and press [Enter]. Use an exclamation point (!) as the first character to deselect one or more items. Make multiple choices by repeatedly keying selections, or use wildcard characters.

• Item Detail. Displays the Clients or groups that are a member of the selected Client group, or displays Client information for the selected Client.

• Unassign. Discontinues the association between this group and the selected Client(s) or group(s). If an unassigned item is a group with indirect assignments, this action may remove one or more entries from the list.

• Unassign All. Removes every member assignment, leaving an empty list box.

• Assign. Associates this Client group with one or more groups or Clients. The next section, “Member assignments,” explains this function.

Member assignmentsTo assign one or more Clients or Client groups to another group, click Assign on the Members page. The Select Clients and Client Groups window appears.

Select items in the list box and click OK to assign them to a Client group. Its members will include all the Clients and groups you select, including all their Clients and groups.

For more details about direct and indirect assignments, see “Client assignment fundamentals” on page 146.

Clients assigned on the Members page run each of the work objects and sessions on the Objects and Session pages. In addition, indirectly assigned Clients run any objects and sessions assigned to their parent group. All objects and sessions scheduled for execution are listed on the Objects Detail page in Schedule Manager.

The items on the Members page indicate which Clients and groups are members; those Clients or groups with an asterisk (*) or ampersand (&) to the left of the name have some form of indirect assignment. Indirectly assigned items are from other Client groups and cannot be unassigned; they must be unassigned from the Client group(s) that have them directly assigned. You can click Item Detail to determine which Client group contains the selected item.


Parents property pageThe Parents page displays the Client groups that include this group as a member. You can use the Parents page to make this group a member of another group. When a group has parent groups, then any work objects or sessions assigned to the parent groups are indirectly assigned to this group. The work objects and sessions appear on the Objects and Sessions property pages.

To display the Parents page, select a Client group on the Client List page and click the Parents tab, or select Parents on the Pages menu.

The top area of the Parents page displays this group’s name. The list box contains an entry for each Client group assigned to this group. Each entry the following attributes:

• Name. Displays the Client or group name as it appears on the Client List page. An asterisk (*) or an ampersand (&) to the left of the name indicates that this item is indirectly assigned from another parent group.

Indirectly assigned groups are assigned to other Client groups and cannot be unassigned from the current group. These groups may be unassigned from the appropriate parent group.

• Description. Displays a short description that was defined when the group was created. To modify this value, click Change Group Description on the Command menu.

• Members. Displays the total number of Clients and groups assigned to the selected group. Click Item Detail to view individual members; these items also appear on the group’s Members page.


• Objects. Indicates the total number of work objects assigned to the selected group. The individual work objects are listed on the selected group’s Objects page, or they appear as indirect assignments on this group’s Objects page.

• Sessions. Indicates the total number of sessions assigned to the selected group. The selected group’s Sessions page lists individual sessions, and these sessions appear as indirect assignments on this group’s Sessions page.

For a description of the controls to the right of the list box, see “Members property page” on page 153.

Parent group assignmentsClick Assign on the Parents page to assign the selected Client to one or more Client groups.

Use this window to choose one or more parent groups. Parent groups include the current group as one of their members (on their Members page). As a result, the Server executes any work objects and schedules any sessions assigned to the parent group for all members in the current group.

When a group has parent groups, then any work objects or sessions assigned to the parent groups are indirectly assigned to this group. The work objects and sessions appear on the Objects and Session property pages.


Objects property pageThe Objects property page lists the work objects assigned to a group. Use this page to associate work objects with each Client in a group.

A work object is a series of events defined in Work Object Editor. The events determine how information is exchanged between the Server and a Client. The Server executes an object during a communications session with a Client; work objects cannot by themselves schedule a session to the Client.

To display the Objects page, select a Client group on the Client List page and click the Objects tab, or select Objects on the Pages menu.

The top area of the Objects page displays the selected group’s name. The list box contains an entry for each work object assigned to the group. For each entry, the list box displays these attributes:

• Name. Lists the work object name as it appears in the Work Object Editor. An asterisk (*) or an ampersand (&) to the left of the name indicates that this item is indirectly assigned from a parent group.

Indirectly assigned work objects cannot be unassigned for individual Clients; they must be unassigned from the Parent group(s) that have them directly assigned.

• Type. Indicates whether the item is a worklist (Wrk), an Electronic Software Delivery (ESD), or a Group (Grp) work object.

• Status. Indicates whether the object is ready to execute (Enabled) or not (Disabled).


The Objects page also includes these controls:

• View. Displays specific items on the Objects page. Click the arrow and select an item in the list to view a specific type of work object or group. The list box displays items based on the chosen type.

• Item Detail. Displays the work object group members or the work object events for the selected object.

For a description of the other controls, see “Members property page” on page 153.

Object assignmentsOn the Objects page, click Assign to assign work objects to this group. Depending on the View setting, one of several windows displays specific work object types.

Worklist, ESD, and Group work objects can be directly assigned to a Client group. Application and Application Group work objects can only be assigned to users. You can use the View control settings to display different work objects or use the Objects (All) setting to view every work object.

Select items in the list box and click OK to assign them to the current Client group. Once assigned, the Server executes the assigned work objects each time a Client in this group connects to the Server.


Sessions property pageThe Sessions property page lists sessions assigned to the selected group. A session is a collection of work objects executed or scheduled for Clients during a communications session with the Server. Use the Sessions page to assign one or more sessions to each Client in the Client group.

To display this page, select a Client group on the Client List page and click the Sessions tab, or select Session from the Pages menu.

The top area of the Sessions page displays the name of the selected group. The list box contains an entry for each session assigned to this group. Each session has the following attributes:

• Name. Lists the session name as it appears in Session Editor. An asterisk (*) or ampersand (&) to the left of the name indicates that the session is indirectly assigned from a parent group.

• Type. Indicates whether the session is Inbound (In), Outbound (Out), or Both. A Client group can have only one In or Both session assigned to it.

• Status. Indicates whether the session is ready to execute. The state is either Enabled or Disabled.

• Objects. Displays the total number of work objects assigned to this session. The Item Detail button displays the individual work object names.

• Clients. Displays the total number of Clients that are currently assigned to this session.


The Sessions page also includes this control:

• Item Detail. Displays the work objects assigned to the selected session. For a selected work object, this button displays its events.

For a description of the other controls, see “Members property page” on page 153.

Session assignmentsOn the Sessions page, click Assign to assign one or more sessions to this Client group. The Select Sessions window appears.

Use this window to choose sessions for assignment.

Select items in the list box and click OK to assign them to the current Client group. Once assigned, the inbound session executes each time the Client connects to the Server. The Server schedules outbound sessions according to the Schedule page (in Session Editor) or executes the session during an inbound call if the session is pending.

Note: You can assign any number of Outbound or Process Only sessions to the Client group; however, you can assign only one Inbound or Both session to a group.

M a k e - K i t I n s t a l l a t i o n W i z a r d 161

Make-Kit Installation Wizard Tip: To create a makekit, you must first select a Client on the Client List page. The makekit is based on the Client you select. For step-by-step instructions, see the RemoteWare Server Administrator’s Guide.

On the Command menu, select Make Installation Kit to collect and copy the files necessary to define a Client on another computer. This operation is called a “Makekit.” The Make-Kit Installation Wizard appears.

In the first wizard window, you can select one of the following options:

• Template Installation Kit. When selected, creates a template Client. Use template Clients to rapidly and conveniently propagate many Clients with the same definition or very similar configurations. During installation, the software may prompt the user for information required by the administrator, or the software may install itself silently using responses provided by an administrator-defined control file. For information about the windows that appear for template installation kits, see “Template Installation Kit” on page 162.

For more information about the registration process at the Client, refer to the Client User Guides; for details about registration at the Server, see “Client Registration Options window” on page 175.

• Create 32-bit Upgrade. (Available only when you select a 32-bit Windows Client before launching the Make-Kit Wizard.) Select this check box when converting or migrating any existing Windows 3.1x Client to a Windows 98 or Windows NT/2000/2003/XP Clients. This creates a local makekit that is sent to the 16-bit Client when the RWS Upgrade Windows to 98 or NT/2000/2003/XP Client work object executes. For details about the windows for 32-bit upgrades, see “Create 32-bit Upgrade” on page 172.

• Run Client As Service. Use the Makekit Wizard to create an installation kit to install the RemoteWare Client to run as a service. The Run Client As Service option completes only the configuration portion of the “client service” installation. The Client must then run setup.exe to complete the service installation process. For details about the windows to appear, see “Run Client As Service” on page 170.


• Neither. If you do not select a check box in this window, a regular Client makekit is created. Click Next to continue. For information about the windows that appear for makekits, see “Regular Client makekit” on page 171.

The following sections describe each window and option in the Make-Kit Installation Wizard. Options vary depending on the type of makekit you create. For step-by-step instructions on creating makekits, see the RemoteWare Server Administrator’s Guide. For information about the files created for a makekit, see “Files created in a makekit” on page 173.

Template Installation KitThis section describes the windows that appear after you select the Template Installation Kit check box in the first wizard window. Depending on the type of Client you originally selected and the applications installed on your Server, one or more of these windows may not appear in the wizard.

This window is part of the Make-Kit Installation Wizard for template installation kits. For more information, see page 161.

Make Kit Directory window


In this window, select a Server location for the Client installation kit files. Options are:

• Make Kit Directory. Indicates the Server path and directory for the resulting Client installation kit files. You can enter a UNC name, such as \\MyServer\MakeKits, or you can use a fully qualified path, such as C:\MyServer\Makekits.

To browse for a location, click ; the Browse for Folder dialog box appears. Navigate to the appropriate folder and click OK. This populates the Make Kit Directory field with the directory you selected.

• Back. Returns to the previous window.

• Next. Accepts your changes and moves to the next window.

• Finish. Accepts your changes and skips to the summary window, which outlines the options you have selected for this template Client.

• Cancel. Closes the Make-Kit Installation Wizard without creating a makekit.

Control File window

Note: The Control File window appears only for 32-bit Windows Clients when you create a makekit or template makekit. It does not appear for 32-bit upgrades.


This window is part of the Make-Kit Installation Wizard for template installation kits. For more information, see page 161.

Use this window to include a control file with the Client installation kit. A control file (Silent.ini) provides information that you specify during Client installation. You can use these files to automate installation on the Client machine or to install the Client software silently, without requiring user input.

Options in this window include:

• Include Control File. Adds a control file to the Client installation kit. When you select this check box, click to display the Open dialog box. Locate the control file (Silent.ini) and click Open. This populates the read-only text box in the Control File window with the path of the control file you selected.

For information about the required format of the control file, see “Control file (Silent.ini) format” on page 164.


• Next. Accepts your changes and moves to the next window in the wizard.



Control file (Silent.ini) formatThe following table shows the format for the control file, which must be named “Silent.ini.”

Table 25. Silent.ini file format

INI file format Description

[client]

Silent= Yes or No. If this entry is blank or missing, assumes No as the default. This entry is not case sensitive (“Yes” is the same as “yes” or “YES”).Note: Must be set to “Yes” if running as a service.

InstallDir= Specify the full path to the Client installation directory. If you do not specify a path, C:\Program Files\Remote is used by default.


Client Name= Specify up to 8 characters as the default Client name for this template installation kit. A value longer than 8 characters is truncated. The Client setup program ignores this value if you do not select Prompt for Client Name in the Template Client Options window.

Serial Number Specify the serial number for a RemoteWare server in thesilent.ini file for a template client install.

Password= Enter up to 11 characters as the default Client password for this template installation kit. The Password value is ignored if this is not a template Client.

Location= Enter up to 22 characters as the default Client location for this template installation kit. The Location value is ignored if this is not a template Client.

Register Client= Yes or No. By default, the Client setup program registers the Client, but you can specify “No”. Setup only installs the Client and does not register it.

Contact Name= Enter up to 27 characters as the default contact name for this template Client installation kit. The Contact Name value is ignored if this is not a template Client.

Contact Address1= Enter up to 27 characters as the default address for this template installation kit. The Contact Address1 value is ignored if this is not a template Client.

Contact Address2= Use this entry to specify up to 27 characters as the second contact address for this template installation kit. The Contact Address2 value is ignored if this is not a template Client.

Contact City/State= Specify up to 27 characters as the default city and state for this template installation kit. The Contact City/State value is ignored if this is not a template Client.

Contact Zip= Use up to 11 characters to specify the default zip code for this template makekit. The Contact Zip value is ignored if this is not a template Client.

Contact Phone= Enter up to 17 characters for the default phone number for this template Client. The Contact Phone value is ignored if this is not a template Client.

Desktop Icon= Yes or No. By default, Client setup places an icon on the desktop. Enter “No” if you do not want a desktop icon added.

Start Menu Path= Specify the default Start menu path for the Client. The default path is Programs\RemoteWare.

Table 25. Silent.ini file format (Continued)



Default Entry= Specify a default entry name to force the Client setup program to use this entry to connect when registering a template Client. The Default Entry value is ignored if this is not a template Client.

Start Kernel= Yes or No. If yes, starts the kernel when setup is finished. By default, the Client setup program does not start the kernel.Note: Must be set to “No” if running as a service.

Start Client= Yes or No. If yes, starts the Client software when setup is finished. By default, the Client setup program does not start the Client.Note: Must be set to “No” if running as a service.

UnattendedReboot= Yes or No. If yes, allows the Client setup program to restart the Client computer if necessary during installation. The UnattendedReboot value is ignored if this is not a silent installation (Silent=No).

[Resource1] The Resource sections are numbered 1 through 5. These correspond to the five system-defined resources you can assign to the Client in Client Profile.

TcpipAddress= Enter the Server’s TCP/IP address to force the Client setup program to use this address as the default. If you do not specify a value for this entry, setup detects the Server’s address automatically.

SpxAddress= Enter the Server’s SPX address to force the Client setup program to use this address as the default. If you do not specify a value for this entry, setup detects the Server’s address automatically.

Server Phone Number= Enter the Server’s asynchronous phone number to force the Client setup program to use this number as the default. If you do not specify a value for this entry, the Client uses the number defined at the Server as the default.

Modem Type= Specify the Client’s modem type to force the Client setup program to use this modem type as the default. If you do not specify a value, the administrator-defined modem is used.

Com Port= Specify the Client’s COM port to force the Client setup program to use this number as the port. If you do not specify a value, the administrator-defined COM port is used.

Data Rate= Enter the data rate for the Client’s modem to force Setup to use this number as the default data rate for the defined modem. If you do not specify a value, Setup uses the administrator-defined data rate.

Client Phone= Type the Client’s ASYNC phone number to force Setup to use this number as the default Client phone number. If you do not specify a value, Setup uses the administrator-defined Client phone number.

[Resource2], [Resource3], [Resource4], and [Resource5]

Same options as [Resource1]

Table 25. Silent.ini file format (Continued)



Client Options window

This window is part of the Make-Kit Installation Wizard for template Client installation kits. For more information, see page 161.

Use this window to include ESD files and select an installation language for the template makekit.

•Include User Defined ESD Files. Copies any user-defined ESD work objects assigned to this Client to the destination drive. This option reduces the initial connect time for Clients with many assigned ESD work objects. This selection could increase the storage needed and increase the number of

disks in the Makekit.

• Installation Language. Displays the supported language for the Client installation, user interface, and online Help operations. This list box is unavailable for 32-bit Windows Clients, which automatically determine the language used based on Client system settings.






Template Client Options window

Note: To add a control file outside of the Make-Kit Wizard add the full path to the control file on a command line. The command line method overrides the control file (Silent.ini) in the makekit archive, if one already exists.


In this window, specify whether to prompt the Client user for information during the installation. Options in this window are:

• Prompt for Serial Number. When selected, the Client installation software prompts the user for the Server serial number. Use this option to provide an additional level of security.

• Prompt for Client Name. When selected, requires the template Client user to enter a Client Name. If the name is unique in the RemoteWare system, the Server uses this name to create the Client.





User Template Options window


Use this window to specify Messaging-related options for the template Client installation kit. Options include:

• Prompt for User Information. Asks the Client user for information to create a user entry for RemoteWare applications. This option creates a new user in Directory Manager based on the information the Client user enters, and, if applicable, the default user specified in the Use as template user field.

• Use as template user. (Available only when the Prompt For User Information check box is selected.) This read-only field displays the user defined in Directory Manager that serves as the default model for template Clients. To select a new template user, click to display the Choose User dialog box.

Note: This window only appears when Messaging is installed on the RemoteWare Server.


This dialog box includes:

• Select template user. Select the user upon which the template Client is to be based. When no users are assigned to a Client, this field lists all users.

• Show users assigned to this client only. Displays only the users assigned to the selected Client. Users are assigned on the Assignments page (Client Profile) and in Directory Manager.

• Show all users. Displays local users from the Directory Manager program.





Enable Registration window


This window reminds you template Clients cannot register unless you enable Client Registration on the RemoteWare Server. Options are:

• Enable Client Registration. Select this check box to turn the Client registration option on for this RemoteWare Server. This is a system setting; it does not apply to individual makekits. You can enable this option during system rollout and then disable it once all Clients have been created.



Note: This window appears only when you have disabled Client Registration on the RemoteWare Server.




Summary windowUse this window to review your choices for the template Client makekit. To make changes, click Back. To create the makekit with the current settings, click Create. Or click Cancel to close the wizard without creating the makekit.

Run Client As ServiceTo create a Run Client as Service makekit, select the Run Client As Service check box in the first Make-Kit Installation Wizard window. Click Next to continue.

MakeKit Client Service InformationThis window is used to specify the account where the service should be installed.

The default indicates Use existing service account information. If you leave this checkbox, the client service is installed under the LocalSystem account.

If you remove the check mark, this allows the user to enter User Name and Password. The user can specify a different account.

• OK. Accepts your changes.

• Cancel. Closes the Make-Kit Installation Wizard without creating a makekit.The wizard displays the Welcome Makekit Wizard again, click Next.


The next windows to appear are the same as those used in the regular makekits. These windows include:

1 Make Kit Directory window. For details, see “Make Kit Directory window” on page 162.

2 Control File window. For a description, see “Control File window” on page 163.

3 Client Options window. For information, see “Client Options window” on page 167.

4 Summary window. For details, see “Summary window” on page 170.

Regular Client makekit For details about the Make-Kit Installation Wizard, see page 161.

To create a regular Client makekit, do not select a check box in the first Make-Kit Installation Wizard window. Click Next to continue.

This section lists the wizard windows that appear for regular makekits. These windows are the same as the ones used during the creation of template makekits (but the template Client-related windows do not appear).

1 Make Kit Directory window. For details, see “Make Kit Directory window” on page 162.

2 Control File window. For a description, see “Control File window” on page 163.

3 Client Options window. For information, see “Client Options window” on page 167.

4 Summary window. For details, see “Summary window” on page 170.

Note: Depending on the type of Client you originally selected and the applications installed on your Server, one or more of these windows may not appear in the wizard.


Create 32-bit Upgrade These windows are part of the Make-Kit Installation Wizard. For more information, see page 161.

This section describes the windows that appear after you select the Create 32-bit Upgrade check box in the first wizard window.

Click Next to proceed to the Summary window.

Summary windowIn this window, review your choices for the Client makekit. If you need to make any changes, click Back. To create the makekit using the current settings, click Create. Or, you can click Cancel to close the wizard without creating the makekit.

When enabling Client registration, you must also select the Allow Registration to Create New Clients option or the registration process will not be able to create system-named Clients or user-named Clients.

Progress windowThis window displays the progress of the makekit creation process. When the makekit is complete, click OK to return to Client Profile.


Files created in a makekit For information about the Make-Kit Installation Wizard, see page 161.

When you create a Client installation kit using the Make-Kit Installation Wizard, you actually create the Client install image on the RemoteWare Server. This install image contains files that the Client installation program (Setup.exe) uses. Required files are located in the directory you selected in the wizard; for details, see “Make Kit Directory window” on page 162. These files are:

• Setup.dat. The files required for set up.

• Client32.000. The archive of the compressed Client installation files that need to be installed on the Client machine. This file exists for makekits that reside on fixed (not removable) drives.

• Client32.DFI. The index file for Client32.000. Setup.exe uses this file to determine the location of a specific file in the archive.

• Client32.D00. The archive of the compressed Client installation files that need to be installed on the Client machine. This file exists for makekits that reside on removable drives. The “D” represents “data” and the following numbers indicate the disk number.

• Client32.I00. The index file for Client32.D00. Setup.exe uses this file to determine the location of a specific file in the archive. The “I” represents “index” and the numbers following the I indicate the disk number.

• Instutil.dll. An internal DLL that contains install functions used by Setup.exe.

For more information about creating Client makekits, see the RemoteWare Server Administrator’s Guide.

Note: On a Template Client, multiple registry entries are created. One registry entry will contain the Makekit profile name and one entry will be the unique Client name generated from the Makekit.


Registration menu overviewThe Registration menu contains commands to activate and manage the template Client registration process. Use template Clients and the registration process to conveniently propagate many Clients with the same definition or very similar configurations. The process of creating a template Client is similar to a that for a regular Client, but template Clients use the Template Installation Kit option in the Make-Kit Installation Wizard. For details, see “Make-Kit Installation Wizard” on page 161.

The Server creates all template Clients in an unregistered state and automatically registers all Clients during their first connection. Depending on the settings in the Client Registration Options window, template Clients may require additional steps for registration.

The following table lists the commands on the Registration menu.

Table 26. Registration menu options

Menu command Description

Options Displays the Client Registration Options window. Use this window to enable registration on this Server or cluster and set global requirements for all template Clients.

Manual Verification Opens the Select Clients to Verify window, where you can verify or delete Clients that have not completed the registration process.

Schedule Registration Session Displays the Select Clients for Registration Session window. Here, you can schedule an outbound session to complete the registration process for the selected unregistered Clients.

R e g i s t r a t i o n m e n u o v e r v i e w 175

Client Registration Options windowOn the Registration menu, select Options to display the Client Registration Options window. This window contains these controls:

• Enable Client Registration. Select this check box to turn the Client registration option on. You can enable this option during system rollout and then disable it once all Clients have been created.

• Allow Registration to Create New Clients. Select this check box to automatically create a Client when a template user connects to the Server. You can set additional requirements for creating a Client by using the following two options.

• Client Prefix. Appends the specified prefix to the name of any template Client created on the Server. (This option is unavailable when you select Prompt for Client Name in the Template Client Options window of the Make-Kit Installation Wizard.)


• Client Counter. Specifies the starting number to append to the Client Prefix. Each new Client uses this value and then increments the counter. (This option is unavailable when you select Prompt for Client Name in the Template Client Options window of the Make-Kit Installation Wizard.)

• Default template user. Optionally select a user from the Directory Manager user database that will serve as a default model for template Clients. To select a different user, click Change; the Choose User dialog box appears.

This dialog box includes:

• Select template user. Displays the currently selected user. When no users are assigned to a Client, this control lists all users. Choices depend on Client user assignments and which of the additional two options is selected.

• Show users assigned to this client only. Displays only the users assigned to this Client. Users are assigned on the Assignments page (Client Profile) and Directory Manager.

• Show all users. Displays all local users in the Directory Manager program.When creating a template Client, the label “<Default> User name” appears in the Use as template user field in the Make Installation Kit window. If necessary, you can override this value during the Makekit process; to do this, use one or both of the following options in the Client Registration Options window.

• Require Administrator Verification. Select this check box to require manual approval of all new Clients before registration is complete. Until an administrator approves a Client, assigned objects will not execute for that Client during a communications session.

• Require Registration Key. Select this check box to require the Client user to enter the same registration key as the one you specify in the text box. You can use this security feature to prevent unauthorized access, and you can change the key periodically to implement an expiration date for the Client installation.

R e g i s t r a t i o n m e n u o v e r v i e w 177

Manual verificationOn the Registration menu, select Manual Verification to verify template Clients that have connected to the Server but still require verification to complete the registration process. The Select Clients to Verify window appears.

Select one or more Clients to verify in the list box. Click OK to verify your choices.

Schedule Registration SessionSelect Schedule Registration Session on the Registration menu to schedule an outbound registration session for one or more unregistered Clients. Use this option if unregistered Clients are accessible from an outbound session.

Note: This window is blank unless you have selected the Require Administrator Verification check box in the Client Registration Options window and Clients have attempted to register.


The list box displays all enabled unregistered Clients. Select one or more Clients in the list, or use the following controls to select and schedule registration sessions:

• Search/Select. Use this text box to select or cancel the selection of one or more Clients in the list. To select a Client, type the first few characters of its name and press Enter. Use an exclamation mark “!” as the first character to cancel the selection of one or more Clients. You can repeatedly type selections in the Search/Select box to select more Clients, or use wildcard characters to select several Clients at once.

• Item Detail. Displays the Client information for the selected Client.

• All Clients. Click this button to immediately begin scheduling the registration session for all Clients in the list box. The Registration Confirmation window appears; use this window to schedule all Clients, selectively schedule sessions, or stop scheduling Clients.

• OK. Starts scheduling the registration session for selected Clients. The Registration Confirmation window appears; use this window to schedule all selected Clients, selectively schedule sessions, or stop scheduling Clients.

• Cancel. Closes the window and returns to the Client list.

C H A P T E R

6

Work Object Editor

Work objects (or “objects”) are the fundamental units of activity for all work on and

between the Server and Clients. Use the Work Object Editor to build, manage, and

assign the objects needed to complete tasks with RemoteWare.


• “Work Object Editor at a glance” on page 180




Work Object Editor at a glanceWork objects are lists of tasks or events that execute during a connection with a Client or as part of a session. Work objects perform tasks using events, which are commands used to instruct RemoteWare to complete an operation. Further, object groups organize one or more work objects as one unit instead of as separate objects.

Work Object Editor consists of the property pages listed in the following table. These property pages define the object’s execution basis, performed tasks, and assignments to other RemoteWare components.

Table 27. Work Object Editor property pages

Property page


Objects Display defined work object names, owner, type, and status. On this page, define new objects or view, filter, copy, rename, delete, enable, or disable objects.

186

General Attributes

Set execution limits and enable/disable the object. Limits include by Client type, daily window, or active dates and times.

192

Application Attributes

Application work objects use this page to define the application, its working path, command line input, and launch mode at the Client.

195

Events Create, view, and edit events that make up a worklist or ESD object.Note: Appendix A, “Events” on page 441 discusses the individual events in detail.

196

Members The group and application group objects use this page to list individual objects (not groups) in their group. Use to display, add, or remove objects from the group.

200

Sessions List which sessions are assigned to this object, either directly or through another object group. Objects assigned to a session are scheduled to run based on the object’s and session’s characteristics.

204

Clients Show the Clients assigned to this object. Objects assigned to a Client run when the Client connects, based on the object’s, Client’s, and session’s characteristics.

206

Users From an application or application group object, use this page to view, add, and remove user assignments to the object. Objects with user assignments execute whenever that user connects with the Server.

208

Wo r k O b j e c t E d i t o r a t a g l a n c e 181

Work object types For information about the General Attributes page, see “General Attributes property page” on page 192.

You use the Work Object Editor to build the Work Object types. When and how an object runs depends on settings on the General Attributes property page and the object’s assignments.

• ESD (Electronic Software Distribution). An ESD object is a set of events that electronically distribute software or files residing on the Server. The ESD object may also contain events that execute before and/or after the ESD events. Refer to the RemoteWare Server Administrator’s Guide for additional information on ESD Auto Apply.

• Worklist. A Worklist object is a set of events that execute during a communications session between the Server and Client. Worklist objects can also perform tasks at the Server (such as deleting or renaming files) without a Client connection.

• Group. Group objects contain existing ESD and Worklist objects. Use groups to collect a set of related work objects, or to group similar objects that perform differently based on the executing environment (for example, similar tasks for different Client types in the RWS System ESD group object).

• Application. Application objects consist of previously defined ESD, Worklist, or Group objects. Application objects distribute, maintain, and execute applications at the Client.

• Application Group. Application Group objects consist of Application objects that you have already built. Grouping application objects makes complex application assignments easier.

• Multicast. Multicast work objects consist of a set of events executed through a Multicast session. On the Server, these work objects can contain any Before events. On the Client, only the Send, Execute, and Delete events can be run.

ExecutionSome of the reasons objects may or may not execute include General Attributes settings, object assignments, session restrictions, Server restrictions, and Client task

Parents Display which group and application group objects include this object on their Members page. Assign this object to a group, and run this object whenever the parent group executes.

210

Table 27. Work Object Editor property pages (Continued)

Property page



selections.

Use the General Attributes property page to limit or restrict work object execution for any object. Controls on this page provide the ability to:

• Enable or disable the object.

• Define an execution window, specifying the daily active timespan for the object.

• Set an activation and/or deactivation date, setting the date and time when an object can execute.

• Limit the object’s execution to one or more Client type(s).

• Assign a priority to order the object’s execution within a session.Work object assignments on the Clients, Sessions, and Users pages also determine when an object runs.

• Clients. Assign worklist, ESD, or group work objects to a Client to have the object execute each time a connection takes place with an assigned Client.

• Sessions. Assign worklist, ESD, or group work objects to a session to automatically execute the object whenever that specific session runs.

• Users. Assign application objects and application group objects to users and/or user groups to run the object each time a connection takes place with an assigned user’s Client.

You can give a Client the ability to execute selected session work objects if you select the Inbound Work Object Selection check box on the General page in Client Profile. (For details, see “General property page” on page 135.) The Client user can select which work objects execute during an inbound connection to the Server. A Client can only select objects with an execution type of Default or Requestable, or that are assigned to an inbound sessions, the Client, or the user.

When an object doesn’t executeAlthough a work object may be defined and enabled, it is not executed unless it is assigned to a session, Client, or user. You assign sessions and Clients to ESD, worklist, and group objects. You assign users to application and application group objects.

Certain other conditions may cause the object not to execute, such as if:

• It is an ESD or application object and the ESD or Applications check box is not selected on the Settings page (Server Profile), General page (Client Profile), or Options page (Session Editor).

• The Limit execution to assigned Session Objects option is selected for the session.

• The object is disabled.

Wo r k O b j e c t E d i t o r a t a g l a n c e 183

• The object is outside the object execution window.

• The object is limited to certain Client types.

• The object has exceeded the deactivation time.

• The object is deactivated at the Client.

For a list of additional explanations, see “Table 42. Reasons why objects do not execute” on page 258.


Menu commands For a list of general RemoteWare commands, see “Menu commands common to most programs” on page 25. Commands marked with an * asterisk are also available from a shortcut menu.

The following table lists the menu commands specific to Work Object Editor.

Table 28. Work Object Editor menu commands

Menu Command Button Page Description

File New ESD Object

Objects Creates an ESD object type.

New Worklist Object

Objects Creates a new Worklist object.

New Group Object

Objects Creates a new Group work object.

New Application Object

Objects Creates an Application object.

New Application Group Object

Objects Creates an Application Group object.

NewMulticast Object

Objects Creates a Multicast object.

*Copy Objects Duplicates an existing object.

*Rename Objects Changes the name of an existing object.

*Delete Objects Removes an object from the list.

Import Events Copies events from a file into the current worklist object.

Export (selected) Events Copies selected events to a file.

Command *Enable*Disable

Objects Makes the selected object available or unavailable for execution.

Edit ... Events Manipulates existing events. For details about the Edit and Add Events commands, see “Events property page” on page 196.

Enable Event Events Enables a previously disabled event.

Disable Event Events Disables an event.


Add Events

... Events Creates events.

Filter ... Objects View only the objects that match search characteristics. For details, see “Filter menu” on page 188.

Table 28. Work Object Editor menu commands (Continued)

Menu Command Button Page Description


Property pagesThe following topics provide information about the Work Object Editor property pages.

Objects property pageThe Objects property page displays every defined work object on this RemoteWare system. Use this page to define new objects, modify object names, and enable, disable, copy, or delete existing objects. The tabs at the top of the window change based on the object type selected.

This page appears when you open the Work Object Editor. This page also displays when you select Objects from the Pages menu.

The total number of objects defined and enabled displays at the top of the page. Each object appears on a separate line. For each object, the following information appears:

• Name. Displays the name of the object, which you specify when you first define the object (menu command File New) or when you rename the object (menu command File Rename). Object names (1 to 41 characters) must be unique.


Several objects are created for your system during installation. Altering or disabling these preinstalled or SYSTEM owned objects is not recommended.

The symbol to the left of the name indicates the state of the object. A green circle indicates an enabled object; disabled objects use a gray circle.

• Owner. Indicates who created this object. This value determines who can use or change the object. Some of the current Owner values include:

• Type. Indicates whether the item is an ESD, Worklist, Group, Application, Application Group or Multicast object. The object’s type is determined when it is created, and defines how the object can be used.

• Status. Indicates whether the object is Enabled (available for execution) or Disabled. Even though an object is enabled, it may not execute. For details, see “When an object doesn’t execute” on page 182.

Table 29. Owner types

Owner Description

USER Objects defined by a RemoteWare Server administrator. Administrators can create, modify, and delete any existing USER object.

SYSTEM Objects defined by the RemoteWare Server. Administrators can modify the object’s attributes, but cannot delete or modify the object itself or change the event list.

RWS These objects belong to RemoteWare Software Manager.

RWSUB These objects belong to RemoteWare Subscriber.

RWWORKSHOP These objects belong to RemoteWare Workshop.

Table 30. Work object types

Type Object Description

ESD ESD object Distributes and updates files to Clients. Also performs maintenance tasks before or after the ESD.

Wrk Worklist object Events that execute on the Server, or during a communications session between the Server and Client.

Grp Group object Organizes existing ESD and Worklist objects as one group entity.

App Application object Maintains and executes applications at the Client. May contain defined ESD, Worklist, or Group objects.

AppGrp Application Group object Consists of a set of Application objects.

MC Multicast object Multicast work objects consist of a set of events executed through a Multicast session. On the Server, these work objects can contain any Before events. On the Client, only the Send, Execute, and Delete events can be run.


Filter menuUse the Filter menu to display specific items on the Objects page. Select a filter to list objects with a common characteristic, such as all disabled ESD work objects.

You can combine filters as needed; each filter is cummulative of any filter already in use until you choose the Remove All Filters command. To use any filter or combination at a later date, you can write the current filter settings to a file. You can then read the filter file to apply its settings to the list box on the Objects page.

Table 31. Filter menu commands in the Work Object Editor

Button Filter menu command

Description

by Selected Objects Selects objects by name to appear in the listing. For more information, see “Filter by Selected Objects” on page 189.

by Object Owner Lists all objects that belong to specified owner(s). For details, see “Filter by Object Owner” on page 190.

by Enabled Objects The green indicator displays objects that are available for execution. Use this command together with other filters to display objects with a specific owner, or those of a specific type.

by Disabled Objects

The gray indicator displays objects that are not currently available for execution. Use this command together with other filters to display objects with a specific owner, or those of a specific type.

by ESD Objects Displays only ESD objects in the list box.

by Worklist Objects Displays only Worklist objects in the list box.

by Application Objects

Displays only Application objects.

by Application Group Objects

Displays only Application Group objects.

by Group Objects Displays only Group objects.

by Multicast Objects

Displays only the Multicast objects.

Remove All Filters Discards all filter settings and displays every object. For details, see “Managing filters” on page 191.

Read Filters Selects and uses a predefined filter file.


For information about these commands, see “Object type filters” on page 190.

Filter by Selected ObjectsUse this menu command to display specific objects on the Objects page. When you click by Selected Objects on the Filter menu, the Select Objects window appears:

The Select Objects window initially displays all objects. Select one or more objects to display by:

• Manually selecting objects. Click an object in the list to select it; to cancel the selection, press [Ctrl] and click it again. You can select multiple adjacent objects with the mouse, or press [Ctrl] to select objects that are not next to each other.

• Narrowing the view. By default, the View drop-down list displays all objects. To narrow the view, select an object type in the View list. Prior selections you made in other views are not discarded.

• Using the Search/Select text box. Use the Search/Select text box to select one or more items in the list box. Type the first characters of the object’s name and press [Enter] to select it. Use an exclamation mark “!” as the first character when you want to clear the selection from one or more items. You can repeatedly type characters in this box to select additional objects.

The Select Objects dialog box also includes the following buttons:

• Item Detail. Displays an object’s events or a group object’s members for the selected item. You can use this control until the events appear for worklist or ESD objects.

Write Filters Creates a file that contains the current filter settings.

Table 31. Filter menu commands in the Work Object Editor (Continued)

Button Filter menu command

Description


• Remove Filter. Similar to Cancel, but in addition to discarding changes, also deletes settings from this filter category. Use this button to selectively remove one of several filter settings in a filter combination.

• OK. Accepts your settings and displays the selected items on the Objects page.

• Cancel. Discards selections and changes made in this dialog box. Preserves any filter settings present before you selected the Filter menu command.

Filter by Object OwnerUse this menu command to display every object belonging to a specific owner. When you click by Object Owner on the Filter menu, the Select Object Owner Types window appears:

This window displays a list of owner types; for a description of each, see “Table 29. Owner types” on page 187. Select one or more owner types in the list box and click OK to display the work objects belonging to that owner.

For descriptions of selection techniques and buttons in this dialog box, see “Filter by Selected Objects” on page 189.

Object type filters

For a description of the different work object types, see “Table 30. Work object types” on page 187.

To display all objects of a certain type, select by ESD Objects, by Worklist Objects, by Application Objects, by Application Group Objects, by Multicast Objects, or by Group Objects on the Filter menu. Only one of these filters may be active at any time. These filters may be toggled on the menu or the toolbar.


Managing filtersOn the Objects page, select the following Filter menu commands to deactivate all current filter settings, save a filter combination for later use, and retrieve and apply filter settings.

• Remove All Filters. Immediately removes every filter applied to the Objects page. On the Work Object Editor menu bar, “Filter – ON” changes to “Filter – OFF.”

• Read Filters. Opens a dialog box that you use to select an existing filter file to filter the items on the Objects page.

• Write Filters. Saves the current filter setting to a file for future use. Select Read Filters on the Filter menu when you want to reuse a filter file.


General Attributes property pageThe General Attributes property page contains the object’s status, priority, and execution criteria. This page automatically appears after you create and name a new work object.

To display the General Attributes page, select an object on the Objects page and click the General Attributes tab, or select General Attributes from the Pages menu.

Use the General Attributes page to view or set the following information:

• Owner. Displays the object’s owner. All objects that you create have the owner USER; for a description of the other owners, see “Table 29. Owner types” on page 187.

• Enabled. Select this check box to allow the object to execute. In order to prevent an object from executing unexpectedly, you may want to disable it until you have completely defined it. By default, this check box is not selected.

• Execution. Determines how the Client user controls execution of this work object. Click the arrow to display or set other execution values. Possible values are:

• Default. Executes normally unless disabled by the Client. Clients can only disable this object under the following conditions: the object is assigned to an inbound session, the object is assigned directly to the Client, the Client can perform inbound connections, and the Inbound Work Object Selection check box is selected on the General page in Client Profile.

Note: The object’s name is always displayed on the title bar.


• Forced. Specifies that the work object cannot be disabled by the Client and is not available to for viewing by the Client.

• Requestable. Never executes unless explicitly requested by a Client. Since Clients can only request objects assigned to inbound sessions, requestable work objects assigned to outbound sessions never execute. In addition, the Client must have Inbound Work Object Selection enabled (Client Profile, General page) to be able to request the objects.

• Priority. Determines the execution order during a session. Groups and application groups do not use priorities; ordering is determined by the priorities of the ESD and Worklist members in a group. Zero (0) is the lowest priority, 250 is the highest priority, and the default is 125. For example, if three objects, A, B, and C, whose priorities are set at 35, 250, and 105 respectively, are assigned to a session, the objects are executed in the order B-C-A (250, 105, 35).

Use the spin box to set the priority.

For information about creating Makekits, see “Make-Kit Installation Wizard” on page 161.

• Execution Window. Specifies a daily time period when the object can execute. By default, the Enable check box is not selected; the work object executes without time restrictions. Since the object executes on the Server, the time range is relative to the Server’s time.

To change the time, select the Enable check box and click the accompanying button. In the window that appears, set the time range in 24-hour format.

Note: If the Client user manipulates tasks in the Inbound Tasks for Selection box, then new Default objects are added as disabled objects. In order for the new object to operate, the Client user must enable the new work object and reset the task to the default entries, or the administrator must specify Forced execution for the new object.

Note: The range 00:00:00 to 00:00:00 does not indicate a 24-hour range. To execute at any time, clear the Enable check box.


• Limit Object Execution to Client Type(s). Restricts execution by one or more Client types. By default, the <unlimited> value makes this object available to all Clients. Use this option to execute an object specifically designed for an individual Client operating environment.

Select the Enable check box and click the adjacent button to display the Limit Object Execution dialog box. In this dialog box, select one or more of the available RemoteWare Client types: • AIX Client• AIX TCP/IP Client• DOS Client• DOS Client NETBIOS• HP UNIX Client• HP UNIX TCP/IP• IBM 4690 Client• IBM 4690 TCP/IP• OS/2 Client• SCO UNIX Client• SCO UNIX TCP/IP• UnixWare Client• UnixWare TCP/IP• VMS Alpha Client• VMS Alpha TCP/IP• VMS VAX Client• Windows 98 Client• Windows NT/2000/2003/XP Client

• Activation/Deactivation. Use these options to execute a work object starting at a certain date and time, up to a date and time, or during a date and time period. The date and time are relative to the Server, which uses a 24-hour clock. For example, an object that collects year-end data may start in January and stop in February. Another object which controls an upcoming sales promotion can be set to activate in nine months, with no deactivation.

Select the Enable check box(es) to set the date and time for the Activate on: or Deactivate on: fields. Click the button(s) to change the date and time. In the dialog boxes that appear, select the portion of the date (month, day, or year) or time (hour, minute, or second) that you want to change; use the spin boxes to specify the new date or time.


Application Attributes property pageApplication objects have an Application Attributes property page; use this page to define the execution settings. To access the Application Attributes page, select an application object and click the Application Attributes tab, or select Application Attributes from the Pages menu.

The top area of the page displays the name of the application object. Below the name, the page contains the following fields:

• Executable file. Specifies the path and file name for the program’s executable or batch file on the Server. Click Browse to display a list of files, drives, directories, and networks; use the selection window to locate the executable file.

• Working dir/path. Displays the path and name of the directory where the program files for this program are located and where new files will be located.

• Command line. If the program requires startup arguments or command line options, then type the text in this field. Use the %u variable to insert the user name in the command line, or add %p to include a password. The Client software substitutes the actual user name and password defined in the Messaging Administration program.

Note: The Executable file field is used exclusively for RemoteWare. Unless required by the RemoteWare application, values in this field will be ignored.


Events property pageFor ESD and Worklist objects, use the Events property page to specify what happens when the object executes. The events listed on this page define the task order and details associated with the object.

Display the Events page by selecting an ESD or Wrk (worklist) object and clicking the Events tab. Or, click Events on the Pages menu.

When you display the Events page, two additional menus appear on the Work Object Editor menu bar: Edit and Add Events. The File menu also contains additional commands. These items are discussed in the sections that follow.

On the Events page, the list box displays the event and flags list for the selected object. Flags are symbols that indicate when and where the event executes, as well as other special behavior. The Events listed depend on the option selected in the bottom area of the page. Each option displays events for specific functionality:

• Session events. (Active for worklist objects only.) Displays the list of events associated with a worklist object.

Because of the optimized nature of ESD objects, user defined variable values in Pre-, Post-, and ESD events cannot be transferred to subsequent worklists or objects.

• Pre-ESD events. (Active for ESD objects only.) Displays the events that execute before the ESD events execute. These events will not execute if the ESD events list is empty.

• ESD events. (Active for ESD objects only.) Provides a very limited list of events to more efficiently transfer files to the Client; also performs basic file and directory maintenance at the Client. This list must contain at least one event in order to execute the Pre- and Post-ESD events.


• Post-ESD events. (Active for ESD objects only.) Lists the events that execute after the ESD events have completed. These events do not execute if the ESD events list is empty.

File menuOn the Events page, two additional File menu commands are available:

• Import. Displays the Open dialog box, which you use to select an event file and copy the events after the currently selected event.

• Export (selected). Copies the selected events to an event file. You can import these events into any event list, or execute this event file via the insert WORKLIST event.

Edit menuThe Edit menu is specific to the Events property page; use its commands to manipulate events and find information in the event list. The following table describes each of the Edit menu commands.

Note: Importing into the ESD events window for an ESD object imports only the SEND, MAKE DIR, CHECK FILE, CHECK SEND, and COMMENT events. In addition, the Server changes the Flags to CD, since ESD events always take place on a Client (C) and during (D) a session.

Table 32. Edit menu commands (Events page)

Command Description

Undo Reverses the most recent change to the event list.

Cut Removes selected events and copies them to the clipboard.


Find dialog boxOn the Edit menu, click Find to search for text strings in the currently displayed event list. In the Find dialog box that appears, type search text and set search criteria. Controls in this dialog box include:

• Search for. Specifies the search text. Type up to 34 characters in this text box.

• Top of list. Starts the text search from the beginning of the displayed event list.

• Currently selected item. Starts the text search from the last selected event.

• Search. Initiates the search for the specified text. If the text is not in the event list, a window notifies you that the string cannot be found.

• Cancel. Stops the search operation and closes the dialog box.

Add Events menu To view the Add Events menu, display the Events property page. Use this menu to create the event list. Submenus contain the RemoteWare events and are described in the following table. Selecting an event menu command displays the Event Details window, in which you can fully define the event. The Event Details window differs for

Copy Copies selected events to the Clipboard.

Paste Places Clipboard-resident events after the last selected event.

Delete Removes selected events from the event list.

Select all Selects every event in the event list.

Unselect all Removes the selection from every event in the event list. Helpful for placing events before the first event in an event list.

Find Searches for text in the event list.

Find next Continues to search for a text string using the last selected event.

Replace Specifies search and replace criteria for the selected event.

Enable Event Enables a previously disabled event.

Disable Event

Disables the selected event.

Event Details Displays the Event Details window for the selected event.

Table 32. Edit menu commands (Events page) (Continued)

Command Description


each event. For more information, see “Event Details window” on page 446.

Table 33. Add Events menu commands (Events page)

Submenu Description

File Transfer Events that perform file-based data exchange between the Client and Server.

Operating System System level commands, such as DIR or COPY, on either the Server or the Client.

Session Control Events that affect the way the object progresses through the list of events. They include conditional statements, events that set and test variables, and events that test Client inclusion in groups.

Server Events specific to the Server. Used to process external event files, set alarms, contact other RemoteWare servers via RPCs, and exchange message queues.

Scripting Scripting events specific to the Server or Client. Scripting enables the RemoteWare administrator to call and execute custom scripts from a worklist. Supported scripts are VBScript and JScript. Client script events are supported only for Windows Clients.

Note: Appendix A, “Events” on page 441 discusses events and their options in detail.


Members property pageThe Members property page lists the objects that compose group and application group objects. Unlike ESD and worklist objects, group and application group objects do not possess event lists. Instead, group objects include members, which are ESD, worklist, and group (for application group) objects that you have already defined.

To display the Members page, select a Grp (group) or AppGrp (application group) object on the Objects page. Then, click the Members tab, or select Members from the Pages menu.

The top area of the Members page displays the object’s name. Below the name, the list box displays each member assignment on a separate line. The list box provides different information based on the type of object selected, as follows:

• Group objects. Displays the member object Name, Type (either ESD or Wrk), and Status (either Enabled or Disabled). You can assign only ESD and worklist objects to group objects.

• Application group objects. Displays the member object Name, Status (either Enabled or Disabled), and the number of assigned Users. You can assign only application objects to application group objects.

Use the other controls on the Members page to view specific entries, get more information, and control the assignments:

• View. (Available for group objects.) Displays only one object type. Does not discard prior selections you made in other views.


• Search/Select. To select an object, type the first characters of its name in the text box and press [Enter]. Insert an exclamation mark “!” before the first character to cancel the selection from one or more objects. To select multiple objects, you can repeatedly type selections in this field, or you can use wildcards.

• Item Detail. Displays the object’s members or events for the last selected item. You can use this button until the events appear for worklist or ESD objects.

• Unassign. Removes the selected objects from the list box. Unassigned objects are no longer part of the group or application group object.

• Unassign All. Removes all objects from the list box. Once complete, the group or application group object has zero (0) objects assigned to it.

• Assign. Displays the Select Objects or Assign Application Objects window. Use these windows to add objects as members of this group.

In the window that appears, select one or more objects in the list box. Selected objects appear as member assignments once you click OK.

Click an object to select it; click again to cancel the selection. Use [Shift] to select adjacent items, or press [Ctrl] to choose items that are not next to each other. Typing the first few characters in the Search/Select text box and pressing [Enter] selects items, the exclamation mark “!” before the first character cancels the selections. Use wildcards to choose multiple items.


Object assignment fundamentals

This section describes assignment types, implications, and other issues you need to consider when making assignments.

For an outline of items that can be assigned to objects, see “Table 34. Assignments available to objects” on page 203. Make these assignments carefully to guarantee expected results. Multiple assignments to objects, groups, sessions, Clients, and so on may cause your objects to execute unexpectedly, or sessions and objects may not execute at all.

As you make object assignments, keep in mind the following:

• If an object is assigned to a Client, the object is executed each time a connection is made to that Client.

• If you assign an object to a session, the object executes each time the session runs.

• You can assign a session and a Client to the same object.Sessions, Clients, and parent objects are assigned to an object either directly, indirectly, or both:

• Direct assignment. An item is directly assigned if you specifically select the item and assign it to a Client.

Example: Select Session 1 and assign it to Object A. Session 1 is directly assigned to Object A.

• Indirect assignment. Items are indirectly assigned when an object group or Client group you assign to the object already contains assigned objects. You don’t assign these items individually; they are assigned because they are a member of an assigned group. Indirectly assigned items have asterisks “*” next to their names on the Members page.

Example: Session 1 is already directly assigned to Client Group B. When you assign Client Group B to Object A, Session 1 is indirectly assigned to Object A.

• Direct and indirect assignment. Items are directly and indirectly assigned when they are both a member of a group and the selected object. An item which is directly and indirectly assigned to an object has an ampersand “&” next to its name on the Members page.

Example: Session 1 is already directly assigned to Client Group B. When you assign Client Group B to Object A, Session 1 is indirectly assigned to Object A. Assign Session 1 to Object A. Session 1 is now directly and indirectly assigned to Object A.


The following table briefly covers the types of assignments available to objects and their results.

Table 34. Assignments available to objects

Item Object type limitations, if anyResults when assigned to object

Clients Worklist, ESD, and Group objects only. The work object executes whenever this Client connects. This includes instances when the Server schedules an outbound session with the Client.

Client Groups Worklist, ESD, and Group objects only.The work object executes when a Client in this Client group connects. If the Client group includes an Outbound or Both session, then this work object executes when the Server schedules an outbound session to this Client.

(Work) Objects Worklist, ESD and Group objects: This object executes the assigned member work objects whenever any assigned sessions, Clients, or parent groups are invoked.

Application and Application Group objects:The work object executes whenever the Client connects.

Sessions Worklist, ESD, and Group objects only. For inbound sessions, the work object executes when the Client connects and executes the inbound session. The work object assigned to an outbound or both session executes when the Server schedules a connection to the Client.

Users Application and Application Group only. Executes the work object when the Client user connects.


Sessions property pageThe Sessions property page lists the sessions that use the selected worklist, ESD, or group object. The object is considered for execution each time one of these sessions executes or is scheduled.

To display the Sessions page, select a Wrk (Worklist), ESD, or Grp (Group) work object on the Objects page. Then click the Sessions tab, or clickSessions on the Pages menu.

Use the Sessions page to get more information and assign and unassign sessions. The list box displays each session (as defined in the Session Editor) on a separate line along with the following information:

For a description of indirect assignments as well as other assignment issues, see “Object assignment fundamentals” on page 202.

• Name. Displays the session name as it appears in Session Editor. An indirectly assigned session has an asterisk “*” or ampersand “&” to the left of its name.

• Type. Indicates whether this session is processed exclusively on the Server (Process), run for inbound calls (In), is scheduled for outbound calls (Out), or runs for any connection (Both).

• Status. Indicates whether this session is available for use (Enabled) or not available for use (Disabled).

• Objects. Displays the total number of work objects assigned to this session.

• Clients. Displays the total number of Clients assigned to this session.

For a description of the other controls on this page, see “Members property page” on page 200.


Click Assign to display the Select Sessions window. Use this window to assign one or more sessions to this work object.

The Select Sessions window initially displays all sessions that you can assign to this work object. Select one or more items to display by:

• Manually selecting items. Click an item in the list to select it; to cancel the selection, press [Ctrl] and click it again. You can select multiple adjacent items with the mouse, or press [Ctrl] to select items that are not next to each other.

• Using the Search/Select text box. Use the Search/Select text box to select one or more items in the list box. Type the first characters of the item’s name and press [Enter] to select it. Use an exclamation mark “!” as the first character when you want to clear the selection from one or more items. You can repeatedly type characters in this box to select additional sessions.

The Select Sessions dialog box also includes the following buttons:

• Item Detail. Displays additional information about the session.

• All Sessions. Displays all available sessions.

• OK. Accepts your settings and displays the selected items on the Sessions page.

• Cancel. Discards selections and changes made in this dialog box.


Clients property pageYou can assign the worklist, ESD, and group object types to Clients for execution. The Client property page lists the Clients that execute an assigned work object each time they connect.

To display this page, first select a Wrk (worklist), ESD, or Grp (group) work object on the Objects page. Then, click the Clients tab, or select Clients from the Pages menu.

To view Clients or groups, display more information, and unassign or assign Clients, use the controls in the right area of this page. For a description of each control, see “Members property page” on page 200.

The list box displays each assigned Client or group on a separate line. For each item, the following information appears:


• Name. Displays the Client or group name as it appears in Client Profile. Indirectly assigned items have an asterisk “*” or ampersand “&” to the left of their names.

• Type. Indicates whether the item is a Group or a Client. Group assignments often create indirect assignments as they contain Clients that were not assigned using the Assign button (that is, they were indirectly assigned).

• Description. Lists the long description for the Client or group.

• Status. Indicates whether a Client is Enabled or Disabled. This value does not apply to groups; the value in this column for a group is always “N/A.”


Click Assign to add one or more Clients or groups to the Clients page. The Select Clients and Client Groups window appears.

The Select Clients and Client Groups window initially displays all Clients and groups that you can assign to this work object. Select one or more items to display by:


• Narrowing the view. By default, the View list displays all Clients and groups. To narrow the view, select another view in the list.

• Using the Search/Select text box. Use the Search/Select text box to select one or more items in the list box. Type the first characters of the item’s name and press [Enter] to select it. Use an exclamation mark “!” as the first character when you want to clear the selection from one or more items. You can repeatedly type characters in this box to select additional items.

The Select Clients and Client Groups window also includes the following buttons:

• Item Detail. Displays additional information about the Client or Client group.

• All Clients & Groups. Returns the list to its original state by displaying all Clients and Client groups.

• OK. Accepts your settings and displays the selected items on the Clients page.

• Cancel. Discards selections and changes made in this window.


Users property pageFor application and application group objects, use the Users property page to assign the object to specific users. The object executes when the user’s Client connects to the Server.

To display the Users page, select an App (application) or AppGrp (application group) object. Then, click the Users tab, or select Users from the Pages menu.

To view users or groups, display additional information, and assign or unassign users, use the controls in the right area of this page. For a description of each control, see “Members property page” on page 200.

The list box displays each assigned user or user group on a separate line. For each item, the following information appears:

• Name. Displays the user name as it appears in the Directory Manager program. This name is a combination of the last name, first name, and middle initial displayed when addressing messages.

• Address. Displays the eight letter user name. This name is used by RemoteWare to identify messages.

• Client. Displays this user’s assigned Client name. This field may be blank if no Client has been assigned to this user. In order for the user to access this application or application group, the user must eventually be assigned to a Client.


Click Assign to add one or more users or groups to the Users page. The Select Users and User Groups window appears.

The Select Users and User Groups window initially displays all users that you can assign to this work object. Select one or more items to display by:


• Narrowing the view. By default, the View list displays all users and groups. To narrow the view, select another item in the list.


The Select Users and User Groups window also includes the following buttons:

• Item Detail. Displays additional information about the user or group.

• All Users & Groups. Returns the list to its original state by displaying all users and groups.

• OK. Accepts your settings and displays the selected items on the Users page.



Parents property pageThe Parents property page is available for worklist, ESD, group, and application objects. Use this page to assign an object to existing group objects. The Parents page is the “opposite” of the Members page: instead of building a group from individual objects, you assign the individual object to a group (a group, application, or application group object).

To view the Parents page, select a Worklist, ESD, Group, or Application object on the Objects page. Then, click the Parents tab or select Parents from the Pages menu.

To view specific object types, display additional information, and unassign or assign objects, use the controls in the right area of this page. For a description of each control, see “Members property page” on page 200.

The list box displays each assigned object on a separate line. For each object, the following information appears:


• Name. Displays the object’s name. Indirectly assigned items have an asterisk “*” or ampersand “&” to the left of their names. Indirect assignments often occur when group or application groups are assigned to the Parents page.

• Type. Indicates whether the object is a group (Grp), an application (App), or an application group (AppGrp).

• Status. Displays the state of the object (either Enabled or Disabled), which indicates whether this object is available for execution.


Click Assign to add one or more objects or groups to the Parents page. The Select Objects window appears. Use this window to select which objects or groups include this object.

The Select Objects window initially displays all objects. Select one or more items to display by:


• Narrowing the view. By default, the View list displays all objects. To narrow the view, select another item in the list.


The Select Objects window also includes the following buttons:

• Item Detail. Displays additional information about the object.

• All Objects. Returns the list to its original state by displaying all objects.

• OK. Accepts your settings and displays the selected items on the Parents page.


C H A P T E R

7

Worklist Editor

Use the Worklist Editor program (or the Work Object Editor program) to create and

manipulate worklist files, which are sets of events that execute during a session.

Worklists typically perform file and directory management, notifications, and system

registry management tasks. You can also use worklists to perform tasks at the Server,

such as removing or renaming files without a Client connection. These worklist events

reside in an external file, generally with the .evf file extension. As a result, worklists

allow RemoteWare to store and access collections of events in a file that can easily be

changed or referenced by the Server.


• “Worklist Editor at a glance” on page 214


• “Worklist Editor main window” on page 217


Worklist Editor at a glanceThe worklist file is a versatile method for defining a group of events, editing existing lists of events, or accessing events that will execute during a session. In Work Object Editor, you can reference worklist files using the Insert Worklist or Exception Worklist event, or you can import worklists on the Events page. Use Worklist Editor or Work Object Editor to create and edit worklist files. Worklist files that you define are stored by default in the \Worklist subdirectory.

The Worklist Editor consists of a main window that is used to display, edit, and save worklist files; for details, see “Worklist Editor main window” on page 217. Individual events and their functions are covered in Appendix A, “Events” on page 441.



The following table lists the menu commands specific to Worklist Editor and provides a brief description of each.


Table 35. Worklist Editor menu commands


File New Clears the main window in preparation for a new worklist file. Prompts user to save the current file if unsaved changes exist.

Open Displays the Open dialog box, where you can select a worklist file for viewing or editing. By default, worklist files have an .evf extension and reside in the \worklist directory, but these files may be in any location and use any valid extension.

Save Writes changes to the current worklist file. Use the Save As command if this is a new file.

Save As Writes the events to a new file name you specify. Used for new worklist files or to copy existing files.

*Import Copies another worklist file into the edit window. The Worklist Editor inserts a copy of the file after the current cursor position (or at the beginning of the worklist, if no event is selected).

Multicast Worklist

Enables Multicast mode (if Multicast is installed).

*Export (selected)

Copies selected events to another worklist file.

File n Recent file names

Displays the last four worklist files opened or saved in Worklist Editor. The “n” is a number that can be used as a shortcut key.

Edit *Undo Reverses the most recent operation.

*Cut Moves the selected events from the worklist to the Clipboard.

*Copy Copies selected events to the Clipboard. The selected items are unchanged in the worklist.


*Paste Copies the Clipboard contents after the selected event. If no events are selected, places the contents at the beginning of the worklist.

*Delete Removes selected events from the worklist.

*Select all Selects every event in the Worklist Editor window.

*Unselect all

Cancels the selection of all items in the Worklist Editor.

*Find Locates an event that matches a given text string. For more information, see “Find option” on page 218.

*Find next Locates the next event from the current position that matches a previously defined search string.

*Event Details

Opens the Event Details window for the selected event; this window displays the event’s settings and options. For details, see “Event Details window” on page 446.

Add Events ... See Appendix A, “Events” on page 441 for information on the events available on this menu.

Insert Before/Insert After

Specifies whether to insert new events before or after the selected event.

View *Flags Displays or hides the event flags in the edit window.

*Refresh Redraws the main window.

Table 35. Worklist Editor menu commands (Continued)


Wo r k l i s t E d i t o r m a i n w i n d o w 217

Worklist Editor main windowYou use one window in Worklist Editor to create, access, display, modify, and save worklist files. There are two ways to access the Worklist Editor main window:

• In RemoteWare Menu, double-click the Worklist Editor icon (located in the All Utilities or Server Setup groups).

• In the RemoteWare directory, run \SYSTEM\WLE.EXE to start the Worklist Editor when the RemoteWare Server is not running.

The main window appears:

The title bar displays the name of the currently selected worklist file. The Worklist Editor main window displays the events in this worklist as well as the flags specific to each event:

• Events. Each RemoteWare command is listed on a separate line in the editor window and executes in a linear fashion unless flagged as either Server Before or Server After. See Appendix A, “Events” on page 441 for a detailed list of events and their descriptions.


For more information about flags, see “Options area” on page 454. You can also see “Execute area” on page 458.

• Flags. Symbols or letters that indicate when and where the event executes or other special behaviors associated with the event. The following table lists the possible flag values.

Find optionTo identify an event that contains a specified string of characters, select Find or Find Next on the Edit menu. The Find dialog box appears; use this dialog box to specify search criteria. Options include:

• Search for. Type the characters you want to find in the worklist. Select Match Case to match case sensitivity during your search.

• Direction - Up. Begins the search and replace operation up from the point in the worklist.

• Direction - Down. Begins the search and replace operation down from the point in the worklist.

Table 36. Flags in the Worklist Editor

Flag Option name Description

S On Server This event only executes on the Server.

C On Client This event only executes on the Client.

B Before event The event runs before the Server begins a connection with the Client and is only applicable to events that execute on the Server.

D During event Executes during a session with a Client.

A After event This event runs after the Client connection is complete and is only applicable to events that execute on the Server.

- Delete after Erases the source file(s) after the event is successful.

& Conditional true Executes this event if the previously executed event was successful or returned a true value.

| Conditional false Executes this event if the previously executed event was not successful or returned a false value.

* Session critical Terminates the session upon failure of this event.

+ Work object critical Terminates the work object upon failure of this event but continues to execute other work objects that are assigned to either the session or Client.

Wo r k l i s t E d i t o r m a i n w i n d o w 219

• Match Case. Distinguishes between upper case and lower case characters when you search for occurrences of text typed in the Search for field.

• Search. Begins the search operation using the options you have specified.

• Cancel. Stops the search and returns you to the Worklist Editor main window.

Replace optionTo identify and replace an event that contains a specified string of characters, select Replace on the Edit menu. The Replace dialog box appears. Use this dialog box to specify search and replace criteria. Options include:

• Search for. Type the characters you want to find in the worklist. Select Match Case to match case sensitivity during your search.

• Replace with. Type the characters you want to replace. Select Match Case to match case sensitivity during your search.

• Direction - Up. Begins the search and replace operation up from the point in the worklist.

• Direction - Down. Begins the search and replace operation down from the point in the worklist.

• Match Case. Distinguishes between upper case and lower case characters when you search for occurrences of text typed in the Search for field.

• Find Next. Locates the next instance of the character string specified in the worklist.

• Replace. Replaces matching instances meeting the specified criteria with the character string specified.

• Replace All. Replaces all matching instances meeting the specified criteria with the character string specified. a dialog box displays indicating the number of replacements made during the process.

• Cancel. Stops the search and replace operation and returns you to the Worklist Editor main window.

C H A P T E R

8

Session Editor

While work objects specify the actions or events to take place, a session specifies when

the actions are to take place. The session is a scheduled connection between the Server

and a Client, or a specific time for system level activities to take place. Use the Session

Editor program to define and manage sessions on the RemoteWare Server and its

clusters.


• “Session Editor at a glance” on page 222




Session Editor at a glanceUse Session Editor to define and manage sessions on the RemoteWare Server and its clusters. The Server uses scheduled sessions to perform all of its Client and local tasks.

Sessions are scheduled and managed collections of work objects. They are scheduled by the Scheduler (using the Schedule Manager program) to automatically connect with Clients at a specified date and time, or when a Client calls to perform its inbound session. Sessions are managed by the Session Editor program, which maintains and reconciles all scheduling, assignment attributes, and execution options.

A session is defined by these general features:

• Session name• Scheduled time and date when the session should run• Work objects in the session to execute when the session runs• Clients assigned to the session

Session tasks For more details about designing effective sessions, see “Optimizing event execution” on page 459.

The Server completes the following tasks during a communications session:

1 Compiles a list and validates work objects assigned to the Client.

2 Reads and validates work objects assigned to the session.

3 Sorts work objects by priority and removes any duplicate objects.

4 If ESD is disabled, then removes all ESD work objects.

5 If Applications are disabled, then removes all application work objects.

6 Builds the master worklist. This worklist contains the events defined in the work object assigned to either the Client or the Server. It also includes partially resolved file names, and variables the Server dynamically updates and executes.

7 Executes BEFORE events.

8 If the session is Outbound, initiates a connection to the Client.

9 Starts to process ESD objects. Builds a list of temporary files to be transferred from the Server to the Client.

10 Once the connection is established, executes DURING events.

S e s s i o n E d i t o r a t a g l a n c e 223

Checking the Client’s file system is one of the major advantages of ESD objects versus worklist objects. ESD objects check all Client files in one operation, while worklists must check each file separately.

11 Checks the Client’s file system when executing the first ESD work object. Rebuilds the master worklist with the needed ESD events.

12 Continues to execute DURING events. Rebuilds the master worklist as the Server acquires updates to unresolved variables or processes conditional events.

13 The Server terminates the communication link.

14 Executes AFTER events.

15 Logs the results on the RemoteWare Server.

Property pages in Session EditorSession Editor consists of the property pages listed in the following table. These pages define the scheduling, object and Client assignments, and session level options.

Table 37. Session Editor property pages


Sessions Displays defined session names, type, status, and number of assigned objects and Clients. On this page, you can define new sessions, or view, filter, copy, rename, delete, enable, or disable objects.

225

Schedule Set session and schedule type, priority, starting date and time, retry options, and other scheduling parameters.

230

Objects Assign or view work objects assigned to this session. These objects are slated to execute each time the session runs.

238

Clients Select which Clients use this session. If this is an Outbound or Both (Inbound and Outbound) session, then the Server schedules this session to these Clients.

240

Options Specify whether other objects indirectly assigned to the Client will execute. Also set whether ESD or Application objects may execute with this session.

242



The following table lists the menu commands specific to the Session Editor program. All of these commands are available on the Sessions page. Use these commands to create and modify sessions, enable or disable sessions, and apply filters.


Table 38. Session Editor menu commands


File New Creates a session.

*Copy Creates a new session using the selected session’s definition as the template.

*Rename Changes the name of the selected session.

*Delete Permanently removes the selected session definition from the list.

Commands *Enable Session

Makes the selected session available for scheduling.

*Disable Session

Makes the selected session unavailable. Can also be toggled to remove unwanted blocked sessions from the Schedule Manager program.

Filter ... For a description of these commands, see “Filter menu” on page 227.


Property pagesThe following topics provide information about the Session Editor property pages.

Sessions property pageThe Sessions property page lists every defined session in this RemoteWare system. Use the Sessions page to define new sessions, modify sessions, and enable, disable, copy, or delete existing sessions. You also use the Sessions page to access other property pages for a session. Select an individual session, then click any of the tabs. The available tabs change depending on the type of session you select.

The Sessions page appears whenever you start the Session Editor. You can also display this page in Session Editor by clicking the Sessions tab or by selectingSessions from the Pages menu.

Other sessions may be predefined when you first start the Server, depending on which products are installed on the Server.

If you are setting up your sessions for the first time, the list box contains at least two predefined sessions: Sample Session and RWS Default Inbound. RWS Default Inbound runs when a Client calls the Server and no specific Inbound or Both session is assigned to that Client. This session contains no objects when you first install the Server; you can add any objects you want by editing the session. However, you cannot delete, disable, or assign the RWS Default Inbound session.


The top area of the page displays the number of sessions that have been defined and enabled. The list box displays each session on a separate line. For each session, the following information appears:

• Session Name. Displays the unique name for this session, which can include up to 41 characters. You specify the session name when creating a new session, or when renaming or copying an existing session. This name appears in RemoteWare Server programs, but never appears at the Client. The symbol to the left of the name indicates whether the session is enabled (a green dot) or disabled (a gray dot).

• Type. A session’s type is determined on the Schedule page; it dictates when the session is scheduled. Possible session types are listed in the following table:

The symbol next to the Session Name also indicates whether the session is Enabled (green dot) or Disabled (gray dot).

• Status. Indicates whether the session is Enabled or Disabled. Disabled sessions are not scheduled or used for incoming connections. Enabled and assigned (to Clients) sessions appear in the Schedule Manager program. All session types except Inbound appear in Schedule Manager (in the Pending, Blocked, or Suspended state). An Inbound session type only appears in an Active state.

• Objects. Displays the total number of work objects assigned to this session. The Objects page lists the actual work objects. These objects will attempt to execute each time the session executes.

• Clients. Displays the total number of Clients assigned to this session. The Clients page lists the assigned Clients. Outbound and Both session types schedule connections to these Clients, while Inbound and Both sessions are executed if an

Table 39. Session types

Type Is actually Description

In Inbound Used when a connection is made from the Client to the Server. The session may be used for an assigned Client connecting to the Server. You can assign only one Inbound (or Both) session to a Client.

Out Outbound Used for connections from the Server to Clients. The Server schedules Outbound sessions to assigned Clients based on the session’s schedule. You can assign up to 51 sessions (50 Outbound and 1 Inbound or Both) to a Client.

Both Inbound/Outbound Can be used for any Server and Client connection. You can assign only one Inbound (or Both) session to a Client.

Process Process Only Schedules and executes only on the Server. Generally used for local system maintenance. All events in the work objects must be designated as BEFORE events, otherwise they are ignored. Must be assigned to at least one Client.

Multicast Multicast Used to connect to Multicast Clients and for assigning work objects containing Multicast events.


assigned Client establishes an inbound connection with the Server. Process Only sessions schedule to run, but do not connect to a Client.

Filter menuWhen you start the Session Editor program, the Sessions page lists every defined session. To selectively display sessions with a particular characteristic, use the Filter menu or its corresponding toolbar buttons. You can combine filters as needed; each filter is cummulative of any filter already in use until you choose the Remove All Filters command. You can save filter settings and reuse them later.

The following table describes the filter menu commands available for sessions.

Table 40. Session Editor filter options


by Session Opens the Select Sessions window, where you can select one or more sessions to display on the Sessions page. For details, see “Filter by Session” on page 228.

by Enabled Sessions The green indicator displays only Enabled sessions on the Sessions page. For more information, see “Filter by Enabled or Disabled Sessions” on page 229.

by Disabled Sessions The gray indicator displays only Disabled sessions on the Sessions page. For details, see “Filter by Enabled or Disabled Sessions” on page 229.

Remove All Filters Discards all filter settings and displays all sessions. For additional information, see “Managing filters” on page 229.

Read Filters Opens the Select Filter File dialog box, where you can select and use a predefined filter file. For details, see “Managing filters” on page 229.

Write Filters Creates a filter file that contains the current filter settings. For instructions on writing a new filter, see “Managing filters” on page 229.


Filter by SessionUse this menu command or toolbar button to display specific sessions on the Sessions property page. When you choose by Session on the Filter menu, the Select Sessions window appears:

Use this window to choose one or more sessions to display. Select sessions by:

• Manually selecting the session(s). Click an item in the list to select it; to deselect an item, press [Ctrl] and click it again. You can select multiple adjacent items with the mouse, or press [Ctrl] to select items that are not next to each other.

• Using the Search/Select text box. Use the Search/Select text box to select or cancel the selection of one or more items in the list box. Type the first characters of the session name and press [Enter] to select it. Use an exclamation mark “!” as the first character when you want to cancel the selection of one or more items. You can repeatedly type characters in this box to select additional sessions. You can also select multiple sessions by using wildcards (such as the asterisk “*” and the question mark “?”).

The Select Sessions window also includes the following buttons:

• Item Detail. Displays the objects assigned to the session, or the events for a worklist or ESD object. The detail window appears for the last selected item. This control can be used repeatedly until the events appear for worklist or ESD objects.

• Remove Filter. Similar to Cancel, but in addition to discarding changes, also deletes settings from this filter category. Use this button to selectively remove one of several filter settings in a filter combination.

• OK. Accepts your settings and displays the selected items on the Sessions page.

• Cancel. Discards selections and changes made in the Select Sessions window. Preserves any filter settings present before you selected the Filter menu command.


Filter by Enabled or Disabled SessionsOn the Filter menu, theby Enabled Sessions and by Disabled Sessions commands display only those sessions with the appropriate status. You can use only one of these filters at a time, but you can use either filter in conjunction with the by Session filter.

Managing filtersOn the Sessions page, select the following Filter menu commands to deactivate all current filter settings, save a filter combination for later use, and retrieve and apply filter settings.

• Remove All Filters. Immediately removes every filter applied on the Sessions page. On the Session Editor menu bar, “Filter – ON” changes to “Filter – OFF.”

• Read Filters. Displays the Select Filter File dialog box, where you can select an existing filter file to filter the items on the Sessions page. Use this dialog box to locate the filter you want to apply; then click Open. (Clicking Cancel discards changes and returns you to the Sessions property page.)

• Write Filters. Saves the current filter setting to a file for future use. When you want to reuse the filter file, select Read Filters on the Filter menu.


Schedule property pageThe Schedule property page determines when and how often the session is scheduled to execute. It also defines which connection types are valid for this session and specifies how to handle failed connections. This page automatically appears after you create a new session or when you double-click an existing session on the Sessions page.

To display the Schedule page, select a session on the Sessions page. Then, click the Schedule tab, or choose Schedule from the Pages menu.

There are three areas on the Schedule page that organize the scheduling functions:

• Session Type• Schedule Type• OptionsThe following sections describe each area on the Schedule page.

Session TypeOn the Schedule page, the Session Type area defines and constrains how a session is scheduled or used. Under Session Type, select one of the four types that best fits your


application.

Table 41. Session types and their usage

Type Usage Description

Outbound The Server calls the Client to perform tasks. Used to perform periodic maintenance, exchange files, and update applications.

The Server schedules Outbound sessions to assigned Clients based on the session’s schedule. You can assign up to 51 sessions (50 Outbound, and 1 Inbound or Both) to a Client.

Inbound Performs tasks only when a Client calls into the Server.

Used when a Client connects to the Server. The Server uses RWS DEFAULT INBOUND when a Client has no assigned Inbound session. You can assign only one Inbound (or one Both) session to a Client.Note: Inbound sessions do not use the Schedule Type field on the Schedule page.

Both Available for both Inbound and Outbound sessions.

Can be used for any Server/Client connection. Scheduled tasks may be executed if the Client calls the Server. If the Client does not call the Server, the Server then places an Outbound call to the Client to execute the session. Note: You can assign only one Both (or one Inbound) session to a Client. These sessions cannot have a Dependent schedule type.

Process Only Used for maintenance and local computer or network duties at the Server.

Schedules and executes only on the Server. All events in the work object that are assigned to this session must be BEFORE events, otherwise they are ignored. Process Only sessions involve no remote connections.Note: Process Only sessions always require a Client assignment. The assignment is useful when Client-related variables (such as <ClientName>, which you could use to process files in each Client’s home directory) occur in the session. If you are not using Client variables, consider creating a “dummy” Client and assigning the Process Only session to it.

Multicast Multicast Used to connect to Multicast Clients and for assigning work objects containing Multicast events.


Schedule TypeOn the Schedule page, the Schedule Type area defines the dates, conditions, or interval for scheduling the session. The options that are available depend on the Session Type:

• Outbound, Multicast and Process Only sessions can be scheduled on a Fixed, Calendar, or Dependent basis.

• Both sessions can be scheduled on a Fixed or Calendar basis. They cannot have a Dependent schedule type.

• Inbound sessions do not have an available schedule type. Use the Client property page in Client Profile to schedule an Inbound session.

When you select a Schedule Type, the options in the bottom area of the Schedule page change to reflect your selection. The following sections describe the available options for each type of schedule.

Fixed sessionsYou can schedule fixed sessions on an hourly, daily, or weekly basis for the following session types: Outbound, the outbound portion of Both, and Process Only.

When you select Fixed as the Schedule Type, the bottom area of the Schedule page displays options that you can use to schedule the session:

• Every hh:mm:ss. Select this option to schedule the session on a regular, hourly interval. To select the number of hours, minutes, and seconds between sessions, click the time button. The Enter Time dialog box appears. Adjust the time by clicking the hours, minutes, or seconds and using the spin box to select a new value. You can select any time between 00:00:00 and 23:59:59.

• Every Day(s). Select this option to schedule the session every one or more days apart. Use the spin box to select the number of days (from 1 to 365).

• Every Week(s). Select this option to schedule the session one or more weeks apart or on certain days of the week. Use the spin box to select the number of weeks

Note: Specifying an interval shorter than the actual session execution time may create performance problems and Out of Range schedule errors on your Server.


(from 1 to 52) between sessions. Select one or more of the check boxes to indicate the day(s) of the week on which to schedule the session.

• Except On. Lists the dates on which the session will not be scheduled. To specify a new date, click Add; the Enter Date dialog box appears. Click any portion of the date (month, day, or year) and use the spin box to modify the value. Click OK to add the date to the Except On list, or click Cancel to return to the Schedule page.

To remove a date, select it in the list and click Delete. Clicking Purge removes past dates from the list.

Calendar sessionsYou can schedule the following session types to execute on specified dates and times: Outbound, Both, and Process Only.

When you select Calendar as the Schedule Type, the bottom area of the Schedule page displays options that you can use to schedule the session:

• Execute Session On. Lists the dates and times when the Server schedules this session.

• Add Date. Displays the Enter Date and Time dialog box, where you can enter a new date and time to execute this session. The default setting is the current date and time.

• Delete Date. Removes the selected item in the Execute Session On list.

• Purge Date. Removes past dates and times from the Execute Session On list.

Dependent sessionsSchedules for this type of session depend upon the completion of a monitored session. A monitored session can be any session (other than another dependent session or the RWS DEFAULT INBOUND session) used to conditionally execute the dependent session. A dependent session can monitor only one session, but more than one


dependent session can follow the same monitored session.

When you select Dependent as the Schedule Type, the bottom area of the Schedule page displays options that you can use to set the dependent session’s parameters:

• Depends on session. Displays the currently monitored session. Click the button to choose one non-dependent session in the Depends on Session window.

The Depends on Session window contains controls that are similar to those in the Select Sessions window, presented earlier in this chapter. For instructions on using the controls and selecting items, see “Filter by Session” on page 228.

On the Schedule page, use the following four check boxes to set the conditions, based on the monitored session’s execution, for executing a dependent session. Select one or more of these check boxes; the end of this section provides comments about using multiple options.

• Count Successful/Completed sessions. Schedules the dependent session after successfully completing the monitored session for all assigned Clients. The Server resets this count at the end of each execution window.

• Execute dependent session at end of window. Runs the dependent session when the monitored session’s execution window ends. In Schedule Manager, the Dependent Sessions Details page displays the execution window time and date in

Note: Sessions dependent on an Inbound session execute at most once a day. For other monitored sessions, the dependent session executes at most once during the execution window.


the End of window time field. For details, see “Dependent Session Details property page” on page 260.

• Count Out of Range sessions. Runs the dependent session if every monitored session to assigned Clients fails to acquire an appropriate resource before the end of the execution window. This may occur if a resource is busy, unavailable, or down.

For Inbound monitored sessions, “Out of Range” applies to the retries of the Inbound session. If the retry interval exceeds the Stop Trying Outbound Calls after n hours value, the result is an out of range condition. For example, if the Stop Trying value is one (1) hour and the retry interval is 40 minutes, then the second retry would be out of range.

• Count Failed sessions. Schedules this session after unsuccessfully attempting to run the monitored session to all assigned Clients.

The Schedule Manager program displays current counts for the dependent session on the Dependent Session Details page. For additional information, see “Dependent Session Details property page” on page 260.

You can select multiple options to execute the dependent session for specific conditions. The first condition satisfied will execute the dependent session. Select one or more of the “Count” check boxes to execute a dependent session once the cumulative count reaches the number of assigned Clients.

Example: An administrator selects the Count Successful/Completed and Count Failed Sessions check boxes, and monitors a session assigned to 100 Clients. The dependent session executes when 95 monitored sessions are successful or completed, and 5 sessions failed (or any combination of the two totaling 100). This total must occur before the end of the execution window.

Important: Changing session assignments or modifying the number of assigned Clients (either by enabling, disabling, adding, or removing assignments) after the monitored session has started may result in inaccurate counts, causing the dependent session to execute incorrectly or not at all.


OptionsOn the Schedule page, the Options area provides additional controls for defining session schedules. The availability of these controls depends on the selected Session Type and Schedule Type.

Controls in this area include:

• Start Session. Displays the starting date and time for the first scheduled session. Sessions with a Fixed schedule type use this value to define at what point in time this session is valid. Outbound and Both session types use the value as a basis to schedule the first and repeating sessions. Inbound sessions use this value to determine when they are available to run, but inbound monitored sessions for a dependent session use this value to calculate the beginning of the execution window when the Execute dependent session at end of window check box is selected. This button is disabled for Calendar and Dependent schedules.

To set a starting date and time for the session, click the button. The Enter Date and Time dialog box appears. Click any portion of the date or time and use the spin boxes to specify a new value.

If this value is never set, then Session Editor sets it to midnight (00:00:00) of the current day.

• Session Priority. Specifies which scheduled session receives communications resources first when more than one scheduled session competes for the same resource. Higher priority sessions receive resources before lower ones if both are blocked for the same resource or are scheduled to run at the same time. Outbound, Both, and Process Only sessions can have a priority from 0 to 9. The default priority is zero (0).

• Stop trying outbound calls after n hours. Defines the end of the execution window for Outbound and Both sessions. You must set a time limit for how long you want the Server to try to make a connection with the assigned Clients. The time limit (n) can be from 1 to 24 hours; 1 hour is the default setting. When choosing this value, take two factors into consideration:

• Schedule Manager should have enough time to process this and coexisting sessions without generating Out of Range errors. Some variables to consider when setting the value are: the number of scheduled sessions; the number of


resources; session duration; the number of assigned Clients; and the number of inbound sessions.

• If the session allows retries, allow enough time for the number of retries and the retry interval. For example, a 1 hour value is not sufficient for 3 retries 30 minutes apart. A 2 hour value (in this example) ensures enough time for all retries, assuming that there are no scheduling delays or resource conflicts.

• Do this session early if a Client calls within n hour(s) before scheduled outbound start time. (Available for the Both session type.) Executes this session (instead of the RWS DEFAULT INBOUND session) if the Client connects within a set number of hours before the session start time. The default is 1 hour; values can range from 1 to 24 hours.

Example: A session scheduled to run at 5:00 P.M. sets this value to 2 hours. Clients calling the Server from 3:00 P.M. to 5:00 P.M. execute this session instead of the default inbound session.

The Enable Retries check box must be selected in order for Check Point Restart (CPR) to be active. CPR allows an interrupted session or file transfer to continue where it left off, instead of starting from the beginning.

• Enable retries. Allows the Server to retry a call to the Client if the session does not successfully execute. If Enable retries is not selected and the session did not successfully complete, the Server cannot attempt to execute this session with the assigned Client until the outbound window closes. When selected for inbound sessions, the Server schedules an outbound session and either waits for the Client to reconnect or initiates a connection to the Client at the end of the interval time.

When you select this check box, the following controls become available:

• Interval. Sets the number of minutes to wait between retries. The default is 5 minutes; the interval can be from 1 to 60 minutes.

• Number of retries. Specifies how many times the Server can reschedule a session that did not complete. The default is 3 retries; the number ranges from 1 to 25 retries.

• Alternate resource on retry #. After the set number of retry attempts, this value instructs the Server to use the alternate resource defined on the Server property page in Client Profile. To avoid using the alternate resource, set this value to one (1) greater than the Number of retries value.


Objects property pageA session’s main purpose is to execute one or more work objects. The Work Object Editor creates and maintains these objects. In Session Editor, use the Objects property page to assign objects to the session, which allows the session to schedule and run the objects.

To display the Objects page, select a session on the Sessions page and click the Objects tab. You can also clickObjects on the Pages menu.

The title bar and the area at the top of the Objects page display the session name. The list box displays each assigned work object on a separate line. For each work object, the following information appears:

• Name. Lists the work object name, which originates in Work Object Editor.

Although it is possible to assign App and AppGrp object types, they are only applicable to users and will not execute for sessions.

• Type. Indicates what tasks this work object performs. Choices are Wrk (worklist), Esd (Electronic Software Distribution), Grp (group), App (application), and AppGrp (application group).

• Status. Indicates whether this work object is available for execution (Enabled) or not (Disabled).

Note: The Objects page only lists objects assigned to the session. Objects assigned to the Client or user may execute when the session runs. The Options page contains choices to limit execution of these assigned objects; for information, see “Options property page” on page 242. To view every object scheduled during this session, see “Objects property page” on page 256.


Use the controls on the right side of the page to view, select, and assign objects:

• View. Select a view to filter the list box contents by object type. The default setting is Objects (All), which displays every assigned object. Other choices are Objects (Esd), Objects (Grp), and Objects (Wrk). Objects you select in one view are still selected while you apply another view.

• Search/Select. Use the Search/Select text box to select or cancel the selection of one or more items in the list box. Type the first characters of an object’s name and press [Enter] to select it. Use an exclamation mark “!” as the first character when you want to cancel the selection of one or more items. You can repeatedly type characters in this box to select additional items, or use wildcards (for example, * or ?) to select multiple items.

• Item Detail. Displays the object’s members or its events. Click this button; the resulting windows provide more information about the work object.

• Unassign. Removes the association between the selected objects and this session.

• Unassign All. Removes every object association from this session. It is not necessary to select objects before clicking this button.

• Assign. Opens the Select Objects window, where you can add objects to this session. Assigned objects are scheduled to execute when the session runs.

The list box displays all defined work objects. Select individual items to assign in the list box, or use the View, Search/Select, and All Objects controls to make selections. To apply your selection(s), click OK, or click Cancel to return to the Objects page.

Note: ESD, application, or application group objects will not execute when assigned to Process Only sessions. You can use the Options property page to disable these object types, as well as any objects not directly assigned to the session. For more information, see “Options property page” on page 242.


Clients property pageAssign Clients or Client groups to sessions using the Clients property page. Once assigned, Schedule Manager schedules the Outbound, In/Out, or Process Only session for each assigned Client, or runs this Inbound (or In/Out) session for assigned Clients that establish an inbound connection.

Process Only sessions assigned to one or more Clients never connect to the Client and ignore any event that is not set up as a BEFORE event to execute on the Server. However, you can use Process Only sessions in conjunction with Client assignments to process Client-specific tasks, such as manipulating files in the Client’s home directory.

To display the Clients property page, select a session on the Sessions page and click the Clients tab. You can also click Clients on the Pages menu.

The title bar and the top area of the page display the session name. The list box displays each assigned Client on a separate line. For each Client, the following information appears:

• Name. Displays the Client or Client group name as defined in the Client Profile program.

• Type. Indicates whether the item is a Client or Group. A group consists of zero or more Clients; the session runs for each enabled Client in the group.

Note: The Clients page is not available for the RWS DEFAULT INBOUND session. Clients without inbound session assignments automatically run the default inbound session when they connect to the Server.


• Description. Provides a brief description of the Client or Client group. This description originates on the General page in Client Profile.

• Status. Indicates whether this Client is available for communication (Enabled) or unavailable (Disabled). This value is applicable only to Clients; groups always have an N/A status.

For an overview of these controls, see “Objects property page” on page 238.

Most of the controls on the right of the Clients page are identical in function to those on the Objects page. The following controls differ from those on the Objects page:

• View. Filters the list box by Clients & Groups (default), Clients, or Groups.

• Item Detail. Displays the group members of, or displays Client information for the selected item.

• Assign. Displays the Select Clients and Client Groups window, where you can assign Clients or Client groups to this session.

The list box displays all defined Clients and groups. Select items in the list box to assign them. You can also use the View, Search/Select, and All Clients & Groups controls to make selections. Apply your choices by clicking OK, or click Cancel to return to the Clients page without saving any changes.


Options property pageUse the Objects property page to display or limit which types of work objects execute during a session and whether the session uses encryption. To display this page, select a session on the Sessions page, then click the Options tab, or click Options on the Pages menu.

The title bar and the top of the Options page display the session name. The conditions for executing object types appear on the rest of the page:

• For all Clients. Indicates whether the Server executes ESD, application, or application group work objects at a Server or cluster level. Set these values on the Settings page in Server Profile; for details, see “Settings property page” on page 72.

• For this Session. Select options to define the types of objects to execute and to determine whether the session uses encryption1 for data transfer:

• Limit execution to assigned Session Objects. When selected, the session executes the objects listed on the Objects page. Does not execute objects assigned to Clients or users.

• No Applications during Session. Select this check box to prevent application or application group objects from executing.

Note: Process Only sessions disable ESD objects, application objects, application group objects, and any other object not directly assigned to the session. The Options page for a Process Only session cannot be changed.


• No ESD during Session. Select this check box to prevent ESD (Electronic Software Distribution) objects from executing.

• No encryption for this session. Disable encryption for this session.

• Encrypt this session when possible. Enable encryption for this session if the Client supports encryption and the Client is using a TCP/IP resource. Allow the session to run unencrypted if the Client does not support encryption or is using ASYNC resource.

• Encryption required for this session. Enable encryption for this session. Do not run session unless the Client supports encryption and is using a TCP/IP resource.

1. Using session encryption requires additional processing time and resources, the extent ofwhich may vary by file size and type. You are advised to evaluate the impact of encrypting ses-sions in your environment.

C H A P T E R

9

Schedule Manager

The Schedule Manager program displays and controls the execution of every session on

the Server or cluster.


• “Schedule Manager at a glance” on page 246


• “Schedule Manager main window” on page 252

• “Details for Session window” on page 254


Schedule Manager at a glanceThe Schedule Manager program is the user interface for the Scheduler. RemoteWare uses the Scheduler to manage session schedules and execute sessions at the scheduled time. The Scheduler is a background program that accesses the database and matches sessions to available resources, maintains the pending, blocked, and active queues, and provides information about which objects will execute when the session runs.

Schedule Manager provides a way to view and manipulate session activity. Use Schedule Manager to view currently scheduled sessions, skip or execute a pending session, abort or suspend an active session, or view the current details for a session.

Schedule Manager consists of one main window and a session detail window with additional property pages; for a description of each page, see “Details for Session window” on page 254. Use the detail windows to view different session properties, determine which objects will and will not execute, obtain details on any object, and view additional information specific to dependent sessions. This information is particularly helpful for troubleshooting session execution.

Schedule Manager implementation uses a table called RWSchedule. Scheduler data is stored in the table and uses the database's own Database Management System (DBMS) implementation to address the need for efficient, concurrent access. The RWSchedule table can exist in the same database as the logging database, in a database that is separate from the logging database but on the same database server, or on a separate database server. See “Loss of Scheduler Database Connectivity” on page 262 for implications of losing connectivity to the database.


Menu commandsSchedule Manager includes the following menus for managing the Scheduler:

• Command

• View

• Filter

• Scheduler

Command menuUse the Command menu to change the current schedule for one or more sessions in the Schedule Manager window. In addition to using the Command menu, you can temporarily control scheduled sessions by disabling a Client in Client Profile or disabling a session in Session Editor:

• Disabling a Client (Client Profile) — Removes any sessions assigned to that Client from the Schedule Manager window. Consider disabling a Client when it is not processing communications properly or when making changes at the Client site that affect the sessions.

• Disabling a session (Session Editor) — Removes every scheduled instance of this session from the Schedule Manager window. Consider disabling a session when you are editing any portion of the session (its work objects, assignments, options, etc.) and do not want the session to execute while changes are in progress.

The Command menu contains the following submenus and commands:

• Execute Now — Executes a session immediately. The session also runs at its next scheduled time. Options are:

• Selected Session — Starts the currently selected session.

• by Session — Displays the Select Sessions window, where you can choose one or more scheduled sessions to execute. Every chosen session runs immediately, as resources are available.

• Execute Now and Skip — Executes a session immediately, but does not run the session at its next scheduled time. Use this command when you want to start a

Note: For a list of general menu commands, see “Menu commands common to most programs” on page 25.


session early and skip its originally scheduled time. The session resumes its normal schedule for the remaining dates and times. Options are:

• Selected Session — Starts the currently selected session.

• by Session — Displays the Select Sessions window, where you can choose one or more scheduled sessions to execute. Every chosen session runs immediately.

• Skip — Bypasses the session’s next scheduled execution time for Pending or Blocked sessions. The Scheduler resumes the session’s normal schedule for remaining dates and times. Select one of the following items to skip:

• Selected Session — Skips the next schedule for a selected session.

• by Session — Skips one or more sessions that you select in the Select Sessions window.

• by Client — Skips all the sessions assigned to one or more Clients you select from the Select Clients and Client Groups window.

• Abort Active Session — Stops any session activity that is currently active. You might want to stop a session that is distributing incorrect files or a session that should not be running on this Client. Select one of the following commands:

• Selected Session — Terminates the selected active session.

• All Active Sessions on Current Server — Terminates all active sessions on the Server you are currently viewing. In a RemoteWare cluster, this is the Server selected by the Selected Current Server command and the Server name displayed in the title bar.

• All Active Sessions on All Servers — Terminates every active session on all clustered Servers.

Stop all sessions when you want to quickly terminate all session activity. To gracefully shut down session activity, click Suspend on Current Server or Suspend on All Servers on the Scheduler menu. Schedulers turned off using these commands complete any active and blocked sessions.

• Suspend Session — Prevents blocked or pending sessions from executing at their scheduled start time(s). Sessions remain suspended until you reactivate them using the Resume Session command. Options are:

• Selected Session — Suspends the selected session.

• by Session — Displays the Select Session window, where you can select one or more sessions to suspend.

• by Client — Suspends any sessions assigned to one or more Clients or Client groups that you select.


• Resume Session — Releases suspended sessions for execution. Select one of the following items to resume:

• Selected Session — Resumes the selected session.

• by Session — Displays the Select Session window, where you can select one or more sessions to resume.

• by Client — Displays the Select Clients and Client Groups window, where you can select one or more Clients or Client groups. Resumes the sessions assigned to these Clients or groups.

• All Suspended Sessions — Resumes the schedules for all suspended sessions.

• Select Current Server — For clustered Servers, specifies which Server to view in the Schedule Manager window. The current Server’s name appears in the title bar. Viewing different Server schedulers is useful for checking the status of and manipulating scheduled sessions.

View menu For information about the detail pages, see “Details for Session window” on page 254.

• Detail — Displays the Details for Session window for the selected session. This window contains several pages of information on the session.

• Set Refresh Time — By default, the contents of the Schedule Manager window are updated every 20 seconds. Use this command to change the time interval for auto updates (from 10 to 60 seconds). The Refresh Automatically option must be enabled for this interval to have any effect. The default interval is restored whenever you exit and re-enter the Schedule Manager.

• Refresh Automatically — When enabled, updates the Schedule Manager window once during the time interval you set (by using the Set Refresh Time command). Select this option when you want to continually see the current schedule. Disable this option if you have a large amount of scheduling activity or want to refresh the window manually.

• Refresh — Immediately updates the Schedule Manager window. You can use this command or press [F5] to refresh the window before the refresh time interval expires, or to manually refresh the window.

Filter menuUse the Filter menu to view only selected sessions in the Schedule Manager window. For example, you can display only those sessions you want to manipulate or those that have a particular status. You can combine filters as needed; each filter is cummulative of any filter already in use until you choose the Remove All Filters command.


• by Client — Displays sessions assigned to one or more selected Clients or Client groups.

• by Server — Choose the current Server to view scheduled sessions on that Server. This filter is available for clustered Servers.

• by Session — Select one or more sessions to display all their scheduled sessions.

• by Active — Use the blue filter to display active sessions.

• by Blocked — Use the red filter to display blocked sessions.

• by Pending — Use the black filter to display pending sessions.

• by Suspended — Use the green filter to display suspended sessions.

• Remove All Filters — Clears all filter activity and displays all currently scheduled sessions.

• Read Filters — Applies an existing filter to the Schedule Manager window.

• Write Filters — Saves the current filter settings to a file for later use.

Scheduler menuUse the Scheduler menu to stop and start the Scheduler on the current Server or all clustered Servers. If you suspend the Scheduler, active sessions will run to completion, but other sessions do not execute. In addition, an alarm appears in the Network Status program. The Alarms view displays a message when Schedulers are stopped.

The current Server’s name is reflected in the Schedule Manager’s window title bar. Use the Command menu’s Select Current Server command to control which Server is the current Server.

The current Server’s Scheduler state appears on the menu bar as Scheduler-ON or Scheduler-OFF. In addition, a check mark appears next to the currently active menu item in the Scheduler menu.

• Suspend on Current Server — Stops the Scheduler from processing new sessions on the current Server. The Scheduler remains off until you select Resume on Current Server or Resume on All Servers. You can also turn the Scheduler off using the Network Status program.

• Resume on Current Server — Reactivates the Scheduler on the current Server and begins to process backlogged blocked and pending sessions.

• Suspend on Restart on Current Server — Stops the Scheduler from processing new sessions on the current Server after the next and any subsequent restarts until the


Resume on Restart on Current Server command is invoked. The Scheduler’s current state, on or off, is not impacted by this command.

• Resume on Restart on Current Server — Reactivates the Scheduler on the current Server after the next and any subsequent restarts. The Scheduler’s current state, on or off, is not impacted by this command.

• Suspend on All Servers — Suspends pending or blocked sessions on all clustered Servers, while allowing active sessions to run to completion. The Scheduler remains off until you select Resume on Current Server or Resume on All Servers.

• Resume on All Servers — Reactivates the Schedulers on all clustered Servers, allowing backlogged pending or blocked sessions to start. Use this command when one or more Schedulers are off and you want to start them simultaneously.

• Suspend on Restart on All Servers — Stops the Scheduler from processing new sessions on all clustered Servers after the next and any subsequent restarts until the Resume on Restart on All Servers command is invoked. The Scheduler’s current state, on or off, is not impacted by this command.

• Resume on Restart on All Servers — Stops the Scheduler from processing new sessions on all clustered Server after the next and any subsequent restarts. The Scheduler’s current state, on or off, is not impacted by this command.

You can use the RemoteWare Administrator program to view and manage Scheduler states for your entire cluster in a single view. See “Scheduler Control property page” on page 64.


Schedule Manager main windowIn the RemoteWare Menu, double-click the Schedule Manager icon (located in the All Utilities or Server Operations group). The Schedule Manager main window displays the list of scheduled sessions for the current Server.

By default, clusters and Workstations display the first responding Server. For a clustered Server, this is usually the local Server itself.

The title bar indicates which Server owns the displayed schedule. This name changes if you use a cluster and click Select Current Server on the Command menu. Take care to choose the correct Server when using any operation that affects the current Server.

Beneath the menu and toolbar are the current totals for all possible schedule status values on the current Server.

The list box contains a line for each enabled session that is scheduled for an enabled Client. For example, an enabled session assigned to six enabled Clients occupies six lines in the Schedule Manager. For each line in the list box, Schedule Manager displays the following information:

• Flags — Symbols to indicate special conditions. Flag definitions appear above the list box and below the toolbar. One or more of the following flags may appear:

• 1..9 — One number indicates the session (not the work object) priority. Higher number priorities receive resources before equally configured lower-priority resources. No number indicates zero (0) priority.

• * — Retry. The first attempt to execute this session was unsuccessful. The Scheduler is re-executing the session.

• - — Once only. The session was scheduled to run only once.

S c h e d u l e M a n a g e r m a i n w i n d o w 253

• Session — The session name as defined in Session Editor.

• Client — The individual Client assigned to the session. Process Only sessions do not connect to the Client; however, Client specific information (such as the <ClientHome> variable) can be used during the session.

• Start Time — For pending sessions, displays the date and time when the session is supposed to execute. For active, blocked, or suspended sessions, the date and time reflects when the session started or would have started executing. Dependent sessions do not have definite schedules and display DEPENDENT.

• Type — The type of session. Possible session types are:

• Inbound — Does not appear in Schedule Manager unless a session is active. The Client initiates a connection to the Server and uses the default inbound session or one assigned inbound session.

• Outbound — Scheduled for execution by the Server. The Server initiates a connection to the Client at a specific time.

• In/Out — Although In/Out sessions are scheduled for execution by the Server at a specific time, Clients can also initiate the connection and use this session.

• Process Only — Scheduled for execution exclusively on the Server; there are no connections initiated by or to Clients. Process Only sessions must be assigned to Clients but do not connect to them.

• Multicast — Used to connect to Multicast Clients and for assigning work objects containing Multicast events.

If the Long Distance Service field has not been completed for a Client’s Async resource, when the Server attempts to initiate an outbound session, the attempt will fail with a “blocked” status in Schedule Manager.

• Status — The current execution state for this session. Possible states are:

• Active — This session has obtained a resource and is currently executing.

• Blocked — It is time for the session to run, but there are no available resources. This may be due to a shortage in compatible resources, a mismatch between what the session requires and what the Server has defined, or the assigned priority for the resource is greater than the session priority.

• Pending — These sessions are not yet active; they are scheduled to start in the future.

• Suspended — This session will not execute until it is released with the Resume Session command. It was originally halted before the start time with the Suspend Session command.


Details for Session windowThe Details for Session SessionName window provides additional information about a particular session in Schedule Manager. In the Schedule Manager main window, use the following methods to display the Details for Session window:

• Double-click a session name in the list;

• Select a session, and on the View menu, click Detail; or

• Select a session and press [Enter].The Details for Session window includes some or all of the following property pages, based on the type of session you selected.

• General

• Objects

• Options

• Dependent Session Details

General property pageThe General property page lists values associated with session properties, such as session execution and resource allocation and usage information. To display the General property page, click the General tab.

D e t a i l s f o r S e s s i o n w i n d o w 255

The list box contains a Session Property list and the corresponding Value for each item in the list. Items include:

• Status — The current execution state for this session. Values come from the Status column in the Schedule Manager main window and may be Pending, Blocked, Suspended, or Active.

• Start time — The date and time when this session was scheduled to begin execution. This value originates from the Start Time column in the main window; it is listed as DEPENDENT for Dependent sessions.

• Range — The amount of time available to run this session. This window begins after the start time and is originally set from the “Stop trying outbound calls after n hour(s)” field on the Schedule page in Session Editor. If the session could not execute during this window, the Scheduler makes no further attempts and logs an Out of Range error to the Session Log.

• Inbound Range — Applicable for In/Out (also called Both) sessions only. Specifies the time window when a Client can connect and start this session before the session start time. This value is set from the “Do this session early if a Client calls within n hour(s) before scheduled outbound start time” field on the Schedule page in Session Editor.

• Client name — The Client assigned to this instance of the session. This is the Client name defined in the Client Profile program.

• Session priority — The execution order of this session from 0 (no priority) to 9 (high priority). This value is set in the Session Priority field on the Schedule page in Session Editor. Typically, higher priority sessions receive resources first if other lower priority sessions are in the blocked queue for the same resource.

• Session type — The tasks and connections this session can perform. The Inbound, Outbound, In/Out, and Process Only values are originally set on the Schedule page in Session Editor.

• Retries left — Indicates how many retries are left out of the total retries available. The number of total retries are set in the Number of Retries field on the Schedule page (Session Editor). The counter lists “0 out of 0” if the Enable Retries field is not selected on the Schedule page in Session Editor.

• Current retry — Indicates how many times the Server has attempted to execute this session.

• Retry frequency — The amount of time between retries. This value originates from the Interval field on the Schedule page in Session Editor.

• Use alternate resource on retry — After a specified number of retries, uses the alternate resource defined on the Server page in Client Profile. This value is set in the Alternate resource on retry # field on the Schedule page in Session Editor.


• Resource — The connection method used by this session to reach the Client. Also lists the long distance service for asynchronous Clients. This value is determined on the Server page in Client Profile. Values can be: ASYNC-<Long Distance Service>, NETBIOS, TCP/IP, IPX/SPX, MULTICAST and PROCESS ONLY.

• Modem type — Only for asynchronous resources. The modem name chosen for this Client’s current resource. These values are originally defined on the Client and Server pages in Client Profile.

• Matching ASYNC ports — Only for asynchronous resources. The value designates which Server has scheduled this session, and the number of matching ports available for the session. If no number appears after the Server name, then no appropriate resources exist for this session.

• Matching resource counts — Only for network-based resources. Indicates which Server has scheduled this session, and which resource number can be assigned to this session. Clustered Servers may allocate a resource on more than one Server if resources are available, but the session only executes once. If no number appears after the Server name, then no appropriate resources exist for this session.

Objects property pageWork objects assigned to sessions conditionally execute when the session runs. Other objects assigned to Clients or users execute along with the session, but may not be assigned to the session. The Objects property page lists objects that would execute if the session ran at that moment. This list may differ at the execution time because of changes to work objects, sessions, or variables that affect work object execution.


To display the Objects property page, click the Objects tab.

To view details about any object on this page, double-click it. Depending on the object’s type, the Server displays the list of events for the object.

The first list box contains the objects that would execute if the session ran immediately, based on the current state of the Server. For each object, this information appears:

• Objects that will be executed — The name of the work object that would execute if the session ran at this point in time.

• Status — Indicates whether the object is available for execution (Enabled).

• Type — The object’s type, which determines what kinds of tasks this object performs. Values can be Esd or Worklist. The group, application, and application group objects do not appear in these lists because they are expanded into their component objects.

For details about General Attributes, see “General Attributes property page” on page 192.

• Priority — The object (not session) priority. This value is set on the General Attributes page in Work Object Editor. Objects are listed in descending priority; the higher values execute first.

The second list box contains objects that would not be executed if the session ran immediately. For each work object in this window, this information appears:

• Objects that will NOT be executed — The names of the objects that will not execute, given the current state of the Server.


• Reason — The reason(s) why this object will not execute. The following table lists possible reasons and specifies which control determines the setting.

Table 42. Reasons why objects do not execute

Reason Controlled by Description

ESD disabled (Global) Server Profile, Settings page; For all Clients, enable ESD field.

All ESD work objects on this RemoteWare system will not execute.

Apps disabled (Global) Server Profile, Settings page For all Clients, enable Applications field.

All application and application group objects on this RemoteWare system will not execute.

ESD disabled (Session) Session Editor, Options page; No ESD during Session field.

All ESD objects do not execute when this session runs.

Apps disabled (Session) Session Editor, Options page; No Applications during Session field.

All application and application group objects do not execute when this session runs.

ESD disabled (Client) Client Profile, General page; Electronic Software Distribution field.

All ESD objects do not execute when the session assigned to this Client runs.

Apps disabled (Client) Client Profile, General page; Application Work Objects field.

All application and application group objects do not execute when the session assigned to this Client runs.

Deleted Work Object Editor; File Delete command.

This work object is in the process or has been deleted from the Server.

Disabled Work Object Editor, General Attributes page; Enabled field.

The object is not available for execution because it has been disabled.

Requestable Work Object Editor, General Attributes page; Execution field.

The object will not execute unless the Client user explicitly requests it.

Limited by Client type Work Object Editor, General Attributes page; Limit Object Execution to Client Type(s) field.

The Client assigned to this object does not have an operating environment compatible with this object.

Execution window Work Object Editor, General Attributes page; Execution Window field.

The object is currently not within the time range for the execution window. The object may still execute if it falls within the execution window during the start time.


Options property pageThere are several options throughout the Server programs that affect object execution, file transfer behavior, and features at the Client. You can view the status of these options on the Options page.

To display the Options property page, click the Options tab.

This page lists option settings in sections: for all Clients, for this Client, and for the session. The following table summarizes these settings and lists the Server programs that control the options.

Activation window Work Object Editor, General Attributes page; Activate on or Deactivate on field.

The object is not within the date and time range set to activate this object. The object may still execute if the start time is in the activation window.

Session objects only Session Editor, Options page; Limit execution to assigned Session Objects.

Only the objects directly assigned to the session will execute. These objects are assigned to a user or Client.

Table 43. Options page attributes

Option Controlled by Controls

For all Clients

Table 42. Reasons why objects do not execute (Continued)

Reason Controlled by Description


Dependent Session Details property pageDependent sessions execute when one or more criteria have been met by another monitored session. You can view the counts and status for a dependent session on the Dependent Session Details property page.

ESD is enabled or disabled. Server Profile, Settings page; For all Clients, enable ESD.

Execution of ESD objects for every session on this system.

Applications are enabled or disabled.

Server Profile, Settings page; For all Clients, enable Applications.

Whether application or application group objects execute for any session in this system.

Compression is enabled or disabled.

Server Profile, Settings page; For all Clients, enable Compression.

Software file compression when this option is enabled.

For Client Clientname

ESD is enabled or disabled. Client Profile, General page; Electronic Software Distribution field.

ESD objects when this Client connects with the Server.


Client Profile, General page; Application Work Objects field.

Application or application groups when this Client connects.

File Attributes are enabled or disabled.

Client Profile, General page; Client Type field.

Server’s handling of files from non-Windows systems.

Inbound Work Object Selection is enabled or disabled.

Client Profile, General page; Inbound Work Object Selection field.

The Client’s ability to select Default or Requestable work object execution types before connection from a menu.

For this Session

ESD is enabled or disabled. Session Editor, Options page; No ESD during Session field.

ESD objects which execute when this session runs.


Session Editor, Options page; No Applications during Session field.

Application and application group objects which execute when this session runs.

Execution is or is not limited to assigned Session Objects.

Session Editor, Options page; Limit execution to assigned Session Objects field.

Any object not assigned to the session. Assigned objects appear on the Objects page in Session Editor.

Table 43. Options page attributes

Option Controlled by Controls


The Dependent Session Details page displays only for dependent sessions. To display this page, click the Dependent Session Details tab.

The page displays session properties and their associated values:

• Current counts — Counters display the current status totals for finished monitored sessions. An asterisk (*) indicates that the session runs when the combined totals equal the assigned/enabled value.

The counters are:

• n successful/completed — The total number of monitored sessions that finished with a successful or completed status.

• n failed — The current total of failed monitored sessions.

• n out of range — The current total of monitored sessions that did not execute during the execution window.

• n assigned/enabled — The total number of Clients assigned to the monitored sessions. This is the number of sessions with an asterisk “*” that must run for the dependent session to execute. Counters with an asterisk “*” to the left of the value must reach the assigned/enabled value (and the End of window time, if an asterisk appears to the left of the date) in order for the dependent session to run.

Note: Unassigning, assigning, or deleting Clients once the session is scheduled or running may cause inaccuracies in the counter values.


• End of window time — The date and time when the execution window ends. An asterisk (*) indicates that this session will run at this time, regardless of the counter values.

• Session started for the current window? — Yes/No. Indicates whether this session has begun executing during the execution window. A Yes value occurs for currently active or blocked sessions, or if the session has run and is scheduled for a retry.

• Depends on session (aka: monitored session) — The name of the monitored session.

Loss of Scheduler Database ConnectivityOccasionally, the database for the Schedule Manager may become unavailable. The following are some scenarios that are associated with RemoteWare behavior as a result of a loss connectivity with the Scheduler’s database:

• New schedules will fail until connectivity is re-established. Schedules containing ECF that perform session assignments, for example, will report errors to the logging database.

• Sessions with a status of pending or blocked sessions remain as pending or blocked until connectivity is re-established to allow for processing to continue a normal. Sessions going out of range are rescheduled when appropriate. Errors are logged to the logging database for the Schedule Manager called Server Data.

• Any active sessions will complete, however, the status will remain as active until connectivity is re-established. Sessions going out of range are rescheduled when appropriate.

C H A P T E R

10

Network Status

The Network Status program displays the current state of your system, including

detailed resource, session, object, and Client information. The program features

dynamic status displays that provide you visual indicators of system activity.


• “Network Status at a glance” on page 264

• “Network Status main window” on page 265


• “Resource information” on page 267


Network Status at a glanceThe Network Status program provides a graphical, dynamic display of RemoteWare Server activity. Use Network Status to monitor sessions on any standalone or clustered Server as the systems connect, transfer files, and disconnect. In addition, you can display information about sessions, resources, alarms, communication statistics, and Clients.

N e t w o r k S t a t u s m a i n w i n d o w 265

Network Status main window

In the RemoteWare Menu, double-click the Network Status icon (located in the All Utilities or Server Operations group). The Network Status main window appears, displaying the current status for all RemoteWare Servers in your network.

Network Status consists of one window divided into two active panes, as described in the following table.

Table 44. Panes in the Network Status main window

This pane... Is called Description

Left pane: Tree control

Use the left pane to choose a RemoteWare Server and view its resources, communication sessions, and system alarms. When you select an item in the left pane, information on the item appears in the right pane.

Right pane: Status list box

Displays general information for a selected resource. Details (when appropriate) appear when you double-click an entry in the list or select an entry and press [Enter].


Menu commandsThe following table lists the menu commands specific to Network Status and provides a brief description of each.


Table 45. Network Status menu commands

Menu Command Is available here Description

Command View/Clear Alarm Alarms tree item Displays alarm details. Provides option to clear alarm, or displays additional information if alarm cannot be cleared.

Suspend Scheduler Anywhere in Network Status

Suspends the Scheduler for this Server. Currently active sessions will complete, but pending and blocked sessions are not started.

Resume Scheduler Anywhere in Network Status

Reactivates the Schedule for this Server. Sessions will run as scheduled.

View Split Anywhere in Network Status

Activates the splitter control between the two panes; use this control to adjust the size of the panes.

Detail ASYNC, NetBIOS, SPX, and TCP/IP tree items

Displays a window showing current and cumulative statistics for the selected resource, the current session, and the connected Client.

R e s o u r c e i n f o r m a t i o n 267

Resource informationThe tree control in the left pane displays all the Servers and their resources in a hierarchical structure. For clustered environments, the items under Server Name repeat for each Server in the cluster.

When you start Network Status, the entire tree structure appears; you can click the and controls to display more or less of the resources. When selected, each branch displays a summary for all its resources in the right pane.


Items available in each portion of the tree appear in the following table. Later sections in this chapter discuss each item in detail.

Table 46. Selectable items in the tree control

Item and hierarchy Displays this in right pane

RemoteWare Servers Running status, state, type, and time up for all RemoteWare Servers.

<Server Name> Active session and alarm count for the selected RemoteWare Server.

Active Sessions Name of the resource currently being used, attached Client, status, and comments for active sessions on a specific Server.

Alarms Short descriptions and comments for alarms on a specific Server.

Resources Status for all Resources on a specific Server. Display is similar to Server Profile Resource page; contains device information (resource type, number of available resources, port number, and maximum bps, as appropriate for the resource), status, and usage (inbound, outbound). For a general discussion about the connection resources, see “Server Profile” on page 65.

ASYNC Name (represents the consecutive number assigned to the port), attached Client, status, and current activity for all enabled asynchronous resources on a specific Server.

Multicast Name (represents the consecutive number assigned to the port), attached Client, status, and current activity for all enabled Multicast resources on a specific Server.

NetBIOS Name (represents the consecutive number assigned to the port), attached Client, status, and current activity for all enabled NetBIOS resources on a specific Server.

Process Only

Name (represents the consecutive number assigned to the port), attached Client, status, and current activity for all enabled Process Only resources on a specific Server.

SPX Name (represents the consecutive number assigned to the port), attached Client, status, and current activity for all enabled SPX resources on a specific Server.

TCP/IP Name (represents the consecutive number assigned to the port), attached Client, status, and current activity for all enabled TCP/IP resources on a specific Server.

The symbol next to the Server name has a specific meaning. For a list and explanation of each symbol, see “Server Name item” on page 270.


RemoteWare Servers item All of the information in this illustration originates from the Cluster page in Server Profile. For details, see “Cluster property page” on page 75.

In the tree control (left pane), select RemoteWare Servers to display the status and general information about RemoteWare Servers in your network.

The right pane lists one or more Servers in your system or cluster. For each Server, this information appears:

• Server. Displays the Local Server Name as defined on the Cluster page in Server Profile.

• Status. Either Enabled or Disabled. The status reflects the setting controlled by the administrator. At least one Server is enabled at all times.

• State. Either Running or Down. Reflects the operational status of a Server independent from the status set by the administrator. If a Server is down, you can consult the Message Log for details about its state.

• Type. Either Inbound, Outbound, or In/Out. Displays the current communications mode for a Server. Inbound only Servers accept calls from Clients, while Outbound Servers only place calls to Clients and do not accept incoming calls.

• Time Up. Displays the elapsed time (in days, hours, and minutes) since the RemoteWare Server service was activated.


Server Name item For an overview of the Network Status tree control, see “Selectable items in the tree control” on page 268.

In the tree control (left pane), select an individual Server to view a summary of that Server’s activity and pending alarms.

For each Server, the following information appears in the right pane:

• Active Sessions. Displays the number of active sessions on this Server. (To view details about the active sessions, click Active Sessions in the left pane. For more information, see “Active Sessions item” on page 271.)

• Alarms. Displays the number of alarms for this Server. To view or clear alarms for a Server, click Alarms in the left pane, or see “Alarms item” on page 272.

In the Network Status left pane, the image for the Server item changes depending on the Server’s state. The following table describes each symbol and state; you can use these symbols to quickly assess the condition of every Server on your system.

Table 47. Server status and corresponding symbols

This symbol Represents the following state

The Server is operating normally.

The Server is operating normally, but has one or more alarms.

The Server is down.


Active Sessions item For an overview of the Network Status tree control, see “Selectable items in the tree control” on page 268.

The Active Sessions tree control item is available for each Server in your network. Selecting Active Sessions displays every session marked as active in the Schedule Manager program.

The right pane displays active session attributes. For each Server, this information appears:

• Name. The resource name as it is listed under each of the Resources item list boxes.

• Client. The name of the Client that is currently connected to this resource.

• Status. The work object event or operation currently in progress.

• Comment. If a file transfer is in progress, this column displays the text “n% of transfer complete,” where n is 0 to 100, inclusive.


Alarms item For an overview of the Network Status tree control, see “Selectable items in the tree control” on page 268.

In the tree control (left pane), click Alarms to display both the system and user alarms for that Server.

The right pane provides the following information:

• Alarm. Provides a description of the alarm type.

• Comment. Displays additional information about the alarm, or describes what needs to be done to clear the alarm.

View/Clear AlarmYou can view details about or clear an alarm listed in the Network Status right pane. Double-click an alarm entry or click View/Clear Alarm on the Command menu when you want to:

• View more information about the alarm.

• If the alarm can be cleared, then remove the alarm from the list.

• If the alarm requires further actions, then see what needs to be resolved before the alarm is deactivated.

Note: If you have a clustered system with more than three Servers, bringing multiple Servers down results in an alarm being registered in the alarms section only for the last Server brought down.


Resources item For an overview of the tree control, see “Selectable items in the tree control” on page 268.

In the tree control (left pane), click Resources to display every communications resource currently allocated for that Server. For information about a specific resource, see “Individual resource items” on page 274. To make changes to a resource, use the Server Profile property pages.

To display resources that are currently in use, select Active Sessions for all resources, or one of the individual items under the Resources item.

The right pane displays general resource attributes. This window does not distinguish between busy and idle resources. For each resource, this information appears:

• Port #. (Valid only for async resources.) Lists the RemoteWare port number assigned when this resource was created. This number ranges from 0 to 63 and corresponds to a serial communications port assigned to a modem or serial device.

• Device. Displays the resource type. These resources can be asynchronous or network based. Asynchronous based resources, such as COM ports attached to modems, are listed individually by the hardware device number. Therefore, COM20 directly corresponds to hardware designating a communications port as COM20. Network based resources (such as NetBIOS, SPX, and TCP/IP) are listed collectively, and show the number of allocated sessions in parentheses. For example, SPX(32) means that up to 32 communication sessions may use the SPX protocol.

• Max bps. (Valid only for async resources.) Displays the maximum transfer rate (in bits per second).

• Status. Either Enabled or Disabled. Designates resource availability for sessions.

• Usage. Either Inbound, Outbound, or In/Out. Indicates whether this resource is configured to accept calls from Clients, place calls to Clients, or both.


Individual resource items For an overview of the tree control, see “Selectable items in the tree control” on page 268.

When you select a resource type (ASYNC, NetBIOS, Process Only, SPX, or TCP/IP) in the left pane, the right pane displays the activity of every allocated resource of this type.

The available items are:

• ASYNC. Displays the communication status of asynchronous ports.

• NetBIOS. Lists NetBIOS network-based resources and their session activity.

• Multicast. Lists Multicast network-based resources and sessions activity.

• Process Only. Displays sessions internal to the Server and its associated local network.

• SPX. Lists SPX network-based resources and SPX session activity.

• TCP/IP. Shows network status and session activity for allocated TCP/IP resources.For each individual resource, the right pane lists each allocated resource or communications port as a separate entry. You can view details for each resource by double-clicking the entry, selecting the entry and choosing Detail from the View menu, or selecting the entry and pressing [Enter]. More information on the detail windows is available in the Resource, Session, and Client property page sections later in this


chapter.

The Network Status right pane displays the following information for each entry:

• Name. Lists the individual resource name, which includes the resource type and the resource number, such as NetBIOS-12 or ASYNC-1.

• Client. Indicates which Client is connected to this resource.

• Status. Displays the connection status or the action currently in progress.

Possible states are:

• CALLING. Indicates that a connection is currently being attempted.

• CONNECTING. Indicates that a connection is being attempted on this resource by either a Client or the Server.

• DISCONNECTED. Indicates that a connection has recently been completed on this resource.

• Event Name (such as COPY, GET, or WAIT). Indicates that this event is currently being processed.

• LISTEN. Indicates that the Server is monitoring the resource for an inbound call.

• Comment. If a file transfer is in progress, this column displays the text “n% of transfer complete,” where n is 0 to 100, inclusive.

Resource property page

For an overview of the available resources, see “Individual resource items” on page 274.

You can view details for any ASYNC, NetBIOS, SPX, or TCP/IP resource listed in the Network Status right pane. There are three ways to do this:

• Double-click the entry in the right pane; • Select the entry, and on the View menu, click Detail; or • Select the entry and press [Enter].

Note: If the right pane is blank, then the resource type is down or Server Profile has allocated zero (0) of this resource. If necessary, use the Resources page in Server Profile to adjust the number of available sessions. Or to view more information, click Resources in the Network Status tree control, or see the Messaging Log view in Log Viewer.

Note: When the Server is first installed, idle resources have a blank status. After the resource is used for the first time, the idle resource displays DISCONNECTED in the Status column.


The Details for ResourceName window appears, displaying the property page last accessed. You can view one or more detail windows at a time for different resources or the same resource. In addition, you can still interact with the Network Status program and other Server programs while the detail windows are active.

The Resource property page is the first of three pages in the Details for ResourceName window. To view this page, click the Resource tab.

The Resource page displays communication definitions and transmission statistics for the current session. This information is updated dynamically, as the session is running. Depending on the resource type, the Resource property page displays this information:

• Resource. Either NetBIOS, SPX, TCP/IP, or for asynchronous resources, the Resource Number followed by the COMn port number (for example, 1 COM2).

• State. Either NOT CONNECTED, LISTEN, CONNECTING, or CONNECTED. Indicates if the resource is idle or busy.

• Data Rate. (For asynchronous resources only.) Displays the communications transfer rate as defined in the Max Data Rate field in Server Profile.

• Modem. (For asynchronous resources only.) Displays the modem name assigned to this communications port.

• Inbound #. (For asynchronous resources only.) Displays the phone number on the port assigned to this asynchronous resource.

• Packet Statistics. This box displays values for both the current session and the cumulative past. Cumulative values collect for all data transfer activity on this resource, until you click the Reset button.


• Current statistics include information about the session now running. (If a session is not running on this resource, these fields will show zeroes.) After the session, these statistics are added to the Cumulative totals.

• Cumulative statistics provide a running total of the statistics, which can be helpful in identifying transmission difficulties related to this resource. These totals are updated at the end of each session.

• Packets Sent. The number of packets sent via this resource. A packet is a sequence of data and control elements (bits) that are transmitted as a whole unit.

• Packets Rcvd. Shows the number of packets received at the Server via this resource.

• Packet Rexmits. Displays the number of packets that had to be retransmitted. These occur when sent data is not acknowledged as received within a certain amount of time. This figure can indicate transmission difficulties that could result in longer transmission times. Use this figure to determine the percentage of retransmitted packets based on the total of Packets Sent and Packets Received. Numbers higher than your acceptable range (some network administrators define up to 1% acceptable) may indicate transmission problems. To adjust the values of packet retransmit times, use the Server Profile Protocols page.

• Packet Rejects. The number of packets deemed unacceptable when received. These occur when data in a packet is corrupted or lost during transmission and the received data does not match what was sent. If the numbers in this field are higher than the numbers in the Packet Rexmits field, you may have transmission problems. Data packets and windows can be changed to compensate for the quality of lines used.

• Bytes Sent. Displays the total number of bytes sent to Clients via this resource.

• Bytes Received. Displays the total number of bytes received by the Server via this resource.

• Total Time. Indicates the time (in seconds) the port was in use for this session or since you reset the cumulative totals.

To close the Details window and return to the Network Status main window, click Close. To set the cumulative statistics totals back to zero, click Reset.

Session property page



• Double-click the entry in the right pane; • Select the entry, and on the View menu, click Detail; or • Select the entry and press [Enter].


The Details for ResourceName window appears, displaying the property page last accessed. You can view one or more detail windows at a time for different resources or the same resource. In addition, you can still interact with the Network Status program and other Server programs while the detail windows are active.

The Session property page is the second of three pages in the Details for ResourceName window. To view this page, click the Session tab.

This page displays session, work object, event, and file level information currently executing on this resource. Fields are blank if the resource is idle. Information includes:

• Session. Shows the name of the session that is currently running.

• Client. Displays the name of the Client connected to this resource.

• Start Time. Indicates the time the connection began for this session.

• Line Status. Either NOT CONNECTED, LISTEN, CONNECTING, or CONNECTED. Indicates if the resource is idle or busy.

• LD Service. Shows the name of the long distance service used for this communication session. Applicable only to outbound sessions.

• Retries Left. Indicates how many times this communication may be reattempted before it is logged as a failed session in the Session Log. This value is set for the session on the Schedule page in Session Editor.

The Current Event Information area presents work object, event, and file level information about the current session. It contains these statistics:

• Event. Displays the current event number and the total number of events in the session.


• Start Time. Shows the starting hour, minute, and second for the current event.

• Work Object. Displays the object name which contains the event currently being processed.

• Command. Shows the event that this work object is processing.

• Server Path. Displays the associated file(s) and path for this event. This field is blank if the event does not involve a file.

• Client Path. Shows the associated Client file(s) and path for this event. This field is blank if the event does not involve a file that resides at the Client.

• File Date. When an event involves a file, then this field displays the “last modified” date and time associated with the file. Otherwise the field is blank.

• File Size. The total number of bytes in the file being transferred. This field is blank if the event does not involve a file.

• Bytes Transferred. Shows the number of bytes successfully transferred. This value also influences the following fields:

• The percentage to the left of the progress bar shows the amount of a file transferred with respect to the total file.

• The progress bar is a graphical depiction of the percentage value.To close the Details window and return to the Network Status main window, click Close.

Client property page



• Double-click the entry in the right pane; • Select the entry, and on the View menu, click Detail; or • Select the entry and press [Enter].The Details for ResourceName window appears, displaying the property page last accessed. You can view one or more detail windows at a time for different resources or the same resource. In addition, you can still interact with the Network Status program and other Server programs while the detail windows are active.

Note: The Reset button is unavailable on this page.


The Client property page is the third page in the Details for ResourceName window. To view this page, click the Client tab.

This page displays current and cumulative communications statistics and attributes for the Client. Information on this page includes:

• Client Name. Displays the name of the Client that is currently connected to this resource.

• Description. Provides a short description for the Client using this resource. This value is defined in Client Profile.

• Primary Rsc. Shows the primary resource assigned to the Client on the Server page in Client Profile.

• Disk. Indicates the default Client drive volume. If no path is specified in a session event, then any transfers are placed on this drive and directory.

• Size. Indicates the total storage capacity of the Client’s hard disk in bytes. This value includes total space for the drive specified in the Disk field, not for every volume or disk on the Client.

• Free. Indicates the amount of free disk space on the Client’s hard disk volume in bytes. This is computed for the drive listed in the Disk field.

• Cumulative Client Statistics. Provides a running total of the statistics, which can be helpful in identifying transmission difficulties related to this Client. The Server updates statistics with current session information when you exit and reenter the Details for ResourceName window.

• Files Sent / Rcvd. Lists the number of files sent to the Client or the number of files received from the Client.

The Disk Size and Free fields are only updated if the CHECK CLIENT DISK work object is assigned to the Client. This work object is not assigned by default.


• Messages Sent / Rcvd. Lists the number of MAPI messages sent to the Client or the number of messages received from the Client.

• Packets Sent / Rcvd. Displays the number of packets sent to the Client or received from the Client via this resource. A packet is a sequence of data and control elements (bits) transmitted as a whole unit.

• Packet Rexmits / Rejects. Rexmits displays the number of packets that had to be sent again to the Client. Rejects shows the number of packets that were unacceptable in transmission. The number of Rejects is typically much lower than the Packet Rexmits.

These values can indicate transmission difficulties that could result in longer transmission times. You can determine the percentage of retransmitted packets based on the total of Packets Sent and Packets Rcvd. Numbers higher than an acceptable threshold (for example, some administrators consider up to 1% Rexmits/Rejects to be acceptable) can indicate transmission problems. To adjust the packet/window size, use the Server Profile property pages or assign a different protocol to the Client using Client Profile.

• Bytes Sent / Rcvd. Shows the total number of bytes sent to or received from this Client.

• Total Time. Shows the time (in seconds) that the Client has been in communication with the Server since the last time the cumulative statistics were set.

To close the Details window and return to the Network Status main window, click Close. To set the cumulative statistics totals back to zero, click Reset.

C H A P T E R

11

Log Viewer

Use the Log Viewer program to monitor current or past system activity from one

convenient user interface. This chapter presents Log Viewer’s user interface features,

available commands and options, and methods for filtering logs.


• “Log Viewer at a glance” on page 284


• “Log Viewer main window” on page 291

• “Item detail dialog boxes” on page 303

• “Logging database schema” on page 310


Log Viewer at a glance For information about setting up logging, see the RemoteWare Server Installation Guide.

You can use Log Viewer to examine this log information from one convenient interface within RemoteWare Server. Log Viewer lists the occurrence of any action that affects the Server, including information about session history, file transfers, and Server messages. In addition, Log Viewer includes logs for Inventory Manager and Messaging, if you have installed these optional components on your Server or cluster.

Log Viewer consists of one main window and several secondary windows and dialog boxes; for details, see “Log Viewer main window” on page 291. It also contains windows that provide access to detailed information about different types of log entries, sessions, work objects, and events. For more information, see “Item detail dialog boxes” on page 303.

Quick Filter ViewsThe Quick Filter Views are provided to streamline the filter definition process. It reduces the time and number of steps it takes to setup a filter view. Several predefined Quick Filter Views are provided with Log Viewer. You select a filter and then select the values you want included in the Quick Filter View. You can also add or remove Quick Filter fields as desired.

The Quick Filter Views are predefined and you need to select the values on which to filter the view. Refer to Customizing an existing Quick Filter View in the Log Viewer Help or RemoteWare Server Administrator’s Guide for instructions on how to select the filter values.

File Transfer Quick FiltersThe File Transfer Quick Filters default view displays data for actual and attempted file transfers. The view includes the Start time, Client Name, Status (FAILED or SUCCESSFUL), Command (GET, SEND, or CHECK SEND), and File Name fields for the following filters:

• Client

• File

• Time Range

• Sessions

• Status

L o g V i e w e r a t a g l a n c e 285

Inventory Manager The Inventory Manager Quick Filters default view displays the log views from the Client inventory scans, which includes hardware and software scan results. Each log includes the activity (scan description), activity ID, client name, date and type (Info). This view has the following predefined filters:

• Activity

• Client

• Type

Messaging The Messaging Quick Filters default view displays an entry for every message received and processed by the Message Transfer Agent (MTA). Each log includes, the originating user, Client Name, Date/Time received, message priority, and size in bytes. This view has the following predefined filters:

• Client

• User

Multicast Quick FiltersThe Multicast Quick Filters default view displays the Start time, Session, Client Name, Status (FAILED or SUCCESSFUL), Message, and Row ID. This view has the following predefined filters:

• Client

• File

• Session

• Status

• Time Range

Server Message Quick FiltersThe Server Message Quick Filters default view displays the Date/Time, Server, Type (message type), and Message fields for the following filters:

• Server

• Time Range

• Type


Session History Quick FiltersThe Server Message Quick Filters default view displays the Session Name, Client Name, Status (FAILED or SUCCESSFUL), Start Time, Duration, NetMgr Name (Server Name) and Resource fields for the following filters:

• Client

• Failure Reason

• Resource

• Server

• Session

• Time Range


Menu commandsThe following table lists the Log Viewer menu commands. A section later in this chapter describes the File menu commands in detail.

Note: Not listed are the menu commands available to all RemoteWare Server programs. For a list and description of general commands, see “Menu commands common to most programs” on page 25.

Table 48. Log Viewer menu commands


File New View Creates a custom log view.

New Folder Creates a new folder for grouping views.

Delete Deletes the selected view or folder.

Export Saves the selected log view or a portion of a log view to a text file.

Rename Saves the selected folder or view using a new name.

Properties Displays the View Properties window, which lists the current properties for the selected view. Use this window to select fields and filters for the log view. For details, see “View Properties window” on page 294.

Quick Filter The Quick Filters Views streamlines the filter definition process. It reduces the time and number of steps it takes to setup a filter view. Several predefined Quick Filter Views are provided with Log Viewer.

Row Detail Displays the field details for the selected row. For more information, see “Item detail dialog boxes” on page 303.

Edit Cut Removes a folder or log view from its present location and moves it to the Clipboard.

Copy Duplicates the current view or folder and moves the copy to the Clipboard.

Paste Places the previously cut or copied item in the selected location.


File menuUse commands on this menu to: organize views into folders; create, rename, or delete custom log views and folders; export portions of a view to a file; and view or modify properties of log views. For a brief description of File menu commands, see “Table 48. Log Viewer menu commands” on page 287. This section provides detailed information about specific commands and their corresponding dialog boxes, where applicable.

• New View. Opens the View Properties window, where you can specify fields for this log view. (For details about the window options, see “View Properties window” on page 294.) The name of the folder you selected when you created the new view appears in the first area. You cannot choose another parent folder in this window. Instead, close the View Properties window and select another folder in the left pane of Log Viewer.

For step-by-step instructions on creating log views, refer to the RemoteWare Server Administrator’s Guide.

View Font Allows you to set the font, style, and size of the screen font.

Switch Window Pane Moves between the right and left window panes.

Tree Expand Folder Displays the views in the selected folder but does not open subfolders.

Tree Collapse Folder Closes the selected folder.

Expand All Opens all folders in the left pane and displays their views.

Collapse All Closes all folders in the left pane.

Parent Folder Moves to the parent folder of the selected item in the left pane.

Refresh Refresh Now Refreshes the content of the log views.

Table 48. Log Viewer menu commands (Continued)



The Parent Folder appears in the first field; this is the folder you selected before clicking New Folder. You cannot select another parent folder in the Create Folder dialog box.

• New Folder. Displays the Create Folder dialog box, where you can specify a name for the new folder in the text box provided. When you click OK, the new folder appears under the parent folder in the left pane of Log Viewer.

• Delete. Permanently removes the selected view or folder from Log Viewer. You can delete any folder or view when you no longer need it. If you delete a folder that contains several views or subfolders, Log Viewer deletes all the views and subfolders.

Tip: You can export log views when you want to save records that might otherwise be deleted during log cleanup.

• Export. Displays the Export View dialog box, where you can save the selected log view as a text file (.txt) in another location. In the Save As field, enter the path and file name for the exported log view, or click Browse to navigate to an existing folder. Select one of the following options:• All Rows. Exports the entire log

view and includes all rows.

• Row to Row. Exports a portion of the log view. Use the spin boxes provided to specify the range of rows you want to export. By selecting only the rows you need, you can save disk space.

Click OK to begin the export process using the options you specified.

• Rename. Displays the Rename dialog box, where you can specify a new name for the selected folder or view. The last name you gave the folder or view appears in the Original Name area. In the New Name field, enter a new name for the folder or view. Click OK.

• Properties. Displays the View Properties window for the selected log view. Use this window to customize the log view by adding fields and filters. For information about this window’s options, see “View Properties window” on page 294.

Note: You cannot delete the All Views folder, the top level folder in Log Viewer.

Note: You cannot rename the All Views folder, the top level folder in Log Viewer.


• Row Detail. Displays either the Row Detail dialog box or the Select Detail Type dialog box, depending on the item selected in Log Viewer. Use these dialog boxes to view additional details about the selected item. For more information, see “Item detail dialog boxes” on page 303.

L o g V i e w e r m a i n w i n d o w 291

Log Viewer main window The View Properties window is too large to fit on the screen when resolution is set to 640 x 480. You may not be able to see the buttons. To correct this, use Windows Control Panel to set screen resolution to 800 x 600.

In RemoteWare Menu, start Log Viewer by double-clicking its icon (located in the All Utilities and Server Logs groups). The main window appears.

The Log Viewer main window groups log views in folders, each in its own folder in the left pane. You can modify these default views or create new views into the logging database. The default view categories include:

File Transfer LogsThese logs record every instance in which the Server attempts to send or receive a file. Use this category to quickly determine if a file was transferred, to identify the number of file exchanges, and to view file level details. File Transfer Logs contain the following folders/views:

• Quick Filters. Predefined Quick Filter Views are provided for File Transfer logs.

• All. Displays all attempted file transfers or session information. These lists contain information such as all attempts to upload or download files, or the status of past communications sessions.

• Failed. Lists all failed file transfers or sessions.

• Sessions. Displays the file transfers grouped by session.


Inventory Manager LogsIf licensed for Inventory Manager, this category displays the log views from the Client inventory scans, which includes hardware and software scan results. Each log includes the activity (scan description), activity ID, client name, date and type (Info). Inventory Manager Logs contain the following folders/views:

• Quick Filters. Predefined Quick Filter Views are provided for Inventory Manager logs.

• All. Lists all inventory scanning information, including the names of the Clients scanned, the type of inventory scan performed, and the scan date.

Messaging LogsIf licensed for Messaging, this folder contains log views that record all messaging activity about the RemoteWare system. This log includes the originating user, the date and time, and the size of the message. Messaging Logs contain the following folders/views:

• Quick Filters. Predefined Quick Filter Views are provided for Messaging logs.

• Messaging. Lists all messages exchanged in the RemoteWare system, including information about the originator’s user ID and Client name, the subject of the message, the send date and time, and message size.

Multicast LogsIf licensed for Multicast, this folder displays the log views from the Multicast sessions that have been run. Each log includes, start time, session, client name, status, message, and row ID. Multicast Logs contain the following folders/views:

• Quick Filters. Predefined Quick Filter Views are provided for Multicast logs.

• Failed. Lists all failed Multicast file transfers or sessions.

• Successful. Lists all successful Multicast file transfers or sessions.

• All. This log displays all Multicast sessions that have been run for all clients.


Server Message LogsThese log views include: all information, warning, and error messages specific to the Server. Use this category to find information about when sessions were created, modified, and deleted, when the RemoteWare service was started and stopped, and when a worklist was modified. Server Message Logs contains the following folders/views:

• Quick Filters. Predefined Quick Filter Views are provided for Server Message logs.

• All. Lists all actions taken at the Server, such as features enabled, sessions created, and objects modified.

• Errors. This view lists all errors that occurred during any given session.

• User. This view displays the user defined alarms sent to the Server Log. The User Defined Alarm is an event you add to a work object to send an alarm from the Client to the Server Log. Refer to the Work Object Editor help for additional information about defining work object events.

Session History LogsThese log views record information about past sessions, such as the session’s end time and duration, the user and computer information, and the session’s event status. This log records all connection activity from the Schedule Manager, Interactive Session and inbound Client connections. Session History Logs contain the following folders/views:

• Quick Filters. Predefined Quick Filter Views are provided for Session History logs.

• All. Lists all file transfer or session information. These lists contain information such as all attempts to upload or download files, or the status of past communications sessions.

• Successful. Returns only sessions with a Status of successful

• Failed. Lists all failed file transfers or sessions.

Transaction Pipe LogsThis folder contains log views about transaction pipe APIs which have executed between the Client and server. The information includes bytes received, bytes sent, Client name, compression rate, duration, start time, end time, messages received, pipe name, port, resource, resource code, row ID, server name, status, and status code.

• Quick Filters. Predefined Quick Filter Views are provided for Transaction Pipe logs.

• All. Lists all transaction pipe transfer or session information.


View Properties window For information on creating custom log views, see the RemoteWare Server Administrator’s Guide.

Use the View Properties window to select and filter fields to display in each standard or custom log view. To display this window, select a log view in the left pane of the main window, and on the toolbar, click Properties.

The View Properties window contains the following fields and options:

• Parent Folder. Indicates the path for the selected log view.

• View Name. Displays the name of the currently selected view.

Note: You cannot modify the Parent Folder and View Name fields from the View Properties window. Change view or folder names from the Log Viewer window by selecting the item to change then clicking File, Rename.


• All Fields. Lists the available fields that you can add to customize the selected log view. This area of the window includes the following items:

• Category. Indicates the category (File Transfers, Server Messages, or Sessions) for each field. Use this information to select appropriate fields for a particular view. For example, if you are adding fields to a view in the Server Messages category, you cannot select the Client Path field because it belongs to the File Transfers category.

• Field. Lists the individual fields that you can add to the log view. The following table describes each field and lists its category.

Note: If you add fields from more than one category to your view, the view will not appear in Log Viewer.

Table 49. Categories and fields in Log Viewer

Category Field Description

File Transfers Client Displays the name of the Client computer that was involved in the file transfer event.

Client ID Displays the global unique identifier that remains constant for each Client.

Client Path Lists the path (drive letter, path name, file name) on the Client computer to/from which the Server downloads or uploads information during sessions.

Command Indicates whether the transfer took place as a result of a GET, SEND, or CHECK SEND instruction.

Compression Ratio

Shows the percent compression achieved when transferring a file. Larger compression ratios indicate better throughput. Consistently small rates may indicate files or file types that cannot be compressed.

End Time Indicates the date and time when this event stopped transferring the file.

Event ID Lists the numeric representation of the work object type.

Failure Code Shows the operating system code for the reason a file transfer failed.

Failure Reason Provides a brief explanation of the error(s) that occurred during a session. Incorporates the Failure Code at the beginning of the description. For example, if the Failure Code is 2, this field displays the following message:“SYS002: The system cannot find the file specified.”

File Date/Time Lists the date and time stamp for the transferred file.


File Name Shows the name of the file that was transferred.

File Transfers File Size Indicates the total number of bytes in the file that was transferred.

Host Path Lists the path (drive letter, path name, file name) on the Server computer from/to which the Server downloads or uploads information during sessions.

Netmgr ID Lists the Server ID number.

Raw EventCmd Shows the numerical representation of the command (i.e., GET or SEND) that was performed.

Raw Status Displays a numeric value that corresponds with the status of the file transfer.

RowID Indicates the log item’s row number in the database.

Session ID Provides a unique number that represents the session.

Start Time Displays the date and time when this event began transferring the file.

Status Shows the completion status or error type. Possible status types are SUCCESSFUL or FAILED.

Valid Mask Displays numbers that represent the status in masking fashion; values can be any of the following numbers binary OR’d together:0x0001 = File size and date are valid0x0002 = Compression rate is valid0x0004 = Valid DOS error code0x0008 = Valid no execute error0x0010 = Extended attributes included0x0020 = Extended attributes processed

Server Messages Actions Suggests actions you can take to address the specific problem or error message.

Date/Time Shows when the message was logged. By default, message entries are sorted sequentially by date and time with the most recent entries at the top of the list. You can change the sort order by clicking any column header.

Explanation Contains a longer, more detailed version of the text presented in the Message field.

Flags Lists any flags associated with the Server message.

Message Provides message text (usually beginning with RWSnnnn) that presents a brief description (255 characters maximum) and the origin of the log entry.

Table 49. Categories and fields in Log Viewer (Continued)



Server Messages NetUser Displays the NT user ID under which RemoteWare is running and the message was logged.

OS Code Shows the operating system’s status code which may indicate the source of the failure.

OS Message Explains the OS Code.

Pid Lists the Process Identification number that Windows assigns to the program that generated the message. The PID can be useful to trace this message to the Server program.

Raw Type Displays the number associated with the message type (i.e., INFORMATION or ERROR).

RowID Indicates the log item’s row number in the database.

Server Displays the name of the Server on which the message originated.

Type Displays one of four message types:Information. Messages containing information about the Server.User. Messages generated by a Server MESSAGE event.Error. Messages indicating usage or formatting errors.Fatal Error. Messages indicating a critical failure of a RemoteWare application. You should investigate the source of these errors.

Sessions Baud Rate Lists the baud rate of a session transfer on an asynchronous resource.

Client ID Displays the global unique identifier that remains constant for each Client.

Client Name Displays the name of the Client computer that was connected to the Server during the session.

Client Type Indicates the type of Client (for example, Windows NT) involved in the session. This information originates in Client Profile.

Comm Flags Displays numbers that represent the status in masking fashion; values can be any of the following numbers binary OR’d together:0x01 = ESD has been processed0x02 = CAMs have been processed0x04 = Exception worklist available0x08 = Variables have been logged0x10 = Repeat loop has been logged




Sessions Current Event Used during session recovery. Indicates where the session left off.

Duration Shows how long the session ran (in hours, minutes, and seconds).

Efficiency Not currently used.

End Time Indicates the date and time when this event completed.

Event File Provides a number that identifies the file that contains the event history details for the session.

Events Logged Shows the number of records in the worklist file that composes the event history.

Failure Reason Displays a number that represents the reason for failure of a session.

Ld Class Indicates the long distance class used to contact an asynchronous Client during this session.

Netmgr ID Displays the Server ID number.

Netmgr Name Shows the Server name.

OK Events Lists the number of successful events in the session.

Resource Displays a number that represents the type of resource used in a session.

Resource Type Lists the type of resource used for this session (either TCP/IP, SPX, ASYNC, or NetBIOS).

Retries Left For current sessions, indicates the number of outstanding retries available.

Session Name Displays the name of the session.

Session Record Reserved for future use.

Session Slot Reserved for future use.

Start Time Displays the date and time when this event began transferring the file.

Status Shows the session completion status or error type.

Status Code Lists the number that represents the session status.

Total Events Lists the total number of events in this session.

Total Tries Displays the total number of times this session attempted to run.




When you apply a filter to a field, it is not automatically added to the Fields To Display list. You must select the filtered field and click Add To View to include it in the view.

• Filter By Field. Applies a filter to the field selected under All Fields. When you click this button, the Filter dialog box appears; for details about selecting filters, see “Filter dialog box” on page 300.

• Add To View. Includes the selected field in the Fields To Display list, which adds it to the log view.

• Fields To Display. Lists the fields you have added to the selected log view. You can also use the following items in this area to remove and sort fields.

• Category. Indicates the category (File Transfers, Server Messages, or Sessions) for each field that has been added to the view.

• Field. Lists the fields that Log Viewer will display for the selected view. For a description of each field, see “Table 49. Categories and fields in Log Viewer” on page 295.

• Remove From View. Deletes the field selected under Fields To Display. When you remove a field, it does not appear for the selected log view.

• Move Up. Moves the selected field up one position in the Fields To Display list. Use this button to sort the fields in the order in which you want them to appear for the selected log view.

• Move Down. Moves the selected field down one position in the Fields To Display list. Use this button to sort the fields in the order in which you want them to appear for the selected log view.

• Fields With Filter. Lists any fields for which you have defined filters. You can also use this area to modify filters or remove them from fields.

• Category. Indicates the category (File Transfers, Server Messages, or Sessions) for each filtered field that has been added to the view.

• Field. Lists the fields that have filters applied to them. For a description of each field, see “Table 49. Categories and fields in Log Viewer” on page 295.

• Condition. Indicates the condition of the applied filter. For a list and description of possible conditions, see “Table 50. Filter conditions” on page 301.

• Value. Displays the value specified for the filter. The value and condition originate from the Filter dialog box; for details, see “Filter dialog box” on page 300.

• Remove Filter. Discards the selected filter from the field.

• Modify Filter. Displays the Filter dialog box, which you can use to make changes to the current filter. For details, see “Filter dialog box” on page 300.


Filter dialog box

For information about applying filters, refer to the RemoteWare Server Administrator’s Guide.

Use the Filter dialog box to apply filters, which narrow the data displayed in a view. To open this dialog box, select a field under All Fields in the View Properties window. (For more information, see “View Properties window” on page 294.) Then, click Filter By Field. The Filter dialog box appears.

This dialog box contains the following fields and options:

• Category. Displays the category—File Transfers, Server Messages, or Sessions—of the field to which you are applying the filter.

• Field. Indicates the field to which you are applying a filter.

The Condition is used in conjunction with the Value. Together these fields constitute a filter.

• Condition. Indicates the condition for filtering the field. Select one of the available options to set the condition. For example, you might filter the Start Time field by selecting > (values greater than). Once you specify a time in the Value field, the log view will display file transfers that occurred after that time.

Note: You cannot make any changes to the Category or Field areas. If you want to select another field to filter, close the Filter dialog box and choose another field in the View Properties window.


The filter conditions you can specify include.

The Value is used in conjunction with the Condition. Together these fields constitute a filter.

• Value. Indicates the value for the condition. For example, you might filter the Start Time field by selecting the > Condition (values greater than). Next, you would specify a date and time in the Value field. If you enter 9/15/08 as the date and 5:00 P.M. as the time, the log view displays all file transfers that occurred after 5:00 P.M. on September 15, 2008.

You can also specify more than one value for a field. For example, if you want to find file transfers that took place on a series of dates: August 3, August 4, and August 5 starting at 8:30 A.M., you can enter these dates and add them to the list. The log view will show file transfers that took place only on those dates.

Options in the Value area include:

• Value text box(es). Provides the location for manually entering a value. Use this area to enter specific information such as a date, a time, or a file size. Enter values manually if you are filtering fields for a new log view or if you need to filter the field by a specific value. Depending on the field you selected, this area displays one or two text boxes.

Table 50. Filter conditions

Condition Description

= Displays items that match the specified Value.

!= Shows items that are different than the specified Value.

< Returns values less than the Value you specify.

<= Returns values that are less than or equal to the specified Value.

> Displays values that are greater than the Value you specify.

>= Shows items greater than or equal to the specified Value.

> AND < Returns values that are greater than X and less than Y.

>= AND <= Returns values that are greater than or equal to X and less than or equal to Y.

< OR > Returns values that are less than X but greater than Y.

<= OR >= Returns values that are less than or equal to X but greater than or equal to Y.

Last (hh:mm:ss) (Appears only for fields related to time, such as End Time or Date/Time.) Last time a file transfer, session, or event occurred.


• Select Value. Displays the Field Values From Log dialog box. Use this option to select values that have already been logged. Select a value and click OK to add it to the Value list box.

• Add To List. Adds the selected Value to the Value list box. You can only add multiple values if you have chosen the = or != conditions.

• AND/OR Value. Provides a location for manually entering the second value in filter with a boolean (In Range or Out of Range) condition. For details about this area, see the previous description for the “Value text box(es).”

• Select Value (AND/OR). Provides the same function as the previous Select Value button. Click this button to select a second value that has already been logged.

• Value list box. Lists the value(s) specified for this filter.

• Remove. Removes the selected value(s) from the Value list box.

• OK. Applies the filter condition and value to the selected field. Closes the Filter dialog box and returns to the View Properties window.

• Cancel. Closes the Filter dialog box and discards any selections you have made. Returns to the View Properties window.

The conditions and values you set for a field appear in the Fields With Filter area of the View Properties window. (For details about this window, see “View Properties window” on page 294.)

Note: Adding a filter to a field does not automatically add the filtered field to the log view. To include the field in the log view, select it in the All Fields list and click Add To View.

I t e m d e t a i l d i a l o g b o x e s 303

Item detail dialog boxesIn Log Viewer, you can view additional details about a particular message, session, file transfer, or other event. To do this, select an item in the Log Viewer window, and on the File menu, click Row Detail. One of the following dialog boxes appears, depending on the item you selected in the main window:

• Row Detail dialog box. Appears for log views in the Server Messages category.

• Select Detail Type dialog box. Appears for Sessions or File Transfers. For more information, see “Select Detail Type dialog box” on page 304.

Row Detail dialog boxThe Row Detail dialog box provides information for all fields in the selected log view. In this dialog box, you can view information about a specific item in a log view without having to add fields to the view.

This dialog box contains the following items:

• Category. Indicates the category of the selected view: File Transfers, Server Messages, or Sessions.

• Field. Lists information for all fields in the category.

• Value. Displays any values you have specified for the corresponding field in the Filter dialog box. For more information, see “Filter dialog box” on page 300.


• Detail. (Available if the selected item contains a message longer than 255 characters.) If you select the Message (Long) item and click this button, you can view the entire message in the Detail for Field ‘Message (Long)’ message box.

Click OK to return to the Row Detail dialog box.

• Previous. Displays the details of the previous item in the Log Viewer main window.

• Next. Advances to the next item in the Log Viewer main window and displays its details in the Row Detail dialog box.

• OK. Closes the Row Detail dialog box and returns to the Log Viewer main window.

Select Detail Type dialog boxThe Select Detail Type dialog box appears when you select a Session or a File Transfer log view and then click Row Detail on the File menu.

Select one of the following types of log detail to view and click OK:

• Default. Opens the Row Detail dialog box, which displays all information about each field in the selected item. For more information, see “Row Detail dialog box” on page 303.

• Session Event Detail. Displays the History For Session window, which provides details about each event in a session. This option is available only for File Transfer and Sessions log views. For more information, see “History For Session window” on page 305.


History For Session window

For more information, see “Select Detail Type dialog box” on page 304.

This window provides additional information for the selected File Transfer or Session entry. It appears when you select Session Event Detail in the Select Detail Type dialog box.

By default, the History For Session window opens at the object level. This highest level of detail lists work objects; you can use this information to identify the objects executed during the session and determine where a problem may have started.

The fields at the top of the window present general information about the session including throughput performance for data transfer events and the communication session as a whole. This information includes the following:

• Client. The name of the Client that participated in this session.

• Server. The RemoteWare Server computer which executed this session.

• Status. The completion message for the entire session. This status is not necessarily the same as status codes at the object or event level. Individual events may fail, but the overall status of the session could still be successful if those events are marked as “Not required for successful completion.”

• Total Tries. The number of times this session was attempted.

• Throughput/bps. The overall data transfer performance in bits per second (bps). The throughput is a rough average of all file transfer events, protocol data exchanges, and other events that exchange data (such as the Directory event). Sometimes throughput may be higher because of higher file compression yields


with certain data types; for example, graphic files generally achieve better compression than executable files.

• Resource. The resource used during the communications session (for example, TCP or SPX).

• LD Service. For asynchronous resources, the long distance service used for this session (if applicable).

The list box contains these columns:

• Object. Displays the session’s associated work objects.

• Status. Shows the overall completion state for the session. Possible values are:

• Successful. All events in this channel executed successfully.

• Completed. Some events in the channel did not execute, but they may have been skipped by a conditional event.

• Failed. One or more events in this channel did not execute successfully or complete as expected. If this event was marked as critical, then the session terminates at this event.

• Not Executed. A work object does not execute if it follows a failed critical event, or if a prior work object terminated the session.

• Total Events. Indicates the total number of events in this work object.The History For Session window also includes the following buttons:

• Restart Session. Attempts to restart a failed session.

• Previous. Displays the detail window for the previous session in the log.

• Next. Displays the detail window for the next session in the log.

• Expand/Condense Events. (Available when objects are expanded.) Displays or hides detailed information about each event in a work object. For more information, see “Displaying event details” on page 308.

• Expand/Condense Objects. Expands or collapses the level of detail available for work objects in this session. When you first open the History For Session window, it presents information on an object level. The objects are collapsed at this highest detail level, and you can click Expand Objects to view further details. If object details are already displayed, you can click Condense Objects to collapse the objects.

• OK. Closes the session detail window and returns to the Log Viewer main window.


Displaying work object details

For information about displaying the History For Session window, see “History For Session window” on page 305.

You can display work object details to identify the events in a work object and the completion status of each event. To view object details, select a work object in the History For Session window. Click Expand Objects. (If object details are already displayed, this button reads Condense Objects.)

The object detail provides these items of information:

• Flags. Indicates if and why an event failed. The following table describes possible flag codes.

Table 51. Event flag codes

Flag code Description

* Critical event. An “F” flag next to this event indicates that it was the source of a critical failure.

- Deletes the file in the event after this event has successfully executed.

& Conditional true. Executes the event only if the previous event returned a true value or was successful.

| Conditional false. Executes this event only if the previous event returned a false value or failed.

F The event failed.

N The event was never executed.


• Event. Lists each RemoteWare command on a separate line; these events were executed in a linear fashion. The Server evaluates variables and conditional statements during start time and substitutes the values in the History For Session window.

Displaying event details

For information about displaying the History For Session window, see “History For Session window” on page 305.

In the History For Session window, you can view a description for each event. The description includes any information the event returns when successful, or the reason an event failed. To view event details, click Expand Events in the History For Session window. (If event details are already displayed, this button reads Condense Events.

These columns appear in the event detail listing:

• Status. Displays the completion result for this event. This status is different from the session status because it refers to an individual event and not the set of events as a whole.

• Start Time. Indicates the time (in hh:mm:ss format) when this event began execution.

• Duration. Shows the hours and minutes (in hh:mm format) that elapsed from the beginning to end of this event’s execution.

Note: The Expand Events button is available only when work object details are expanded. For more information, see “Displaying work object details” on page 307.


• Where. Indicates which computer executed this event: Server or Client.

• File Size. Lists the number of bytes transferred for GET, CHECK SEND, or SEND events.

• Throughput. Displays the bits per second transferred over the duration of the event. Throughput represents the transfer rate for data across a communications link.

• Compression. Displays the percentage of compression achieved during a file transfer event. The amount of compression varies depending on the file size and type. If the file was compressed, the file size displayed is the precompressed size plus a header, not the actual file size. The Compression column displays “NA” if compression was not applicable.

Improving detail dialog display time RemoteWare implements a registry key to control the size of the bulk query for retrieving session history event details. Adjusting the size may improve the response time for displaying the History for Session dialog box.

Key: NumRowsInCache

This key is optional. The key’s default value is implicit in RemoteWare operations if you do not create the key. The key is required if you want to use a non-default value. Using the key is recommended if you run sessions with thousands of work objects per session and are experiencing screen refresh issues when expanding event details in the History for Session dialog.

• Key location — HKLM\RemoteWare\Server\Logging\Database

• Name — NumRowsInCache

• Type — DWORD

• Data — Rowsize of the block of records in the bulk query. Default value is 100. Setting the value too high can adversely affect performance, as RemoteWare dedicates more resources to execute the query.

Note: If the Compression value is consistently low, then consider disabling compression on this event.


Logging database schemaSee the RemoteWare Database Schema guide for descriptions of the RemoteWare SQL database tables, including logging tables. You can use the information to build custom reports using third-party applications.

C H A P T E R

12

Session Recovery

Use Session Recovery to quickly identify Clients for which sessions were failed, failed

final, completed, successful, or missing and to restart failed or missing sessions from

within Session Recovery. In addition, this chapter presents the user interface features,

available commands and options, and methods for filtering and restarting sessions.


• “Session Recovery at a glance” on page 312


• “Session Recovery main window” on page 325

• “Troubleshooting unsuccessful restarts” on page 328


Session Recovery at a glanceSession Recovery provides a way for you to recover and resubmit sessions that have failed to run. You can access all entries in the Session Log from Session Recovery. By applying different combinations of filters to these session entries, you can identify sessions by completion status—Failed, Failed-Final, Completed, Successful, and Missing—and by other criteria, such as by Client, group, session name, and time range. Once you have identified specific Failed-Final and Missing sessions, you can then restart one or more of them with the click of a single button. This helps reduce troubleshooting time and improves your ability to effectively monitor and manage sessions in your RemoteWare system.

Some typical situations in which you could use Session Recovery include:

• Identifying Missing sessions. If the RemoteWare Server experiences a hardware failure during an outbound session or if a scheduled inbound session fails to occur, you can filter the entries in Session Recovery to view only those sessions that did not run, and then resubmit those sessions for processing.

• Locating ECF sessions. If the RemoteWare Server experiences a hardware failure while processing an ECF, you can use Session Recovery to view ECF files, identify those that did not complete, and then resubmit them for processing.

• Isolating Failed sessions. When you want to isolate the Clients that have failed to run a particular session, you can use Session Recovery to identify and quickly resubmit sessions that failed to complete successfully.

• Finding and resubmitting Failed-Final sessions. When a session has been designated as Failed-Final and you want to resubmit it for processing, you can display and resubmit it with the click of a button.

Session Recovery consists of one main window and a detail window for each listed Client. For more information, see “Session Recovery main window” on page 325.


Menu commandsThe Session Recovery menu commands include:

Table 52. Session Recovery menu commands


Command Restart All Restarts or resubmits all Failed-Final and/or Missing sessions that appear in the Client/Session list box.

Restart Session Restarts or resubmits the selected Failed-Final or Missing session.

Stop Query Stops a query.

View Details Displays the Client Information window for the selected Client. This window provides detailed information about the Client, such as Client type, primary resource, and data rate.

Search Client Displays the Search Client dialog box. Use this dialog box to search the Client/Session list box for a specific Client.

Find Next Client Highlights the next Client that matches the text in the Search Client dialog box. This command is available only if there are other entries in the list box that match the search criteria you entered previously.

Set Font Displays the Font dialog box. Use this standard Windows dialog box to select the type, size, and style of the font used to display entries in the Client/Session list.

Set Refresh Time Opens the Set Refresh Time dialog box, where you can specify the interval at which Session Recovery should refresh the session data. You can select an interval from 10 to 60 seconds. The default setting is 20 seconds.

Refresh Automatically When enabled, refreshes the main window automatically at the interval specified in the Set Refresh Time dialog box. (By default, automatic refresh occurs every 20 seconds.) This updates the list of sessions to include those that started, finished, or were logged as Missing while Session Recovery has been running.


View Refresh Immediately refreshes the session data. This updates the list of sessions to include all those that started or completed while Session Recovery has been running.

Filter by Client Displays the sessions that executed for one or more Clients or Client groups.

by Session Filters the Client/Session list so that only selected sessions appear.

by Time Range Displays the sessions executed before or after a set time, between a time range, or over a set number of days and hours.

by Status Filters the Client/Session list by the Status code, and displays the results. The Status code indicates the reason the session failed.

by ECF Filters the Client/Session list so only selected Scheduler ECF files with the extension .ece or .ecb appear.

by All Filters the Client/Session list so all the sessions based on the completion field display. The by All option includes: Successful, Complete, Failed, and Failed-Final sessions.

by Failed Sessions The yellow indicator lists unsuccessful sessions that still have pending retries available. These sessions can’t be restarted until they become Failed-Final.

by Failed-Final Sessions

The red indicator shows only the sessions that have failed and have no more retries remaining. You can restart these sessions.

by Successful Sessions The green indicator lists only sessions with a Successful status (those that initiated properly, executed all defined events, and ended within defined expectations).

by Completed Sessions

The gray indicator lists only sessions with a Completed status (those that initiated properly, ended within the defined time frame expectations, but did not execute all events).

by Missing Sessions The blue indicator filters the Client/Session list to display only the sessions that did not start within the expected time frame.

Table 52. Session Recovery menu commands (Continued)



Command menu A session is marked as Failed-Final if it attempted to complete but failed; this type of session also has no retries remaining. A Missing session is one that was never attempted during an expected time frame.

Use the following commands to restart Failed-Final sessions and resubmit Missing sessions. Problems with sessions may be the result of Clients not calling the RemoteWare Server at the scheduled time or of a system failure while sessions were in a blocked state waiting for a resource. Options include:

• Restart All. Attempts to restart all sessions displayed in the Client/Session list. When you select Restart All, a message box displays the number of sessions you are about to restart and asks you to confirm that you want to restart all sessions.

If one or more sessions fail after the restart attempt, see “Troubleshooting unsuccessful restarts” on page 328.

Click Yes to continue or No to cancel. If you clicked Yes, a message provides information about the number of successful and failed restarts. The Client/Session list updates to reflect the restarted sessions.

• Restart Session. Attempts to restart the session selected in the Client/Session list. When you select Restart Session, a message box displays the session(s) you are about to restart and asks you to confirm the action.

Remove All Filters Clears every current filter setting. When all filters are removed, no Clients or sessions appear in the Client/Session list box.

Read Filters Displays the Select Filter File dialog box; use this to apply a saved filter configuration file.

Write Filters Saves the current combination of filter settings to a file for later use.

Table 52. Session Recovery menu commands (Continued)


Note: The Restart All command is unavailable if any session with a status other than Failed-Final or Missing appears in the Client/Session list or if one or more sessions are highlighted in the list box. For information applying the necessary filters, see “Filter menu” on page 317.


Click Yes to restart the session(s) or No to cancel. If you selected Yes, a message provides information about whether the restart was successful or not. The Client/Session list updates to reflect the restarted session(s).

• Stop Query. Stops a query.

View menuUse the View menu commands to display details about an individual Client, search the Client/Session list, and specify the display font and refresh rate for the Session Recovery main window. Commands on this menu operate independently from the Filter menu commands; both may be active at the same time.

For a brief summary of each View command, see “Table 52. Session Recovery menu commands” on page 313. This section explains the actions and dialog boxes (when appropriate) for each View command:

• Details. Opens a detail window for the Client selected in the Client/Session list. For more information, see “Client Information window” on page 327.

• Search Client. Displays the Search Client dialog box. Use this dialog box to specify and quickly locate an individual Client in the Client/Session list. This command is especially useful when the Client/Session list box contains a large number of entries.

In the Enter Client to search field, enter the name of the Client you want to locate. The search is not case sensitive; for example, “SEATTLE” is the same as “seattle.” Click OK to begin the search. Session Recovery highlights the first entry that matches the search criteria you entered.

Tip: You can also advance to the next matching entry in the Client/Session list by pressing [F3].

• Find Next Client. Automatically advances to the next entry that matches the criteria you entered in the Search Client dialog box. You can use this command after you have searched the Client/Session list by selecting Search Client.

• Set Font. Displays a standard Windows Font dialog box, where you can select the font, font style, and font size for entries in the Client/Session list box. For instructions on using this dialog box, refer to your Windows documentation.

• Set Refresh Time. Opens the Set Refresh Time dialog box; use this box to change the time interval for automatic updates to the Session Recovery main window. When the Refresh Automatically option is enabled, the contents of the


Session Recovery window are updated every 20 seconds by default. However, you can use this command to specify a different rate (from 10 to 60 seconds). The 20 second default interval is restored whenever you exit and reopen Session Recovery.

• Refresh Automatically. When enabled, updates the Session Recovery window once during the time interval you set (by using the Set Refresh Time command). Select this option when you want to continually see the current sessions. Disable this option if you have a large amount of session activity or want to refresh the window manually.

Tip: Pressing [F5] also automatically refreshes session data.

• Refresh. Immediately updates the Session Recovery window with the current data in the Session Log. This command is not available if the log has not been updated with sessions that started or ended while Session Recovery has been running. You can use this command to update the window before the refresh time interval expires, or to manually refresh the window.

Filter menuUse the Filter menu to control which kinds of sessions appear in the Session Recovery window. You can display sessions that have something in common, or combine two or more filters to display a custom cross-section of session history. You can also store and reuse frequently used filter settings. Each time you start Session Recovery, you must apply at least one filter; the Client/Session list box remains empty until you do. In fact, Session Recovery is most effective when you apply one or more filters to isolate certain kinds of sessions.

You can combine filters as needed; each filter is cummulative of any filter already in use until you choose the Remove All Filters command.

For a brief description of each filter, see “Table 52. Session Recovery menu commands” on page 313. This section provides additional information, such as a description of the windows and options that appear when you select specific filters.

Note: Setting the refresh time does not enable the Refresh Automatically feature. You must manually select the Refresh Automatically command in order for automatic updates to occur.

Note: When you first start Session Recovery, the Refresh Automatically function is not selected. Data is not automatically updated until you select Refresh Automatically or manually refresh data.


Filter by Client

When you select Filter by Client, Session Recovery also applies the Failed-Final filter by default. You can remove the Failed-Final filter and apply any of the other status filters instead.

Use this filter to display the sessions associated with one or more Clients or groups. On the Filter menu, click by Client, or click by Client on the toolbar. The Select Clients and Client Groups window displays all defined Clients and Groups.

In the list box, select one or more Clients or groups. You can use the following controls to select, apply, or cancel your filter choice:

• [Shift] and [Ctrl]. In the list box, press [Shift] to select items that are next to each other, or press [Ctrl] and click items that are not adjacent. To cancel the selection of an item, click it again while pressing [Ctrl].

• View. Controls what items are visible in the list box. The default is Clients & Groups. Other views are: Client Groups, Clients, or Clients & Groups. Any selections you make in one view are not reset when you switch to another view, even though they may not be visible.

• Search/Select. Locates and selects a Client or group name based on the first few characters you type. Type the first few characters of a name and press [Enter] to select the first item beginning with those characters. To select multiple Clients or groups, use wildcards (such as the asterisk “*” and question mark “?”). For example, type A* to select all Clients and groups beginning with the letter A.

• Item Detail. Displays additional information for the selected Client.

• Remove Filter. Closes this window and stops filtering the Client/Session list by Client. Does not affect any other filter settings.

• OK. Accepts the selected items and closes the Select Clients and Client Groups window. Filters the Client/Session list to display only the sessions for the selected Clients and groups.

• Cancel. Discards any Client or group selection(s) and returns to the Session Recovery main window. Filter settings are unchanged.


Filter by Session

When you select Filter by Session, Session Recovery also applies the Failed-Final filter by default. You can remove the Failed-Final filter and apply any of the other status filters instead.

Use this filter to display information for specific sessions only. To apply this filter, select

by Session from the Filter menu, or click by Session on the toolbar. The Select Sessions window displays all sessions that are currently defined in your RemoteWare system.

Choose one or more sessions in the list box. You can use the following controls to select, apply, or cancel your filter choice:

• [Shift] and [Ctrl]. In the list box, press [Shift] to select items that are next to each other, or press [Ctrl] and click items that are not adjacent. To cancel the selection of an item, click it again while pressing [Ctrl].

• Search/Select. Type the first few characters of the session name and press [Enter] to select it. To select multiple sessions with common names, use wildcards (such as the asterisk “*” and question mark “?”). For example, type RWS* to select all sessions beginning with the letters RWS.

• Item Detail. Displays the assigned objects in this session, and can be used to display the object and event information.

• Remove Filter. Closes this window and stops filtering the Session Recovery main window by session. Does not affect any other filter settings.

• OK. Accepts the selected choices in the list box and applies them to the Client/Sessions list in the main window.

• Cancel. Discards any choices and returns to the Session Recovery main window. Filter settings are unchanged.

Note: The listed sessions correspond to those in the Session Editor program.


Filter by Time Range

When you apply this filter, the by Failed-Final filter is also applied by default. If necessary, you can remove the Failed-Final filter and apply any of the other status filters.

Use this filter to display information for sessions executed during a specified period of time. When you select by Time Range on the Filter menu, the Set Time Range dialog box appears. In this dialog box, select one of the following options:

• Before. Lists all sessions that executed before a specified date and time. The default is the current system date and time. To change the date and time, click the adjacent button. Use the controls provided to specify a new value.

• Between. Lists entries for sessions that executed between two dates and times. The default is the date and time of the least recent entry and the current system date and time.

To change the date(s) and time(s), click the button(s). Use the controls provided to specify a new date and/or time.

• After. Lists entries for sessions that executed after a specified date and time. The default is the date and time of the least recent entry.

To change the date and time, click the button. Use the controls provided to specify a new value.

• Last. Displays sessions starting from the present and ranging back in time for the specified number of days and hours. To change either value, click the button. Use the controls provided to specify a new number of days and/or hours.

• Remove Filter. Disables and clears settings from the Time Range filter. Other filters, if active, are not affected.


Filter by StatusFilters the Client/Session list by the Status code, and displays the results. The Status code indicates the reason the session failed. When you select by Status on the Filter menu, the Select Session Log Errors dialog box appears. Select the type of errors on which you want to filter the list.

The Client/Session list displays all sessions based on the reason(s) the session failed.

Filter by ECF

For information on working with ECFs, see Appendix C, “External Configuration Files” on page 573.

If you use ECFs (external configuration files) to schedule sessions to Clients and groups, you can use this filter to display only those entries associated with a selected ECF file. When you apply this filter, the Failed-Final filter is also applied by default. If necessary, you can remove the Failed-Final filter and apply any of the other status filters.

To apply the ECF filter, select by ECF on the Filter menu, or click by ECF on the toolbar. The Select ECF and Session window appears.

This window contains the following:

• Schedule ECF list. Displays the Schedule ECFs that are available in your system. Select the Schedule ECF for which you want to display information.


• Sessions list. Displays the sessions contained in the selected Schedule ECF. Select one or more of the sessions; press [Shift] or [Ctrl] to make multiple selections.

• OK. Accepts your choices and closes the Select ECF and Session window. Filters the Client/Session list to display the selected entries.

• Cancel. Closes the Select ECF and Session window and returns to the Session Recovery main window.

Filter by All

• Filters the Client/Session list so all the sessions based on the completion field display. When you select by All on the Filter menu, the Client/Session list displays all sessions with a Successful, Complete, Failed, and Failed-Final status.

Filter by session statusOn the Filter menu, use these commands to display entries only for those sessions with the selected status:

• by Failed Sessions. Lists the sessions that failed but still have retries remaining. It is not possible to restart a Failed session because there are still retries pending.

• by Failed-Final Sessions. Displays sessions for which all attempts to complete have failed. Failed sessions with retries remaining are not displayed for this filter. To run a Failed-Final session again, select Command Restart Session.

• by Successful Sessions. Displays only sessions with a Successful status. Successful sessions process each event without any failures.

• by Completed Sessions. Displays sessions with a Completed status. Completed sessions process all of their events, but individual events may have failed or may have been skipped because of conditional statements.

Note: Sessions that are identical and have identical entries, but that occurred at different times, may be consolidated into a single entry. As a result, there may not be a one-to-one correlation with the information listed in the Session History Log.


Tip: To improve system performance while displaying Missing sessions, apply another filter, such as by Time or by Client first, then apply the by Missing filter.

• by Missing. Displays only the sessions that did not start within the expected time frame. To run a Missing session again, select Command Restart Session.

Managing filtersUse the following Filter menu commands to deactivate all current filter settings, save filter settings to a file, or apply filter settings stored in a file.

• Remove All Filters. Immediately removes every filter applied to the Client/Session list box. To remove applied filters, click Remove All Filters on the toolbar or select the corresponding command on the Filter menu.

When you remove all filters, the Client/Session list box is empty and “OFF” appears to the right of the Filter menu on the menu bar.

• Read Filters. Displays the Select Filter File dialog box, where you can select an existing filter file and apply it to the Client/Session list. Session Recovery adds the settings in the filter file to any existing filter settings.

Note: The by Missing filter will not locate missing sessions that have run previously and for which a record still exists in the Session Log. To located these missing sessions, you must use the by Missing filter in combination with the by Time Range filter. For example, if the Polling session ran on September 1 and September 2 but did not run as scheduled on September 3, the Missing filter used alone will not identify Polling as a missing session, because it will find a record of it in Session Log. However, if you use the by Time Range filter to locate all sessions run after September 2 and then apply the by Missing filter, Session Recovery will locate the missing Polling session.


• Write Filters. Displays the Write Filter File dialog box, where you can save the current filter settings to a file for later use.

By default, filters are saved to the \Sysfiles\Filters directory. You can accept this default location or enter a new location.

S e s s i o n R e c o v e r y m a i n w i n d o w 325

Session Recovery main window When you first open the Session Recovery window, the Client/Session list is empty. You must select at least one filter to populate the list box.

In RemoteWare Menu, start Session Recovery by double-clicking its icon (located in the All Utilities and Server Operations groups). The main window appears. Use this window to filter session entries, customize the display, access detailed information about selected entries, and restart sessions.

The main window is composed of a menu bar, toolbar, totals bar, the Client/Session list, and the status bar. (For a description of the menu bar and toolbar contents, see “Menu commands” on page 313.)

• Totals bar. Shows the total number of sessions currently displayed in the Client/Session list box as well as the number of sessions in each status category: Failed, Failed-Final, Completed, Successful, and Missing. All totals are based upon the filters currently applied. As you select new filters or remove filters, the totals change to reflect your selection.

• Session status indicator. Graphically indicates the completion status of a session. You can use the indicators to quickly determine the status of each session. The

Toolbar

Client/Session list

Totals bar

Menu bar

Status bar

Status indicators


status indicators correspond to those in Session Log. The following table describes each indicator.

Tip: To resize the columns in the Client/Session list box, place your cursor over the column separator bar and slide it left or right.

• Client/Session list box. Displays Clients and sessions based on the filters you select. When you first start Session Recovery, this list box is empty; you must select at least one filter to populate it. You can display up to 32,000 entries in this box, depending upon the maximum number of entries specified in the Session Log. Session Recovery uses the data in the Session Log to populate the Client/Session list.

The Client/Session list contains the following columns of information:

• Client Name. Lists the name of the Client assigned to the session.

• Session Name. Displays the name of the session, which originates in Session Editor. If you change the session name in Session Editor, then the change occurs throughout the Session Log, and subsequently, Session Recovery.

Table 53. Session Recovery status indicators

Indicator Name Description

Failed The yellow indicator appears beside sessions flagged as Failed in the Session Log. Failed sessions are those that attempted to connect to the Client but did not; they also have retries remaining.

Failed-Final The red indicator appears beside sessions marked as Failed-Final in the Session Log. Failed-Final sessions were attempted but failed to connect during the specified time frame; all retries have been exhausted.

Completed The gray symbol indicates sessions that started and ended within the expected time frame but did not execute all of their events.

Successful Sessions that started and ended within the expected time frame and executed all events have a green indicator.

Missing The blue indicator marks sessions that are missing from the Session Log. Missing sessions are those that were scheduled but did not start during the expected time frame. This may be due to the Client not initiating an inbound session when expected.

S e s s i o n R e c o v e r y m a i n w i n d o w 327

Client Information window Tip: You can also display this window by right-clicking a Client in the Client/Session list and selecting Details on the shortcut menu.

You can view detailed information about any Client listed in the main window. To view Client details, select a Client in the Client/Session list box. On the View menu, click Details. The Client Information window appears.

The information in this window is from the Client Profile program. Information includes:

• Client Name. Displays the name you specified when you first created the Client.

• Description. Provides a brief description of the Client or Client group, which originates on the General page in Client Profile.

• Client Type. Indicates the Client’s operating environment.

• Status. Indicates whether the Client is available for communication (Enabled) or not available for communication (Disabled). Status is not applicable to Client groups, which display “N/A” in this field.

• Time Zone. Displays the Universal Time Coordinate (UTC) for the selected Client.

• Install Path. Designates the drive letter that contains the Client software. All system ESD occurs to this drive and path; if ESD files are not transferred and you are certain that this path is available and exists on the Client, then verify that the Client user has not moved the Client software to another drive. The Server also uses this drive for file transfers when the event contains no drive letter in the path name.


• Primary Resource. Displays the communication protocol that the Client uses to contact the Server. Choices are ASYNC, TCP/IP, and NetBIOS

Once you have viewed the information, click OK to return to the main window.

Troubleshooting unsuccessful restarts Use the Command menu options to restart sessions. For details, see “Command menu” on page 315.

When you restart a session, a message box notifies you of the number of successful and unsuccessful restarts. There are several reasons why sessions may not restart properly:

• The system cannot create or write to the Session Log record file.

• The system cannot open the worklist file (*.wrk).

• The system cannot retrieve the Client information or the session information for the specific Client.

• The scheduler cannot launch a session.

• The session’s status is no longer “Failed-Final” or “Missing.” A session’s status may change if another Server successfully resubmitted the session since the last time you refreshed the session data in Session Recovery.

Note: The remaining fields in the Client Information window vary depending on the selected Client’s primary resource. For more information about these items, see Chapter 5, “Client Profile” on page 123.

C H A P T E R

13

Report Manager

Use the Report Manager program to view information about the RemoteWare Server’s

configuration and history. In addition, you can generate, view, and print reports, which

are text files that can be imported into other programs.


• “Report Manager at a glance” on page 330


• “Report filters” on page 338

• “Generating reports in CSV file format” on page 339

• “Report Manager main window” on page 342

• “Reports in Report Manager” on page 343

• “Session Log error types” on page 376


Report Manager at a glanceUse Report Manager to create and use reports for the many different aspects of your RemoteWare Server system. Reports are text files that you can print or import into other programs. You can also generate reports from a session or command line.

The Report Manager program consists of one main window and a window for each displayed report file. For more information, see “Report Manager main window” on page 342.

The following table lists the reports available in Report Manager.

Note: This is not an exhaustive list of reports. Additional reports for other RemoteWare products (as well as report definitions custom to your site) may also appear in the main window.

Table 54. Reports available in Report Manager

Report Name Description Details on page

Administration Lists each RemoteWare Administrator name and assigned applications.

343

Client Communications Summarizes the number of sent and received packets, bytes, and files for each Client in the RemoteWare system.

343

Client Detail Lists Client settings by each property page in the Client Profile program.

345

Client Groups For each Client group, summarizes the number of member, object, and session assignments. Then lists its assigned members, objects, and sessions.

348

Clients Displays description, drive path, and connectivity information by Client.

350

File Transfer Log Lists files, Client, and transfer status sorted by date and time.

351

Long Distance Service Usage

For each long distance class, totals the usage time and the number of failed and successful sessions.

352

Long Distance Services Lists long distance classes, their status, and their values. The list is followed by each dial script and its commands.

353

Messaging Listing Displays message transactions by original user and Client, priority, time, size, and status.

354

Modems Lists the settings for each modem on the Server Profile Modem Types page.

354

R e p o r t M a n a g e r a t a g l a n c e 331

Network Group This report indicates the Resource Name, Resource Status, number of available ports and Resource Group Name.

356

Port Communications For each port or network resource, totals the number of packets and bytes sent and received. Also lists the total connect time for each resource.

356

Ports Details all resources and settings on the Server Profile Resources page, including status, usage, modem, data rates, and Server phone numbers. Then lists which long distance services are assigned to which port numbers.

357

Portable Security Users Displays Portable Security user names, computer names and encrypted passwords.

358

Protocols Displays the packet and window size, rexmit and session timeout values, and compression status for each item on the Server Profile Protocol page.

359

Server Log Copies the contents of the Server Log to this report file.

360

Session Event Log For each session, displays overall statistics, followed by the individual events and their status. This information is equivalent to the most detailed setting in the Session Log detail window.

361

Session Log Lists session name, Client, status, start time, duration, Server, and resource. The report gives the same information as the Session Log main window.

364

Session Recovery Lists all sessions for each Client organized by session status. Includes additional information about each session’s start date and time, duration, status, and resource port number.

365

Sessions For each session, lists scheduling information and the directly assigned objects and Clients.

366

System Displays Server settings from the following pages in Server Profile: Information, Cluster, Settings, Resources, Alarms, Logging, and Licensing.

369

User Group Listing For each user group, lists the description, distribution list status, and members (RemoteWare users).

371

Table 54. Reports available in Report Manager (Continued)



Report execution fundamentalsYou can generate reports from the standard report definition (the report settings that come with RemoteWare), a custom report definition, a RemoteWare event, or a RemoteWare Server’s command line. Each of these methods depends on a set of executable files in the \system directory on the Server’s executable drive. The following table lists the executable files for each predefined report included in Report Manager.

User Listing For each user, gives the full name, address, address type, Client name, and whether this user is set up for directory synchronization.

372

Work Objects For each work object, displays settings from each property page, displays the worklist events (if any), and lists Client and session assignments.

373

Table 55. Report execution files

Executable File Report

Rpt_adm.exe Administrator

Rpt_nsts.exe Client Communications

Rpt_ndet.exe Client Detail

Rpt_ngrp.exe Client Groups

Rpt_node.exe Clients

Rpt_flog.exe File Transfer Log

Rpt_ldcu.exe Long Distance Service Usage

Rpt_ldc.exe Long Distance Services

Rpt_mta.exe Messaging Listing

Rpt_mdm.exe Modems

Rpt_psec.exe Portable Security Users

Rpt_psts.exe Port Communications

Rpt_port.exe Ports

Rpt_ptcl.exe Protocols

Rpt_msg.exe Server Log

Rpt_evnt.exe Session Event Log

Table 54. Reports available in Report Manager (Continued)


R e p o r t M a n a g e r a t a g l a n c e 333

For a discussion of the available methods for report generation, see “Generating reports” on page 333.

Generating reports

All generated reports are stored in the \Sysfiles\Reports directory unless you specify a full path.

This section discusses the report generation methods and lists the advantages of using each. There are four basic ways to generate a report:

• Using a standard report definition. The Report Manager program provides a set of predefined report definitions. Double-clicking a report definition automatically executes the correct report execution file. For some large or specialized reports, the user interface provides a set of filters to narrow your focus or format the output for other applications. Standard reports are useful when you occasionally need to generate a report.

• Using a custom report definition. You can create custom report definitions by selecting Add Report Definition from the Command menu. Properly defined, a custom report definition behaves like a standard report, but it can have a different Report Name, output the report to a different file or location, or automatically use predefined filters. Use a custom report when you want to generate a report from the Report Manager user interface using another output file, a predefined set of filters, or an easily identified Report Name.

• Using events. An EXECUTE event on the Server can run the appropriate report execution file. Depending on the event, work object, and session characteristics, this event can be made to execute under many circumstances. See the RemoteWare Server Administrator’s Guide for different examples. Use events when you want to repeatedly generate a report on a scheduled basis, or to create reports triggered by a system occurrence (such as a Client calling the Server). You can also use events to run the same report parameters as a background process. For an example of report

Rpt_hist.exe Session Log

Rpt_rscg.exe Network Group

Rpt_srec.exe Session Recovery

Rpt_sess.exe Sessions

Rpt_sys.exe System

Rpt_ugrp.exe User Group Listing

Rpt_user.exe User Listing

Rpt_swo.exe Work Objects

Table 55. Report execution files (Continued)

Executable File Report


generation events, see the Reports Execution work object in the Work Object Editor program.

• From the command line. Use this method when you can only access the Server from a command line interface. To generate a report, type its executable file name and any additional options on a command line. Additional options, such as filter or output file settings, are included with the command and can be used from a batch file when character based systems cannot execute the application directly.

For a list of executable file names, see “Report execution files” on page 332.

Use the /? switch after any Report Manager executable file name to view the command line format, filters, and options for that report. For example, type rpt_ngrp /? to view the additional options for the Client Groups report. A message box displays the usage and any options for this command.



Use the Report Manager menu commands to create, manage, view, print, and delete both standard and custom reports. The following table summarizes the Report Manager menu commands; sections later in this chapter describe the commands in detail.

Note: This table does not list the commands common to most RemoteWare programs; for an overview of general commands, see “Menu commands common to most programs” on page 25.

Table 56. Report Manager menu commands


Commands available in the main window:

File *Copy Report Duplicates the selected report and saves the copy in another file.

*Delete Report Removes the selected report.

*Generate Report Creates and displays an updated report file.

*View Report Displays the existing report file. Generates the file if it does not exist for the selected report.

*Print Report Sends the report file to the default printer.

Command Add Report Definition

Creates a new report based on custom settings.

Change Report Definition

Modifies settings for an existing report.

Delete Report Definition

Removes an existing report definition from the main window.

Set Page Size Specifies the number of lines per page.

Commands available from the report listing:

File Print Report Sends the report text to the default printer.

Edit Copy Places the selected text on the Clipboard.

Search for Locates a text string in the report.

Select All Selects all text in the report.

View Background Colors Changes the color of the screen.

Fonts\Foreground Colors

Changes the color of the text.


File menuUse the File menu commands to work with reports or their files. For a brief summary of these commands, see “Table 56. Report Manager menu commands” on page 335. This section provides additional information about each command.

• Copy Report. Duplicates the contents of the selected report. Use this command to make another copy, or to create a backup copy of the report before regenerating it. When you select this command, the Copy Report File dialog box displays the file names and paths of the source and destination reports. In the Destination File field, specify the full path and name of the new report file. The Server’s data drive is used if no drive letter or volume name is given. (This command is not available if the report file does not exist.)

• Delete Report. Erases the selected report file. After you select this command, you cannot retrieve the original file information from the RemoteWare user interface; the Server clears the size and last generation columns. (This command is not available if the report file does not exist.)

• Generate Report. Creates a report file for the selected report definition using information currently on the Server. Depending on the report definition, you can use filters to narrow the scope of the report. See the individual report descriptions later in this chapter for more information.

• View Report. Opens a window containing the report. (This command is not available if the report file does not exist.)

• Print Report. Sends a copy of the selected report to the default printer. To control the amount of lines to print per page, click Set Page Size on the Command menu. (This command is not available if the report file does not exist.)

Note: The File menu commands are also available on a shortcut menu. To view the shortcut menu, right-click the report.


Command menuUse the Command menu to create and manage new report definitions or to set the number of lines per page. A report definition is based on a standard report with custom settings that you define for specific requirements. For a brief summary of these commands, see “Table 56. Report Manager menu commands” on page 335. This section provides additional details about each command.

• Add Report Definition. Displays the Report Definition dialog box, where you can define specialized reports to use from the Report Manager user interface. (For a list of the fields in this dialog box, see “Change Report Definition.”) The report you define appears in alphabetical order in the Report Manager main window.

• Change Report Definition. Displays the Report Definition dialog box, where you can modify some aspect or option of an existing standard or custom report definition. Fields are:

• Report Name. Displays the current name for the report. Change the name to better describe this report’s function, or to change its alphabetic order in the list. To place it at the top, add a space before the report name.

• Output File. Displays the destination path and name for the report file. The Server data drive is used if no explicit path is specified.

For a list of executable file names in Report Manager, see “Report execution files” on page 332.

• Program Name. Lists the executable file name that generates the output file.

• Additional Options. Flags and other valid options for the program. For a list of valid command line options, see the individual reports later in this chapter.

• Delete Report Definition. Removes the report entry from the main window. Existing reports, settings, and report name are permanently removed from Report Manager. Do not use this command to delete the report; instead, select Delete Report from the File menu.

• Set Page Size. Displays the Set Page Size For Printing dialog box, where you specify the number of lines to print before inserting a page break. The default setting is 66 lines per page; select from 20 to 9999 lines. The page size does not affect the headers in the report files. The default setting is based on 8.5 x 11 inch paper size in portrait orientation, with a 10 pt. font size. Different printers, font characteristics, spacing, and page sizes may require a different page size setting.


Report filtersSome reports provide a filter dialog box when you generate them, or they accept a filter file from the command line or event. Use these filters to generate a report containing only the information you need.

You cannot enter individual filters on the command line. Instead, type -f FilterFile to read a filter file containing file options. The following table lists the filters available for reports. See the appropriate sections later in this chapter for detailed descriptions of the filters and options available for each report.

Table 57. Reports and available filters

Report Available filters

Client Communications by Client, by Enabled, by Disabled

Client Detail by Client, by Enabled, by Disabled, General Info, Client Info, Server Info, Assignments Info, Comments

Client Groups by Client Group

Clients by Client, by Enabled, by Disabled

File Transfer Log by Command, by File, by Client, by Server*, by Transfer Status, by Time Range

Long Distance Service Usage by Client, by Session, by Time Range

Network Group TCP/IP, SPX, NetBIOS, Inbound, Outbound, In/Out

Port Communications by Enabled, by Disabled

Server Log by Servera, by Time Range, Debug Messages, Error Messages, Fatal Error Messages, Info Messages, User Messages

a. This filter is available only for clustered Servers.

Session Event Log by Error Type, by Client, by Resource, by Server*, by Session, by Time Range, Failed Sessions, Failed-Final Sessions, Successful Sessions, Completed Sessions

Session Log by Error Type, by Client, by Resource, by Server*, by Session, by Time Range, Failed Sessions, Failed-Final Sessions, Successful Sessions, Completed Sessions

Session Recovery by Client, by Session, by Time Range, Failed Sessions, Failed-Final Sessions, Successful Sessions, Completed Sessions, Missing Sessions

Sessions by Session

Work Objects by Work Object, by Owner, by Enabled, by Disabled, ESD Objects, Work List Objects, Application Objects, Application Group Objects, Group Objects

G e n e r a t i n g r e p o r t s i n C S V f i l e f o r m a t 339

Generating reports in CSV file format A standard CSV file separates each report entry by a comma; it eliminates report descriptions, headings, and any additional formatting.

You can generate many reports in CSV (Comma Separated Value) file format. Ten reports create a standard CSV file, separating each report entry by a comma and eliminating report descriptions, headings, and any additional formatting. The other eight reports not only separate each entry by a comma, but also include a set of identification tags that are used to indicate the information on the line. These tags appear as the first field on each line in the CSV file. Once you generate a CSV file, you can import it into spreadsheet applications for further analysis and manipulation.

The following table lists the reports that you can generate in CSV file format and indicates whether each report is standard or enhanced (i.e., includes identification tags).

Table 58. Reports that include the CSV file option

Report Name Type of CSV file generated* Details on page

Client Communications Standard 343

Client Detail Enhanced 345

Client Groups Enhanced 348

Clients Standard 350

File Transfer Log Standard 351

Long Distance Service Usage Standard 352

Messaging Listing Standard 354

Network Group Enhanced 355

Port Communications Standard 356

Ports Enhanced 357

Portable Security Users Standard 358

Protocols Standard 359

Server Log Standard 360

Session Event Log Enhanced 361

Session Log Standard 364

Session Recovery Standard 365

Sessions Enhanced 366

System Enhanced 369

User Group Listing Enhanced 371

Work Objects Enhanced 373


Viewing enhanced CSV file reports For a list of reports you can generate in the enhanced CSV file format, see “Reports that include the CSV file option” on page 339.

Each enhanced CSV file includes a report description, report tags and their respective descriptions, as well as the fields associated with each tag. (For information about the tags for the eight enhanced reports, refer to each report’s details later in this chapter.) In the following illustration, the Client Detail CSV file includes tags, which are positioned as the first entry on each line. The second entry of the tag CLI_NAME indicates the beginning of a new record.

* Enhanced reports include additional tags at the beginning of each report line that identify the information on that particular line.

Table 58. Reports that include the CSV file option (Continued)

Report Name Type of CSV file generated* Details on page

CLI_NAME marks the beginning of the first Client record

The second CLI_NAME tag indicates the beginning of a new Client record

G e n e r a t i n g r e p o r t s i n C S V f i l e f o r m a t 341

Compare the previous picture with the next illustration, which shows the same report generated in the “normal” Report Manager format.

As you generate enhanced CSV files, you may find that a report does not display all of the tags associated with it. In this case, the tag may represent data that is not defined in your system. Using the Client Detail report as an example, assume that a Client defined in Client Profile has no Alternate Server Resource. The tag “CLI_ASRV” will not appear in the report because it is specific to alternate servers. Similarly, if no users are assigned to a Client, the “CLI_USER” tag line won’t appear.


Report Manager main window

To display the main window, double-click the Report Manager icon in RemoteWare Menu. The main window lists the available reports.

Each line displays a report definition and its associated information, as follows:

• Report Name. Lists the name of the report (in alphabetical order). This column also includes report names for custom report definitions. For a list of standard report definitions, see “Table 54. Reports available in Report Manager” on page 330.

• Output File. Displays the file that contains the report contents. By default, the \Sysfiles\Reports directory holds these files. Custom report definitions can use any output path and file name.

• Size. Indicates the number of bytes occupied by this report. This column is blank if the report has been deleted or if it has never been generated.

• Last Generation. Displays the date and time of the most recent update to this report.

Note: Double-clicking the report does not generate a new report if one already exists. To create a new copy of the report, click Generate Report on the File menu.

R e p o r t s i n R e p o r t M a n a g e r 343

Reports in Report ManagerThe following sections provide detailed information about each of the standard report definitions. For a brief summary of these reports, see “Table 54. Reports available in Report Manager” on page 330. For an overview of report generation methods, see “Report execution fundamentals” on page 332.

Administration reportThe Administration report lists user accounts with access to the RemoteWare Server system. Applications the user can access appear for each RemoteWare Server user.

Use this report to survey which user can access which portions of the RemoteWare system. There are no filter options for the Administration report.

Administration command line

See the RemoteWare Server Administrator’s Guide for more information on the command line form of this report.

Rpt_adm.exe -o OutputFile -h

Client Communications reportThe Client Communications report lists packet, byte, and file totals by Client. Use this report to quickly assess which Clients are active, which may be experiencing communication problems, and to gauge the overall flow of information between Server and Clients.

-o OutputFile Generates a report file with the name OutputFile. Omitting this option generates the output file Rpt_adm.lst.

-h Prevents the Cancel dialog box from appearing as the report is generated. Suppressing this dialog box prevents any user interference when the command is automatically executed from a session.

-f FilterFile Reads and applies a filter file when generating the report.


When you generate this report, the Client Communications Report dialog box appears. You can select one or more of these filters and options:

• by Client. Use this filter to select one or more Clients or Client groups to include in the report. Client groups selected will display totals for the member Clients and not for the group as a whole.

• by Enabled. Includes enabled Clients in the report.

• by Disabled. Includes Clients with a Disabled status.

• Reset Stats After Report. Returns the total counters to zero after the report is completed.

For details about CSV files, see “Generating reports in CSV file format” on page 339.

• Generate CSV File. Select this check box to create a standard Comma Separated Value file for spreadsheets and databases. A CSV file omits the descriptive headings, contains no spacing between columns, and separates each value with a comma.

Client Communications command line


Rpt_nsts.exe -o OutputFile -csv -f FilterFile -h -q -r

-csv (or -c) Formats the report in Comma Separated Value (CSV) form. Each entry in the report is separated by a comma with no additional formatting. CSV files are easy to import into spreadsheet applications for further analysis.

-f FilterFile Reads and applies a filter file to this report generation.

-h Prevents the Cancel dialog box from appearing as the report is generated. Suppressing this dialog box prevents any user interference when the command is executed automatically from a session.

-o OutputFile Generates a report file with the name OutputFile. Omitting this option generates the output file Rpt_nsts.lst.

-q Displays the filter dialog box, allowing you to choose the filters from the user interface.

-r Resets communications statistics after generating the report.


Client Detail reportThe Client Detail report displays every Client setting specified in Client Profile. It lists settings by property page, including: General, Client Settings, Server Settings, Assigned Worklist Objects, Assigned Group Objects, Assigned Sessions, and Assigned Groups.

When you generate this report, the Client Detail Report dialog box appears. You can select one or more of these filters and options:

• by Client. Generates a report for one or more selected Clients or Client groups. Client groups are broken down into their member Clients. Use the Client Group report for group information.

• by Enabled. Includes Clients with an Enabled status.

• by Disabled. Includes Clients with a Disabled status in the report.

• General Info. Lists the settings from the Client Profile General page. This includes description, password, Client type, install drive and path, time zone, date defined, and status.

• Client Info. Includes settings from the Client Profile Client page. Includes all Client configurations, protocols, modem types and ports, data rate, inbound schedule, and retries.

• Server Info. Lists all settings from the Client Profile Server page. Includes the Primary and Alternate resource, LD class, and Client configuration.

• Assignments Info. Lists assignments for all ESD, worklist, group, application, and application group work objects. The report then lists assigned sessions and assigned Client groups.

• Comments. Displays the contact information and any comments on the Comments property page in Client Profile.


• Generate CSV File. Select this check box to create an enhanced Comma Separated Value file for spreadsheets and databases. A CSV file contains no spacing between columns and separates each value with a comma. Enhanced CSV files also include descriptive tags at the beginning of each line of data.


Client Detail command line


Rpt_ndet.exe -o OutputFile -csv -h -f FilterFile

Client Detail CSV file formatThis report lists Client settings by each property page in Client Profile. Tags associated with this report are:

CLI_NAME Name of ClientCLI_DET1 General information about a ClientCLI_DET2 Additional general information about a ClientCLI_DET3 Final line of general information about a ClientCLI_ASRV List of Alternate ServersCLI_WKLO Worklist Object assigned to a ClientCLI_GRPS Client Groups to which a Client is assignedCLI_SESS Sessions to which a Client is assignedCLI_USER Users assigned to a ClientCLI_CMT1 Comments about a ClientCLI_CMT2 Text comments

The tags and their associated report fields are:

CLI_NAME Client Name

CLI_DET1 DescriptionPassword

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or an output file name generates the output file Rpt_ndet.lst.


-csv (or -c) Formats the report in enhanced Comma Separated Value (CSV) form. Each entry in the report is separated by a comma; each line of report data begins with a tag that indicates the type of information it provides. CSV files are easy to import into spreadsheet applications for further analysis.


Note: This report always includes the CLI_NAME tag at the beginning of each Client record.


Client TypeInstall DriveInstall PathTime Zone OffsetRouter ClientClient Definition DateClient EnabledFile Attribute EnableDisk SizeDisk FreeMemoryMemory Free

CLI_DET2 Client ConfigurationProtocolModem TypeModem PortData RatePrimary Server NumberSecondary Server NumberInbound ScheduleSchedule TimeRetries

CLI_DET3 Primary ResourcePrimary Long DistancePrimary Client Phone NumberPrimary ConfigurationAlternate ResourceAlternate Long Distance NumberAlternate Phone NumberAlternate Configuration

CLI_ASRV Alternate Server 1Alternate Server 2Alternate Server 3Alternate Server 4Alternate Server 5Alternate Server 6

CLI_WKLO Assigned TypeWork Object Name

CLI_GRPS Assigned TypeClient Group Name

CLI_SESS Assigned Type


Session NameInbound ? (If yes, Inbound displays. If no, nothing appears.)

CLI_USER User Name

CLI_CMT1 Contact 1: NameContact 1: PhoneContact 1: AddressContact 1: Address 2Contact 1: City, StateContact 1: ZipContact 2: NameContact 2: PhoneContact 2: AddressContact 2: Address 2Contact 2: City, StateContact 2: Zip

CLI_CMT2 text comments

Client Groups reportClients with similar administrative requirements are often collected into Client groups to make assignments easier. This report contains the total sums and lists the members (Clients and groups), objects, and session assignments for each Client group.

To review general information about CSV files, see “Generating reports in CSV file format” on page 339. For details about the tags in this report, see “Client Groups CSV file format” on page 349.

When you generate this report, the Client Groups Report dialog box appears. You can select one or more of these filters and options:

• by Client Group. Use this filter to view information about one or more Client groups. The member names in brackets “[]” are Client groups.

• Generate CSV File. Select this check box to create an enhanced Comma Separated Value file for spreadsheets and databases. A CSV file contains no spacing between columns and separates each value with a comma. Enhanced CSV files also include descriptive tags at the beginning of each line of data.


Client Groups report command line


Rpt_ngrp.exe -o OutputFile -csv -h -f FilterFile

Client Groups CSV file formatFor each Client Group, this report sums up the number of member, object, and session assignments, and then lists the assigned members, objects, and sessions. Tags associated with this report are:

GRP_DET General information about a Client GroupGRP_MEM Member of a Client GroupGRP_OBJ Object assigned to a Client GroupGRP_SES Session to which a Client Group is assigned

This report always includes the GRP_DET tag, which marks the beginning of a new Client Group record. The tags and their associated report fields are:

GRP_DET NameDescriptionMembersObjectsSessions

GRP_MEM Assigned TypeMember Name

GRP_OBJ Assigned TypeWork Object Name

GRP_SES Session Name

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or an output file name generates the output file Rpt_ngrp.lst.





Clients reportThe Clients report provides information that is useful for determining Client connectivity parameters and Client file destinations. The Client Name, Description, Status, Primary Telephone, Primary LD Service, Time Offset, Installation Drive, Installation Path, Data Rate, and Modem Type appear in columnar form, sorted by Client name.

When you generate this report, the Clients Report dialog box provides these options:

• by Client. Choose one or more Clients or Client groups from the defined Clients in Client Profile. Select a Client group to display information for the Clients that are members of the group.

• by Enabled. Includes all Clients with an Enabled status in the report.

• by Disabled. Includes all Clients with a Disabled status in the report.

• Generate CSV File. Formats the report file for spreadsheet and database applications. The standard Comma Separated Value file does not contain the descriptions or headings and separates each column with a comma.

Clients command line


Rpt_node.exe -o OutputFile -csv -h -f FilterFile

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or an output file name generates the output file Rpt_node.lst.

-csv (or -c) Formats the report in standard Comma Separated Value (CSV) form. Each entry in the report is separated by a comma with no additional formatting. CSV files are easy to import into spreadsheet applications for further analysis.




File Transfer Log reportAny file transferred between the Server and Client is logged to the File Transfer Log. Use this report to view transfer records or to determine if a file was properly received.

When you generate this report, the File Transfer Log Report dialog box provides the following filters and options:

• by Command. Displays only those file transfers that occurred using the GET, SEND, or CHECK SEND event. Choose one or more events to activate this filter.

• by File. Enter the characters corresponding to the file name, using wildcards if necessary. The report displays transfers matching the name or wildcard you choose.

• by Client. Select one or more Clients or Client groups. The report lists those transfers involving the selected Clients.

• by Server. Select one or more Servers to see the transfers that occurred on them.

• by Transfer Status. Lists file transfer entries that match the Failed, No Execute, or Successful status.

• by Time Range. Displays all file transfers during a specific time span.

• Include Detail. Displays file transfer details. The information originally appears in the File Transfer Log program in the File Transfer Detail window.


• Generate CSV File. Formats this file using commas between the items. The standard Comma Separated Value format is used to import the data into spreadsheets or databases.

File Transfer Log report command line


Rpt_flog.exe -o OutputFile -csv -h -f FilterFile -d

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or an output file name generates the output file Rpt_flog.lst.


Long Distance Service Usage reportOne or more Long Distance Classes process every asynchronous connection on the RemoteWare Server. Use the Long Distance Service Usage report to determine which class gets the most use, if some classes experience more failed sessions, and to monitor the total connect time per Long Distance Class.

When you generate this report, the Long Distance Service Usage dialog box provides the following filters and options:

• by Client. Choose one or more Clients or Client groups to include when totaling the usage categories and long distance classes. Client groups total the usage for all Clients in the group.

• by Session. Select one or more sessions to include when totaling the usage categories for each long distance class.

• by Time Range. Totals all the asynchronous usage during a specified time span.


• Generate CSV File. Formats this report for spreadsheet or database applications. Creates a standard Comma Separated Value file with no descriptions or page headings, and separates each report field with a comma.

-csv (or -c) Formats the report in standard Comma Separated Value (CSV) format. Each entry in the report is separated by a comma with no additional formatting. CSV files are easy to import into spreadsheet applications for further analysis.



-d Produces an output file that includes the greatest level of detail about the current File Transfer Log entries.


Long Distance Service Usage command line


Rpt_ldcu.exe -o OutputFile -csv -h

Long Distance Services reportThe Long Distance Services report lists each Long Distance Service and Dial Script. The first part of the report includes the Long Distance Service, its status, and the dial string or dial script. The second part lists each Dial Script and its commands.

There are no filter options for this report.

Long Distance Services command line


Rpt_ldc.exe -o OutputFile -h

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_ldcu.lst.

-csv (or -c) Formats the report in standard Comma Separated Value (CSV) format. Each entry in the report is separated by a comma with no additional formatting. CSV files are easy to import into spreadsheet applications for further analysis.



-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_ldc.lst.




Messaging Listing reportIn the Messaging Log view (Log Viewer), an entry exists for every message received and processed by the Message Transfer Agent (MTA). Use the Messaging Listing report to view these entries. For each message, the originating user and Client appear, as well as the message’s priority, size in bytes, time received, and status.

There are no filter options for the Messaging Listing report.

Messaging Listing command line


Rpt_mta.exe -o OutputFile -h

Modems reportEach modem defined in the Server Profile Modems page is listed in this report. The report is alphabetized by modem type and lists all settings and result codes defined on the Modems property page. There are no filter options for the Modems report.

Modems command line


Rpt_mdm.exe -o OutputFile -h

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_mta.lst.



-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_mdm.lst.




Network Group reportThe Network Group report indicates; Server, Server Address; Resource Name, Resource Status, Group (Group name), Port Count, Priority, Usage, Network Group and number of available resources. The resources NetBIOS, and TCP/IP, and SPX are included on this report. When you generate this report, the Network Resource Group Report dialog box provides the following filters:

• TCP/IP. Filters information according to TCP/IP resource.

• SPX. Filters information according to the SPX resource.

• Netbios. Filters information according to NetBIOS resource.

• Inbound. Filters information for inbound connections.

• Outbound. Filters information by outbound connections.

• In/Out. Filters information for connections that are defined as In/Out or both.

• Include Client. Includes Client information in the report.

• Generate CSV File. Formats this file using commas between the items. The standard Comma Separated Value format is used to import the data into spreadsheet or databases.

Network group command line

Rpt_rscg.exe

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_rscg.lst.




Port Communications reportThe Port Communications report lists the cumulative packet, byte, and time values for every asynchronous and network resource in the RemoteWare system. The report is broken down into sections for each Server in your cluster. Within each section, a columnar report lists the resource or port number, total packets sent, packets received, packets retransmitted, packets rejected, bytes sent and received, and connect time (in seconds).

When you generate this report, the Port Communications Report dialog box provides the following filters and options:

• by Enabled. Includes the ports that are enabled. This information originates from the Status column on the Server Profile Resources page. For details, see “Resources property page” on page 81.

• by Disabled. Includes any disabled ports in the report. This information originates from the Status column on the Server Profile Resources page. For details, see “Resources property page” on page 81.

• Reset Stats After Report. Returns the total counters to zero after the report is completed.

• Generate CSV File. Formats this report for spreadsheet or database applications. Creates a standard Comma Separated Value file with no descriptions or page headings, and separates each report field with a comma. For details about CSV files, see “Generating reports in CSV file format” on page 339.

Port Communications command line


Rpt_psts.exe -o OutputFile -h -r -csv

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or an OutputFile name generates the output file Rpt_psts.lst.

-h Prevents the Cancel dialog box from appearing. Suppressing this dialog box prevents any user interference when the command is automatically executed from a session.


Ports reportThe Ports report lists each Server resource and the resource settings. For each Server, the report lists network, process only, and asynchronous resources, as well as their status and usage. For async resources, the report also includes the device, port priority, modem type, inbound and outbound data rate, direct connect Client, and phone number. The second part of the report shows which asynchronous ports use which Long Distance Services.

When you generate this report, the Ports Report dialog box appears. There are no filter options for the Ports report, but you can select the following option:

• Generate CSV File. Creates an enhanced Comma Separated Value file for spreadsheets and databases. A CSV file contains no spacing between columns and separates each value with a comma. Enhanced CSV files also include descriptive tags at the beginning of each line of data.For details about CSV files, see “Generating reports in CSV file format” on page 339.

Ports command line


Rpt_port.exe -o OutputFile -csv -h

-r Resets the port communication statistics once the report is complete.

-csv (or -c) Generates this file in standard Comma Separated Value format for importing into a spreadsheet or database application.


-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_port.lst.


Ports CSV file formatTags associated with this report are:

PORT_DT General port informationPORT_LD Long distance service information

This report always includes the PORT_DT tag, which indicates the beginning of a new ports record. The tags and their associated report fields are:

PORT_DT ServerResource/Port DeviceStatusPriorityModem TypeUsageOutbound Data RateInbound Data RateDirect Connect ClientServer Phone Number

PORT_LD Long Distance ServicePort Number

Portable Security Users reportThe Portable Security Users report lists all authorized Portable user security settings that are defined on RemoteWare’s Server Profile - Portable Security page. The security settings include a user name, computer name and encrypted password.

Portable Security command line






Rpt_psec.exe -o OutputFile -csv -h

Protocols reportThe Protocols report contains information from the Server Profile Protocols page. It lists each resource in alphabetical order by Resource and Description. It also provides information on the packet size (in bytes), window size (in packets), retransmit and session timeout (in seconds), and compression option.

There are no filters for the Protocols report. However, when you generate it, you can select the following option in the Protocols Report dialog box:

• Generate CSV File. Formats this report for spreadsheet or database applications. Creates a standard Comma Separated Value file with no descriptions or page headings, and separates each report field with a comma. For details about CSV files, see “Generating reports in CSV file format” on page 339.

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_psec.lst.




Protocols command line


Rpt_ptcl.exe -o OutputFile -csv -h

Server Log reportThis report lists the Server events recorded in the Server Log program. It contains everything in the Server Log, including the columns visible in the expanded view.

When you generate the Server Log report, you can apply the following filters and options in the Server Log Report dialog box:

• by Server. Lists messages from one or more Servers in a clustered configuration. This option is not available on single Server systems.

• by Time Range. Lists log entries that occurred during a specific time. List entries before or after a specified date and time, between two dates and times, or from the present to a specified number of lapsed days and hours.

• Debug Messages. Includes log entries related to debugging or troubleshooting events.

• Error Messages. Lists error entries in the generated report.

• Fatal Error Messages. Includes log entries with a Fatal status.

• Info Messages. Displays informational log messages in the report.

• User Messages. Includes log entries created from the USER ALARM event.

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_ptcl.lst.

-csv (or -c) Generates this file in standard Comma Separated Value format for importing into a spreadsheet or database application.





• Generate CSV File. Formats the generated report for spreadsheet or database applications. The standard Comma Separated Value file omits the header and page descriptions and separates each portion of the log entry with a comma.

Server Log command line


Rpt_msg.exe -o OutputFile -csv -h -f FilterFile

Session Event Log reportThe Session Event Log report provides detailed information about a session, its objects, individual events and corresponding status messages. This report lists information from the most detailed level in the Session Log detail window.

Use the following filters and options to filter this report; an unfiltered report file could be very large and take some time to generate.

• by Error Type. Choose one or more error types that occur in the Session Log. Selecting one or more error types includes all log entries matching those errors. For a description of these error types, see “Session Log error types” on page 376.

• by Client. Select one or more Clients or Client groups to generate a report with

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or an output file name generates the output file Rpt_msg.lst.





every session involving the chosen Clients. For Client groups, lists sessions involving the Clients in the group.

• by Resource. Select one or more asynchronous ports or network transports (at the end of the list, in alphabetical order) to include Session Log entries that use these resources.

• by Server. Choose from the Servers listed in the Select Servers window. This filter is not available in single Server systems.

• by Session. Displays only the log entries matching the sessions you select in the Select Sessions window.

• by Time Range. Includes entries that occurred during a specified time and date.

• Failed Sessions. Lists sessions with a Failed status.

• Failed-Final Sessions. Displays all sessions with a Failed-Final status.

• Successful Sessions. Includes all Successful sessions in the generated report.

• Completed Sessions. Includes all Completed sessions in the generated report.


• Generate CSV File. Creates an enhanced Comma Separated Value file for spreadsheets and databases. A CSV file contains no spacing between columns and separates each value with a comma. Enhanced CSV files also include descriptive tags at the beginning of each line of data. For details about these tags, see “Session Event Log CSV file format” on page 363.

Session Event Log command line


Rpt_evnt.exe -o OutputFile -csv -h -f FilterFile

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or an output file name generates the output file Rpt_evnt.lst.





Session Event Log CSV file formatTags associated with this report are:

SES_DET General information about a sessionSES_WKO Work Object performed during a sessionSES_EVT Event within the Work ObjectSES_EV2 Event details within the Work ObjectSES_MSG Session commentsSES_ERR Session error informationSES_STA Session count statistics

This report always includes the SES_DET tag, which indicates the beginning of a new session event record. The tags and their associated report fields are:

SES_DET Session NameClient NameStatusStart DateStart TimeDurationServer NameResourceTotal TriesLong Distance ClassThroughput

SES_WKO Work Object Name

SES_EVT Event StatusStart TimeDurationWhereWhenFile SizeThroughputCompression Ration

SES_EV2 Event FlagsEvent Details

SES_MSG Error Message

SES_ERR Failure Message

SES_STA TotalFailedFailed FinalSuccessful Complete


Session Log reportInformation from the Session Log main window appears in the Session Log report. Use this report to see which sessions ran in descending start time order, and to view their duration and resource usage.

When you generate this report, the Session Log Report dialog box provides the following filters and options:

• by Error Type. Choose one or more error types that occur in the Session Log. Selecting one or more error types includes all log entries matching those errors. For a description of these error types, see “Session Log error types” on page 376.

• by Client. Select one or more Clients or Client groups to generate a report with every session involving the chosen Clients (or the Clients belonging to the group).

• by Resource. Select one or more asynchronous ports or network transports (at the end of the list, in alphabetical order) to include sessions that use these resources.

The by Server filter is not available for a single Server system.

• by Server. Choose from the Servers listed in the Select Servers window.

• by Session. Displays only the log entries matching the sessions you select in the Select Sessions window.

• by Time Range. Includes entries that occurred during a specified time and date.

• Failed Sessions. Lists sessions with a Failed status.

• Failed-Final Sessions. Includes all sessions with a Failed-Final status.

• Successful Sessions. Displays all Successful sessions in the generated report.

• Completed Sessions. Includes all Completed sessions in the generated report.




Session Log command line


Rpt_hist.exe -o OutputFile -h -csv -f FilterFile

Session Recovery reportThe Session Recovery report provides a list of all sessions for each Client organized by session status. The report includes additional information about each session’s start date and time, duration, status, and resource port number.

When you generate this report, the Session Recovery Report dialog box provides the following filters and options:

• by Client. Select one or more Clients or Client groups to generate a report with every session involving the chosen Clients (or the Clients belonging to the group).

• by Session. Displays one or more selected sessions in the generated report.

• by Time Range. Displays sessions that executed before or after a set time, between a time range, or over a set number of days and hours.

• Failed Sessions. Lists sessions that have failed but still have pending retries.

• Failed-Final Sessions. Includes all sessions that failed and have no more retries.

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_hist.lst.





• Successful Sessions. Displays all Successful sessions (those that initiated properly, executed all defined events, and ended within defined expectations) in the generated report.

• Completed Sessions. Includes all Completed sessions (those that initiated properly, ended within the defined time frame expectations, but did not execute all events) in the generated report.

• Missing Sessions. Displays sessions that did not start within the expected time frame.



Session Recovery command lineRpt_srec.exe -o OutputFile -h -csv -f FilterFile

Sessions reportThe Sessions report lists each session’s attributes, its work objects, and its Client assignments. The information begins with the session name, type, status, and scheduling values. The report totals and lists assigned work objects, types, and status. Finally, the report totals the assigned Clients and lists Clients and Client groups (groups are displayed in [brackets]).

Note: If you do not use one or more of the previous filters, the resulting report may be extremely large and take a significant amount of time to generate.

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_srec.lst.


-csv (or -c) Creates a standard Comma Separated Value (CSV) file when generating this report. CSV files are used for importing data into spreadsheets and databases.



When you generate this report, the Sessions Report dialog box appears. You can select one or more of the following options:

• by Session. Limits the report to the session(s) you select in the Sessions Report window.

• Generate CSV File. Creates an enhanced Comma Separated Value file for spreadsheets and databases. A CSV file contains no spacing between columns and separates each value with a comma. Enhanced CSV files also include descriptive tags at the beginning of each line of data. For more information, see “Generating reports in CSV file format” on page 339.

Sessions command line


Rpt_sess.exe -o OutputFile -csv -h -f FilterFile

Sessions CSV file formatTags associated with this report are:

SES_DETL General session informationSES_DET2 More informationSES_OBJS Objects assigned to a sessionSES_CLIT Clients assigned to a session

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_sess.lst.





SES_DAYS Session scheduleSES_EXCP Exception daysSES_CALN Calendar scheduleSES_DEPD Dependent scheduleSES_OPTS Session options

This report always includes the SES_DETL tag, which indicates the beginning of a new sessions record. The tags and their associated report fields are:

SES_DETL Session NameStatusTypePriorityOutbound TimeStop HourEarly HourRepeat HourNumber of Repeat DaysRepeat Date

SES_DET2 Retry CountIntervalAlternate Resource

SES_OBJS Work Object NameWork Object TypeWork Object Status

SES_CLIT Client Name

SES_DAYS Week CountSundayMondayTuesdayWednesdayThursdayFridaySaturday

SES_EXCP Date

SES_CALN Date - Time

SES_DEPD Client NameNumber of SuccessfulNumber of FailedNumber of Out of RangeExecute @


SES_OPTS Assigned ObjectsNo AppsNo ESD

System reportThe System report lists global system settings, licensing, and other Server information. The report includes data from several Server Profile pages and from the computer or network storage volumes.

There are no filters available for the System report. However, the following option is available when you generate the report:


System command line


Rpt_sys.exe -o OutputFile -csv -h

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file RPT_SYS.LST.





System CSV file formatTags associated with this report are:

SYS_GLOBL Global Server informationSYS_COMM Server communication settingsSYS_ALARM Alarms settingsSYS_GNODE Global Client SettingsSYS_LOG Logging settingsSYS_LICEN Licensing informationSYS_LICLG Licensing Log informationSYS_CLUST Cluster informationSYS_RESC Server Resource information

This report always includes the SYS_GLOBL tag, which indicates the beginning of a new system record. The tags and their associated report fields are:

SYS_GLOBL System NameLocal ServerSerial NumberData Disk DirectoryVolume LabelDrive SizeFree SpaceCluster SupportAdmin Workstation SupportConcurrentDefinedEnabledMaximumDefinedEnabled

SYS_COMM Universal Time CoordinateWindow SizeMaintain ConnectionDial Connection Priority

SYS_ALARM Server Disk Full ThresholdClient Disk Full ThresholdPort Disable Threshold

SYS_GNODE ESDApplicationsCompression

SYS_LOG Session History StatusLog Failed


Discontinued Event LogLog ESD ObjectsFile TransferFailed TransfersDiscontinued No Executables

SYS_LICEN TypeLicensedActual

SYS_LICLG DateActionLicensedType

SYS_CLUST ServerStatusStateTypeDaysHoursMinutes

SYS_RESC ServerResourceStatusInboundOutboundBoth

User Group Listing reportEach user group and its details appears in the User Group Listing report. For each user group, the report lists the long Description name, whether the group is a distribution list, and the members (user names) in the group.

There are no filters for the User Group Listing report. However, the following option is available when you generate the report:



User Group Listing command line


Rpt_ugrp.exe -o OutputFile -csv -h

User Group Listing CSV file formatTags associated with this report are:

USR_GRP General informationUSR_MEM User group member

This report always includes the USR_GRP tag, which marks the beginning of a new user group record. The tags and their associated report fields are:

USR_GRP Group NameDescriptionDistribution List

USR_MEM Member

User Listing reportAll users defined in the Directory Manager program appear in the User Listing report. For each user, the report lists the full user name, address, address type, assigned Client, and whether this user is configured for directory synchronization.

There are no filters for the User Listing report.

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_ugrp.lst.





User Listing command line


Rpt_user.exe -o OutputFile -h

Work Objects reportThe Work Objects report lists each work object and its characteristics; this information originates in the Work Object Editor. Information from the General and Attributes pages appears first, followed by assigned Clients, sessions, and the list of worklist events.

When you generate this report, the Work Objects Report dialog box provides the following filters and options:

• by Work Object. Includes one or more selected work objects in the generated report.

• by Owner. Specify which objects to include in the report by their originating system. Some examples are SYSTEM, USER, RWWORKSHOP, and RWSUB. To view a chart of owner types, see “Table 29. Owner types” on page 187.

• by Enabled. Includes all enabled work objects in the report.

• by Disabled. Includes all disabled work objects in the report.

• ESD Objects. Includes ESD type work objects in the report.

• Worklist Objects. Includes all Worklist objects in the report.

• Application Objects. Includes all Application work objects in the report.

• Application Group Objects. Includes all Application Group objects in the report.

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_user.lst.




• Group Objects. Includes all Group work objects in the report.


Work Objects command line


Rpt_swo.exe -o OutputFile -csv -h -f FilterFile

Work Objects CSV file formatTags associated with this report are:

SWO_GENL General informationSWO_LIMT Limit Client typeSWO_APPL Application Object settingsSWO_MEMB Work Object group memberSWO_CLNT Client assignedSWO_SESS Session assignedSWO_USER User assignedSWO_WEVT Work object eventSWO_PRES Pre-ESD eventsSWO_PTES Post ESD eventsSWO_ESDF ESD files

This report always includes the SWO_GENL tag, which marks the beginning of a new

-o OutputFile Generates a report file with the name OutputFile. Omitting this option or the OutputFile name generates the output file Rpt_swo.lst.





work object record. The tags and their associated report fields are:

SWO_GENL Work ObjectStatusTypeExecutionPriorityOwnerLimit ClientExecute WindowActivate OnDeactivate OnInstall Kit

SWO_LIMT Client Name

SWO_APPL Executable FileWork Dir/PathCommand Line

SWO_MEMB Work ObjectStatusTypePriority

SWO_CLNT Client Name

SWO_SESS Session NameStatus

SWO_USER User Name/ Group DescriptionGroup Name/User

SWO_WEVT FlagsEvent

SWO_PRES FlagsEvent

SWO_PTES FlagsEvent

SWO_ESDF FlagsEvent


Session Log error types You can apply the by Error Type filter in the Session Event Log and Session Log reports.

The following table describes the possible error types in the Session Log:

Table 59. Session Log error types

Error Description

Busy The connection could not begin because the resource indicates that it is not available at this time.

Client Security A connection occurred, but the internal Client security token does not match expected values. The session was terminated before the first event occurred. To resolve, select Command Reset Security in Client Profile.

Critical The session ended on an event marked as Critical. A critical event causes the session to automatically terminate if the event fails to successfully complete. Check the event detail to determine which critical event failed.

ESD Failure Files in the ESD work object(s) failed to transfer because of an invalid disk, directory, or path in the object; insufficient disk space at the Client; or an incorrect Install Drive and Path in Client Profile. Check the event detail or the Server Log for more information.

Invalid Disk Drive

One or more events could not be completed because the disk drive specified in the event does not exist. Use the event detail to determine which event(s) failed, then alter the events or create the appropriate directory structure.

Invalid Password

A connection failed during the security check because the Client’s password does not match the password on the General property page in Client Profile.

Invalid Serial Number

A connection failed during the security check because the Server’s serial number did not match those for the Client’s primary or secondary Servers. On the General page (Client Profile), change the Other Server Serial Numbers field to allow this Client access to a secondary Server.

Lost Carrier The resource interrupted the connection before the session was complete. See the event detail to determine when the connection was lost. Restarting the session continues from the point of interruption; the session does not repeat successful events.

Modem Error A modem connected to the Server is not functioning as expected. This may be due to an incorrect data rate, return code set, or incorrect cabling. It may also be resolved by turning the modem on and off, or disabling and re-enabling the port to reset the modem.

No Answer The connection never started because the Client’s modem or resource did not answer. Determine if the Client is turned on, or if the modem is in auto-answer mode. Also verify that no other systems or people use the phone line or resource for other purposes.

S e s s i o n L o g e r r o r t y p e s 377

No Connect The Server was able to connect with the Client’s modem or network resource, but was not able to start the session because the Client software was not active. Verify that the modem or resource is correct, the Client is on, and the Client software is active and running.

No Dial Tone The Server was not able to start the outbound session because the asynchronous resource had no dial tone. Check the resource for correct operation.

No Resources The Server could not start the outbound session because no matching resources are available. The Schedule Manager detail window lists the matching resources for this session. Also check if matching resources are properly defined and enabled.

Out of Range The session was not able to begin because no matching resources were available within the session’s execution window. This can occur if the resource is disabled or unavailable, or if too many sessions compete for the same resource during a certain timespan.

Registration Disabled

The session was not able to complete because Client registration is not enabled. To permit registration, use the Client Profile program. On the Registration menu, click Options; the Client Registration Options window appears. In this window, select the Enable Client Registration check box.

Server Reboot A Server rebooted while it was running or waiting to retry this session. Restarting the session will continue after the last successfully completed event; rerunning the session will start with the first event.

Timeout No acknowledgment occurred within an expected time range during a connection. Many factors cause timeouts, including incorrect hardware or software configuration, faulty connection hardware, or external interference or static.

Undefined Indicates a general system error or may signal a problem with the multiport communications card in the Server.

Unscheduled The session or Client is disabled.

User Abort The session was interrupted either from the Server (using the Schedule Manager Command Abort Active Session command) or from the Client (using the Cancel Connection command).

Wrong Client The Server dialed a phone number or addressed a network Client, but connected to the wrong Client. Verify the phone number or network address is correct.

Table 59. Session Log error types (Continued)

Error Description

C H A P T E R

14

Interactive Session

Use Interactive Session to immediately connect with any enabled Client. Interactive

Session then provides you with the ability to execute any sequence of events, or use

Remote Control to view and directly manipulate a Windows Client’s user environment.


• “Interactive Session at a glance” on page 380


• “Interactive Session main window” on page 393

• “Remote Control” on page 395

• “Remote Console” on page 399


Interactive Session at a glance A stand-alone Portable system can access and communicate with a RemoteWare Server. For details, see the RemoteWare Portable Interactive Session User’s Guide.

Use the Interactive Session program to manipulate Client and Server file systems in real time (as opposed to deferred or scheduled), without defining a set order of events in a work object. Interactive Session cannot initiate a scheduled session to the Client, and any sessions scheduled to run to the Client during an interactive session are not executed. Only the commands you specify during the interactive session are performed.

As an extension to typing and executing events, Interactive Session can initiate Remote Control to Windows Clients. Remote Control opens a “window” to the Client’s user environment, where you can view the Client display in real time and interact with the Client using the mouse and keyboard. Remote Control does not completely take over the Client; a Client user can continue to use the computer provided the administrator does not intervene. For example, the administrator can perform a sequence of events, then watch as the Client user repeats the procedure. Remote Console is an additional feature, and it provides the capability to run text-based applications stored on DOS or OS/2 Clients remotely from the Server.

As with other sessions, an interactive session does not interfere with applications that may be active on the Client. Communication between the Client and the Server may take place transparently, without the Client user’s knowledge.

Launch Interactive Session by double-clicking its icon, located by default in the RemoteWare Menu. Interactive Session prompts you to select the Client with which you want to communicate as well as the communications protocol to use. Interactive Session then attempts to connect to the selected Client.

Interactive Session consists of a main window divided into a command prompt area and a command line screen. For more information, see “Interactive Session main window” on page 393.

Note: To issue commands on the Server only, do not select a Client.


Menu commandsThe following table lists the menu commands specific to Interactive Session. For clarity, the table spells menu commands exactly as they appear in the application. Sections following the table describe most of the menu commands in detail; these sections may reference the command without additional capitalization or arguments.

Note: Not described in this table are the commands available to all RemoteWare Server programs; for a list of general commands, see “Menu commands common to most programs” on page 25.

Table 60. Interactive Session menu commands


File Capture <filename> [RTF, TEXT]

Inserts the Capture command at the command prompt. Use this command to save the screen’s contents to a file.

Edit Cut Removes the selected text from its present location and places it on the Clipboard. (This command is available only in the command prompt field.)

Copy Duplicates the selected text and places the copy on the Clipboard. The original selection is not changed.

Paste Places a previously cut or duplicated item in the selected location.

View Toolbar Shows or hides the toolbar.

Status Bar Shows or hides the status bar.

Set Font Displays the Set Font dialog box. Use this standard Windows dialog box to select the font, style, and size you want to use in the output screen.

Set Colors Displays the Set Colors dialog box. Use this dialog box to select a background color for the output screen and to define the colors in which the different commands, results, and errors appear on the output screen.

Word Wrap Wraps text from one line to the next instead of scrolling past the right side of the screen.


Command CoNnecT [client] Initiates a connection to the selected Client. This command is available only when no Client is currently connected.

Command DISConnect Disconnects the current connection.

Abort Session Stops a connection attempt to a Client. This command may take several seconds to complete.

CLear Screen Removes all text from the command screen.

Command HELP [command]

Displays general help for any Client or Server command.

Remote Control Starts a visual display of the Client’s user interface by establishing a Remote Control session. If this command is unavailable, either you are not currently connected to a Windows Client or the Client does not have Remote Control installed.

Start Remote Console

Runs a text-based application on a DOS or OS/2 Client and provides a visual display of the Client’s screen in real time. If this command is unavailable, either you are not currently connected to a DOS or OS/2 Client or the Client does not have Remote Console installed.

Stop Remote Console

Stops a Remote Console session and returns to the Interactive Session main window.Note: Stopping Remote Console does not terminate the active connection.

Options Protocol Settings Display

When selected, displays Client specifics once a connection is established.

Command Verification

When selected, prompts you to verify the action before executing a command that will alter the file system.

Session Timeout Specifies the number of minutes before the Server disconnects because of inactivity.

Encrypt Session When selected, enables encryption for the subsequent sessions.

Client Commands

For a description of these commands, see “Client Commands menu” on page 387.

Table 60. Interactive Session menu commands (Continued)



File menuOn the File menu, click Capture to copy the contents of the screen to a file on the Server. The output file contains all the text visible in the scrollable area of the screen. To create an output file, you can also click Capture on the Interactive Session toolbar, which inserts the following command at the command prompt:

CAPTURE FileName[.TXT, .RTF]

The file extension dictates how Interactive Session formats the file:

• No extension. Creates a text file. For example, type CAPTURE Sample1. Interactive Session creates the file Sample1.txt.

• .txt extension. Creates a text file. For example, type CAPTURE Sample2.txt to create a text file with the same name.

• .rtf extension. Creates a Rich Text Format file (RTF). RTF files contain formatting that preserves the type style, color, and spacing of the original transaction. The tags and text are visible in a viewer such as Notepad, but require a program such as WordPad to see the RTF formatting.

When you have specified a file name, click Execute to create the capture file.

Edit menuThe standard Cut, Copy, and Paste editing options are available on the Edit menu or the toolbar. Use these commands to manipulate text to and from the command prompt and the Clipboard.

• Cut. Only works on selected text in the Command Prompt field. Moves selected text to the Clipboard, removing it from its original location. The text remains on the Clipboard until the next cut or copy operation by the user.

• Copy. Moves a copy of the text selected in the Command Prompt field or in the command line screen to the Clipboard. Does not change the original selection.

Server Commands

For a list of these commands, see “Server Commands menu” on page 390.

Note: The file name is required. It is not possible to append the capture file to an existing file.

Table 60. Interactive Session menu commands (Continued)



• Paste. Copies the contents of the Clipboard to the present cursor position.

View menu

• Set Font. Displays a standard Windows Font dialog box, where you can select the type, style, and size of the font that appears on the command line screen. Choose from several different fonts, four font styles, and several sizes. As you select various font options, the Sample box displays an example of your selections.

• Set Colors. Displays the Set Colors dialog box, where you can adjust the color codes used for different Interactive Session messages. Choose from up to 16 different colors for the Server commands, Server results, Client commands, Client results, errors, and the background.

• Word Wrap. When selected, eliminates the horizontal scroll bar and continues long lines on the next line. Use this option to view the entire screen without shifting the view from side to side. Word Wrap is also useful for viewing files that do not contain line breaks.

By default, Word Wrap is not selected; long lines of text scroll beyond the right side of the screen. The horizontal scroll bar appears whenever the screen buffer contains lines longer than the screen length.

Note: Font selections are valid only until you exit Interactive Session. When you restart Interactive Session, the output screen font settings return to the defaults.

Note: Color selections are valid only until you exit Interactive Session. When you restart Interactive Session, the output window colors return to the defaults.

Note: Turning Word Wrap on and off does not alter the screen text or truncate the contents.


Command menuUse the Command menu to control the connection status, clear the screen, and display help on Interactive Session commands. Commands on this menu are:

• Connect. Starts the process to connect to a Client. In addition to using the menu command, you can also click Connect/Disconnect on the toolbar, or use the CONNECT or CNT command line. The text form uses one of two formats:

• CONNECT [ClientName]

• CNT [ClientName]

where ClientName is one of the enabled Clients in the Client Profile program.

You must disconnect from a Client before connecting to another Client.

If you omit the Client name, Interactive Session displays the Select Client window. Select a Client and click OK to begin a connection to that Client. To return to the main window without connecting, click Cancel.

• Disconnect. Immediately terminates the Client connection. Issue this command from the menu bar, by clicking Connect/Disconnect on the toolbar, or by typing DISC or DISCONNECT in the Command Prompt field. This command is available only when the Client is connected. (To stop a pending connection, select Abort Session.)

• Abort Session. Stops a connection in progress. This menu command is available only while the Server attempts to connect to the Client. (To stop an established connection, select Disconnect.)

• Clear Screen. Deletes all text in the command screen. Once you have cleared the screen, you cannot recover the text. To clear the screen, click Clear Screen on the Command menu, click Clear Screen on the toolbar, or type CLS in the Command Prompt field.

• Command Help [CommandName]. Displays the command line format for any Interactive Session command. To view help for a command, you can also type HELP in the Command Prompt field. These additional options are available:

• To display every command and valid arguments, type HELP and press [Enter].

• To display information on a specific command, type HELP plus all of the capitalized letters of the command. Then press [Enter]. For example, to display help for the ASCii APPend command, type HELP ASCAPP.

• To display information for valid commands on the Client or Server, type CLIENT HELP or SERVER HELP, respectively.

• Remote Control. Starts Remote Control, which establishes a connection from the Server to the Client. You can use Remote Control to view and manipulate the


elements in a Client’s window. For more information about this feature, see “Remote Control” on page 395.

• Start Remote Console. (Before you can use this command, you must first initiate an outbound connection to a DOS or OS/2 Client.) Starts Remote Console, which provides a way to run text-based applications on a DOS or OS/2 Client remotely from the RemoteWare Server. You can use Remote Console to view and manipulate the Client machine’s visual display. For more information about this feature, see “Remote Console” on page 399.

• Stop Remote Console. Terminates the active Remote Console session, but does not disconnect the interactive session between the Server and the DOS or OS/2 Client. (To terminate the interactive session, select Disconnect from the Command menu.)

Options menuUse the Options menu to control the way you interact with the Interactive Session program during a session. Commands on this menu include:

This command is selected by default. Turn off the Protocol Settings Display if you do not need to view the protocol information.

• Protocol Settings Display. Lists the protocol, packet size, window size, compression, session timeout, and retransmit timeout values assigned to this Client.

The information appears once the connection is successful.

• Command Verification. Requires you to confirm commands that alter the Server or Client file systems, or those that may take time bring up a window. This command is particularly helpful for verifying that you entered the commands correctly.

To suppress the Command Confirmation message box, clear this option. When you turn off command verification, no message appears when you issue commands.


• Session Timeout. Specifies the amount of time the connection can remain inactive before disconnecting. The default setting is 5 minutes. To change this value, use the following controls:

• Timeout period. Use the spin box to set the number of minutes the connection remains idle before timing out. The default setting is 5 minutes; specify a value from 1 to 60 minutes.

• Timeout Enabled. Select this check box to activate the timeout period. Or, you can specify that the connection will never time out by clearing this check box.

• Encrypt Session. Select this check box prior to connecting to a Client to encrypt a session.

Client Commands menu

To instruct a Client to perform specific actions during an interactive session, use the commands in the following table. The table lists menu commands exactly as they appear in the application. To use the short version of a command, type only the capitalized letters.

When typing commands in the Command Prompt field, verify that the Client option (on the right of the Command Prompt) is selected if you want to execute the event on the Client; otherwise, it will execute on the Server. To apply commands to the Client, click Client or type CLIENT in the Command Prompt field.

These rules apply to the Server and Client commands listed in the following table:

• Uppercase letters indicate the abbreviated command. For example, you can type APP for the command APPend followed by the appropriate required fields.

• Angle brackets (<>) indicate that the information is required. For example, the Delete command requires you to type a <filename>.

• Brackets ([ ]) indicate that the information is optional. For example, the Copy command does not require you to type a [destination filename].

Note: This menu is available only when Interactive Session is connected with a Client.


To display information on a specific command, type HELP plus all of the capitalized letters of the command. Then press [Enter]. For example, to display help for the ASCii APPend command, type HELP ASCAPP.

• <filename(s)> means that wildcards (* and ?) are permitted for this command. For example, SEND file can send the specified files in a Server directory to a Client directory.

Table 61. Interactive Session Client and Server commands

Menu command Command line examples Description

APPend <filename(s)> <destination filename>

append C:\*.psl D:\All.psl app Sale*.dat "SalesTotals"

Joins any set of files. Does not alter file contents. Use asciiappend for text files to ensure correct placement of end-of-file marks.

ASCii APPend <filename(s)> <destination filename>

asciiappend *.txt Full.txtascapp *.rtf Digest.rtf

Joins text files. Removes the end-of-file mark in each file and places at end of last file.

Change Dir <directory>

chdir "Working Dir" cd Sales\99\q1 cd ..\..

Moves to the specified directory. When moving up the hierarchy, be certain to place a space character between the command and the argument.

CHECK SEND FILE <Server filename(s)> <Client filename(s)> <Client destination>

CHECK SEND FILE C:\Test*.txt D:\Test*.txt D:\Dir

Compares one or more files and sends the file(s) to the specified directory on the Client if the files differ.

CHKDSK [disk drive]

chkdskchkdsk D:

Checks the free and total disk space. If no drive is specified, checks the installation drive or Server data drive.

COPY <source filename(s)> [destination filename(s)]

copy *.dat Dir\*.dax copy "Thisfile" "Thatfile"

Creates a new copy of the file(s). Can also be used to change the name and location of the destination file(s).

CREATE REGistry KEY <registry key>

createregkey hklm\software\key Creates a new key in the registry.

DELete <filename(s)>

delete *.txt del \Data\Strat95.doc

Removes one or more files from the Client or Server.


DELete REGistry KEY <registry key>

delregkey hklm\software\key Removes a key from the registry.

DELete REGistry VALue <registry key> <value>

delregval hklm\software\key\name C:Temp

Removes a value from the registry.

DIRectory [wildcard]

dir ECF\*.ece dir "File storage"

Lists the contents of a directory or specific files in a directory.

EXEcute <command>

execute Winfile.exeexe d:\Runtime\d018.exe

Launches an application. Uses the PATH variable when no path is specified. The command ignores any return status from the application.

File STAT <filename>

filestat d:\Flags\a2201.flgfstat c:\Wateract.rtf

Checks for the existence of a file. If found, lists the file name, size, date, and time.

GET file [Server filename(s)] <Client filename(s)>

get D:\Srvr\Dest.txt d:\Src.txtget C:\Mercury.doc

Copies files from the Client to the Server. No destination places the file(s) in the Server data drive.

GET REGistry VALue <registry key><value>

getregval hklm\softwre\key\name Retrieves a value from the registry.

Make Dir <directory>

mkdir Quartermd "New Year Forecasts"

Creates a directory. Fails if the directory already exists or the supporting directory structure does not exist.

NOTify <queue/pipe> <command>

notify /Queue/rws/ecfservr.que x not \\RW\Pipe\App.pip start

(Server command only.) Sends a message to a local or networked application.

REBOOT [Cancel] REBOOT Executes only at the end of a session, or the session will terminate during execution of the work object. (Available for DOS Clients only.)

Remove Dir <directory>

rmdir Sales\mtrd "Trash\Empty Folder"

Deletes a directory on the Client or Server.

Table 61. Interactive Session Client and Server commands (Continued)



Server Commands menuThis menu is available at any time during an interactive session. Many of the Server commands are the same as those on the Client Commands menu. For a list of commands, see “Table 61. Interactive Session Client and Server commands” on page 388. Items marked as Client command only are not available on the Server Commands menu.

Other commandsThe following table lists miscellaneous commands that you can type in the Command Prompt field. The table also indicates when these commands are available from the

REName <old filename(s)> <new filename(s)>

rename c:\*.txt c:\Old\*.oldren New.dat Old.dat

Changes the name of one or more files. Can also move files from one location to another on a computer.

SEND file <Server filename(s)> [Client filename(s)]

send Shipping.datsend *.dat c:\Shdb\*.txt

Transfers one or more Server files to Client. If you do not specify Client filename(s), uses the installation drive and path name.

SET file ATTRIButes <filename(s)>

SET ATTRIBUTES C:\Winnt\System32\Notepad.exe NORMAL

Modifies a Windows, DOS, or UNIX file’s attributes.

SET REGistry VALue <registry key><value>

setregval hklm\software\key\name C:\Temp

Sets a specified registry value to the string specified.

SET TIME settime (Client command only.) Synchronizes Server and Client time using the Client’s time zone value.

TIME time Displays the current time on the Client or Server.

TYPE <filename> type C:\Autoexec.bat Displays the contents of a file. Text appears in the command screen once the file transfer is complete.

Table 61. Interactive Session Client and Server commands (Continued)



menu bar, toolbar, or elsewhere on the user interface.

Using literals in pathnamesOn the Server, you can pass a literal string for pathnames and filenames. Literal strings are text that contain reserved characters, such as wildcards, spaces, and punctuation. When a Server encounters a literal string, it does not check to see if the string is valid; it uses the string as is.

To specify a literal string, use double quotation marks (“ ”) to set off the pathname and filename. The ending quotation mark is optional in the last parameter on the command line. The double quotation marks prevent the Server from adding the default drive or path and allows you to use mixed case, other device names, long filenames, or filenames that include reserved characters or spaces.

Use the following guidelines when specifying literal strings within sessions:

• You can use placeholders within a literal string. The placeholder will not be sent as a literal string. For example:

GET FILE "/<ClientName>/TheFile

The system inserts the actual Client name. <ClientName> will not be passed as a literal string.

• The end quote is needed only when the command line is ambiguous due to long filenames or spaces. For example:

COPY "This is file 1" "This is the copy"

Table 62. Interactive Session miscellaneous commands

Action Command line examples Equivalent action(s)

Switch to Server view SERVER or SV Click the Server option.

Switch to Client view CLIENT Click the Client option. This option is available only when connected to a Client.

Connect to Client CNT <ClientName> Command Connect or .

Disconnect DISC Command Disconnect or .

Capture screen CAPTURE <FileName> File Capture or .

Clear screen CLS Command Clear Screen or .

Command help HELP <CommandName> Command Command Help.


Using long file namesOn the RemoteWare Server, you can use file names of up to 255 characters for any Server and Client computer whose operating system supports the use of long filenames. Files can be renamed to shorter or longer names during a file transfer, copy, or rename operation.

For example, type SEND "MY LONG FILE NAME" Myfile.dat to copy the Server file MY LONG FILE NAME and rename it to the short Myfile.dat name on the Client.

I n t e r a c t i v e S e s s i o n m a i n w i n d o w 393

Interactive Session main window

To start Interactive Session, double-click the Interactive Session icon in RemoteWare Menu (located in the All Utilities or Server Operations group). First, the Select Client window appears.

Encrypting a session

Session encryption is disabled by default each time you launch the application. To enable encryption for a Client session, select Encrypt Session from the Options menu prior to connecting to a Client. Encryption remains enabled for subsequent sessions until you disable it by selecting it again from the Options menu.

Initiating a sessionIn the Select Client window, select one Client that you want to connect with and click OK.

Note: RemoteWare supports SSL encryption only for Windows and Linux Clients that are using a TCP/IP resource for the session. Clients that do not support encryption notify the Interactive Session user upon connection.

Note: If there are no resources available to start this session or if the Client is already engaged in a session, you are given the choice to wait for an available resource or cancel the connection.


Interactive Session connects to the Client you selected and displays the main window.

The following components and controls appear in the Interactive Session main window:

• Current Directory. Directly below the toolbar, Interactive Session displays the current Client or Server drive letter and directory. On the Server, the default directory is the data drive, or NODE\<Client Name> on the data drive if a Client is (or has) connected at the Client prompt. The Client default directory originates from the Install Drive and Directory field on the Client Profile General page.

• Command Prompt. This area contains several controls for executing commands on either the selected Client or the Server:

• Command prompt. Displays the current command. Type commands in this field to send or complete them. To view a list of previous commands, click the arrow; commands are listed from most to least recent. Select any previous command in the list to reuse it. You can also scroll through previous commands by using the arrow keys.

• Execute/Cancel. Click this button to issue the command or stop the command from completing, respectively. Clicking Execute has the same effect as pressing [Enter] at the end of a command.

• Client. Executes the command(s) on the Client computer. Be careful to select the correct option, or you may perform an action on the wrong computer.

Command Prompt area

Status bar

Output screen

R e m o t e C o n t r o l 395

• Server. Executes the command(s) on the Server computer. Make sure to choose the correct option (Client or Server); otherwise, the command may be sent to the wrong computer.

• Output screen. The center area of the main window displays every command and response during the session. If there is additional text off screen, the vertical and horizontal scroll bars appear.

To save the screen buffer, click Capture on the File menu.

• Status bar. The bottom area of the window contains these session and progress indicators:

• Connected Client name. Shows the name of the currently connected Client.

• Current connection state. Indicates the state of the current session: Disconnected, Connecting, or Connected.

• Starting Server time. Displays the hh:mm:ss time when the connection is established. This time also serves to indicate the last time Interactive Session connected to a Client. This time value resets when you exit the Interactive Session program.

• Elapsed connection time. Resets and counts the amount of time the Server is connected to the Client. Stops when the connection is broken, but remains available until the next connection completes.

Remote ControlInteractive Session has a special feature called Remote Control, which provides a way for you to interact graphically with a Client’s user environment instead of by typing commands. With Remote Control, you can see the Client’s screen and manipulate it just as if you were operating the computer from its keyboard and mouse.

This version of RemoteWare contains Symantec’s pcAnywhere™ and Danware’s NetOp™ products as remote control solutions for Windows Clients. When you use Remote Control, you use pcAnywhere or NetOp for controlling the remote Client.

Note: The versions of pcAnywhere and NetOp included with this release are customized for use with RemoteWare. To understand the functionality of pcAnywhere, read the pcAnywhere documentation included on the RemoteWare CD. To understand the functionality NetOp, read the NetOp documentation included on the RemoteWare CD.


If this command is unavailable, the Client is either not a Windows Client or does not have the Remote Control work objects assigned. See the RemoteWare Server Administrator’s Guide for more information.

To start Remote Control for pcAnywhere, select Remote Control from the Command menu. This instructs the Server to contact the Client to start a Remote Control session. As pcAnywhere attempts to connect to the Client, the following dialog box appears.

Note: No direct support of modem pooling is provided.

Note: If you are using SPX to connect to the Client, the following additional dialog box appears. Select the computer you want to control in the list provided. For more information about this dialog box, refer to the pcAnywhere documentation.

Note: To remotely control Clients using the NetOp remote control solution, refer to the Remote Control NetOp Guide documentation for instructions.

R e m o t e C o n t r o l 397

In order for the colors on the Server and Client to match, set both to run the same number of colors. For example, run both Server and Client with the number of colors set to 256.

When the connection is complete, Remote Control displays the contents of the Client’s window, as shown in the following illustration. You are now ready to remotely control your Client as needed.

Using the pcAnywhere toolbarThe pcAnywhere program adds a toolbar with the following options available. For information about each button, refer to the pcAnywhere documentation.

Full Screen

Screen Scaling

Online Options

File Transfer

Chat

Transfer Clipboard

Save Screen

Ctrl+Alt+DelRestart Host

End SessionSwitch to

voiceSession Recording


Exiting Remote Control - pcAnywhere

To terminate a Remote Control session using pcAnywhere, click End Session on the pcAnywhere toolbar. When you shut down Remote Control this brings Interactive Session to the foreground. Interactive Session is still connected to the Client. For Workstation users, Interactive Session is no longer connected to the Client.

Uninstalling Remote ControlIf Remote Control has been installed on the Client via a work object during a RemoteWare session, it is not uninstalled automatically when the Client is uninstalled. Uninstall Remote Control manually.

R e m o t e C o n s o l e 399

Remote ConsoleInteractive Session has an additional feature called Remote Console; you can use this option to remotely run text-based applications that are stored on DOS or OS/2 Clients. For example, if you wanted to use a text-based spreadsheet program stored on a Client, you could use Interactive Session’s Remote Control feature to execute the program from the Server machine. Everything that appears on the Client’s screen also appears in the Interactive Session window on the Server computer.

Remote Console supports all keystrokes on a U.S. English keyboard except for Print Screen, Scroll Lock, and Break, as well as the [ALT] key in combination with number pad keys. All keystrokes entered at the Server and Client are shared. Remote Console supports any text-based application that runs on the same console as the RemoteWare Client Kernel. Video graphics are not supported; only text and text color attributes are supported. Remote Console captures screens in 25 line mode, not in 43 or 50 line mode.

Remote Console’s timeout feature automatically terminates the Remote Console session after five minutes of inactivity. If no screen updates are sent to the Server for more than five minutes, Remote Console stops and the Interactive Session main window returns. Once Remote Console ends, the timeout for Interactive Session is reset. Interactive Session disconnects the Client after five minutes of inactivity.

Some DOS commands, for example DOS COPY CON, lock out other processes until the DOS command completes. If the command takes a long time to end, the communications session may be dropped depending on the RemoteWare protocol assigned to the Client. See the RemoteWare Server Administrator’s Guide for more details.

To start Remote Console, you must first initiate an interactive session with a DOS or OS/2 Client. Then select Start Remote Console from the Command menu, which instructs the Server to begin a Remote Console session. If this command is unavailable, the Client is either not a DOS or OS/2 Client or the Server has not yet established a connection to that Client.

Note: For Remote Console to run, the Kernel must be running in a full screen DOS or OS/2 Session. If the application running on the Client switches to graphics mode while you are using Remote Console, Remote Console ends automatically and returns you to the Interactive Session main window.


Once Remote Console starts, the middle portion of the Interactive Session main window is replaced by a black text screen.

The window displays the console screen for the currently running RemoteWare Client Kernel. All Interactive Session menu commands and toolbar buttons except the Stop Remote Console command are disabled when Remote Console is active.

For step-by-step instructions on using Remote Console, see the RemoteWare Server Administrator’s Guide.

C H A P T E R

15


Use the Messaging Administration program to view and configure the settings and

options related to the RemoteWare Messaging Services subsystem. These systems

include message logging, directory synchronization, non-delivery receipt handling, and

the Gateway Manager.


• “Messaging Administration main window” on page 402

• “Messaging Administration at a glance” on page 402

• “Messaging Services fundamentals” on page 403

• “Messaging and open systems” on page 404



• “Personal Folders (Message Store service)” on page 419

• “Personal Address Book service” on page 421


Messaging Administration at a glanceThe Messaging Administration program contains the settings that you use to view or set log file parameters, perform address updates (or user directory synchronization), specify non-delivery receipt generation, and view messaging gateways. These settings directly affect the Message Transfer Agent (MTA) process and provide flexibility with maintaining RemoteWare Messaging Services. Messaging Administration also displays the current databases for the messaging subsystems and gateways, and it provides access to the Messaging API (MAPI) oriented Mail icon in Control Panel.

Messaging Administration main window

Launch the Messaging Administration program by double-clicking its icon in RemoteWare Menu (located in the Messaging Operations or All Utilities groups). The main window appears.

Messaging Administration consists of a main window organized into five property pages, as well as two MAPI windows for the message store and address book services. For information about each item, refer to the appropriate sections later in this chapter.

For a description of how RemoteWare Messaging Services interoperates with open systems such as ODBC and MAPI, see “Messaging and open systems” on page 404.

M e s s a g i n g S e r v i c e s f u n d a m e n t a l s 403

Messaging Services fundamentalsMessaging Services (also called messaging) is a RemoteWare component that provides transport, storage, and processing for electronic messages.

The RemoteWare Server uses the Message Transfer Agent (MTA) to move electronic messages through the RemoteWare network. The MTA resides at the Server; it locates the message’s destination address and distributes it to the appropriate delivery mechanism.

Once setup is complete at the Client, Messaging Services may not be obvious to the user. Hidden to the user, RemoteWare queries MAPI for message recipients compatible with the RemoteWare network and accumulates messages and other attachments in a message queue. The RemoteWare Client exchanges the queue’s contents during the next connection with the RemoteWare Server.


Messaging and open systemsThe purpose of this section is to provide a high level technical overview of the RemoteWare messaging service providers for Microsoft’s MAPI messaging subsystem.

The MAPI 1.0 subsystem (also referred to as extended MAPI) is available as part of the Windows operating systems. MAPI provides a rich set of tools for developing messaging-enabled applications, but its strongest feature is its standard interface for vendors of electronic messaging systems. The interface extends messaging subsystems by supplying service providers to reach beyond Microsoft mail systems. All service providers are individually installable, and multiple providers can be simultaneously active and managed by the MAPI subsystem. Microsoft defines three types of service providers: address books, message stores, and transports.

Address bookThe address book service provider uses a single graphical interface for accessing mail user or recipient data. The interface allows viewing of multiple address book services at one time. Through the interface, users can view mail users, user groups, and distribution lists. User lists provide the elements for building recipient lists for message delivery, and serve as a look-up service for people within the organization or enterprise. User groups are meant as an organizational tool for logically grouping users who share similar attributes such as location or department. Distribution lists are used to build groups of recipients that regularly receive messages as a unit.

RemoteWare address book provider architectureThe Windows Client address book uses the Open Database Connectivity (ODBC) API to store and retrieve data in a Microsoft Access database. There are tables for information on users, user groups, and distribution lists. The address book provider handles database access and implements the interfaces defined in the MAPI address book service provider interface.

The Server address book service provider uses ODBC to implement the MAPI address book interfaces and to access Microsoft SQL Server database tables.

Message storeThe message store service provider is a central storage facility for messages. The message store consists of a hierarchy of folders which contain messages, which in turn contain properties such as subject, text body, attachments, and a list of recipients. Microsoft provides a default message store with MAPI. RemoteWare uses the default

M e s s a g i n g a n d o p e n s y s t e m s 405

message store provided by Microsoft.

TransportThe transport service provider is responsible for moving messages across the network. The messaging enabled application places sent messages in the user’s outbox folder. MAPI’s message spooler is notified when outbound messages exist, and examines the message type to determine which transport service is capable of delivering the message. MAPI then queries the installed transport service providers to determine their ability to deliver the message, and notifies the first provider capable of delivering the message. That provider is given a pointer to the message in the message store. The RemoteWare transport packages the messages for delivery to the RemoteWare Server. The RemoteWare transport supports remote Windows Clients as well as the RemoteWare Server.

Transport service providersThe transport service providers interact between the MAPI message store and the RemoteWare message queues. At the Client, the RemoteWare transport processes MAPI messages in the inbound message queue (those received from the Server), places messages (for recipients not on this Client) in the outbound message queue, and delivers messages to local recipients on the Client. The flow of the messages in these modes is defined in the next sections.

Outbound messagesAfter the MAPI-aware program places a message in the outbox folder of the originator’s message store, the MAPI spooler is notified of the pending message. The spooler examines the message and determines which of its installed transport services is capable of delivering it. If the RemoteWare transport is selected by MAPI to deliver this message, the spooler notifies the RemoteWare transport provider with a pointer to the message.

The RemoteWare transport provider transfers the message to a process that converts message properties into a compressed and encrypted file. This file format preserves all the properties of the original data, including formatting, attachments, and addressing information. In addition, the information is optimized for transport over RemoteWare networks.

Once the message is converted, the RemoteWare transport places the message in the outbound message queue and awaits delivery to the RemoteWare Server.

Inbound messagesAfter the Client receives a message from the RemoteWare Server, the RemoteWare


transport places the message in the inbound queue. The message queue notifies the MAPI transport service of received mail. The MAPI transport extracts the message from the message queue. If a user is logged on to MAPI, the transport places the message in the recipient’s message store inbox folder.

If no users are logged on to MAPI, then the transport provider cannot access the user’s inbox. When this occurs, the transport provider will temporarily store the message using the local message queue manager. The local queue provides temporary storage for message files whenever the transport provider cannot immediately deliver a message. This usually occurs when a user sends mail to another user on the same Client computer, or when the recipient of the message is not logged on. As soon as the user logs on, the transport retrieves any messages in the local queue and places them in the message store inbox folder.

Local message deliveryRemoteWare uses the local message queue to deliver messages sent between users on the same Client or computer. The MAPI transport provider examines messages for local recipients. Rather than send the message to the Server and back to the same Client, the transport attempts to deliver messages directly to the local message store. If the recipient is not logged on, it uses the local queue for temporary storage.

Tracking and reportingThe transport provider is also responsible for delivery and receipt notifications. If it is unable to deliver a message, it generates a non-delivery receipt (NDR) and delivers it to the message originator. Messages can be set to request delivery and receipt notifications. The notifications are special messages that notify the originator when the message is or is not received or delivered to individual recipients in the address list. Delivery reports are generated at the time the message is delivered to the inbox folder. Receipt notifications are generated when the user opens the message.

Menu commandsThe following table lists the commands specific to the Messaging Administration program. Sections later in this chapter describe the menu commands in detail.

Note: This table does not include the commands that are available to most RemoteWare Server programs. For a list of general commands, see “Menu commands common to most programs” on page 25.


Table 63. Messaging Administration menu commands


Command MAPI Message Store Service

Performs maintenance on the RemoteWare Personal Folder. Select this command to change the folder’s name, password, comment, or compact its contents.

MAPI Address Book Service

Changes settings in the RemoteWare Personal Address Book. You can change the name, file location, user naming order, or comments.


Property pagesThe following topics provide information about the Messaging Administration property pages.

Database Subsystems pageUse the Database Subsystems property page to view the database assignments that link the RemoteWare Messaging subsystems, the Open Database Connectivity (ODBC) interface, and the external databases.

The Database Subsystems page appears whenever you start Messaging Administration. To display this page, click the Database Subsystems tab, or select Database Subsystems from the Pages menu.

Each RemoteWare subsystem appears on a separate line in the list box. These entries are for display only and the settings cannot be altered from this window or from the ODBC icon in Control Panel. If one or more of the database subsystems changes names, servers, or logins, then you must rerun RemoteWare Setup to recreate the necessary structures in the databases.


For each subsystem, the following information appears:

• Subsystem. A component in RemoteWare responsible for tracking or storing specific information. The four messaging subsystems are described in the following table.

• Assigned Database. The database name as defined in the database server. The assigned database value is set during RemoteWare Setup.

• Data Source. Displays the ODBC Data Source Name (DSN) as defined by double-clicking the ODBC icon in Control Panel. Typically, the administrator creates these data sources in ODBC’s System DSN (Data Source Name) window.

• Server Name. The name of the database server. Usually the database application takes its name from the database computer’s name, which is specified by double-clicking the Network icon in Control Panel.

• Login Name. The account name used to access the database server. The account name and password are set during RemoteWare Setup, and originate from the database server’s list of authorized users.

Table 64. Messaging subsystems

Subsystem name Function

Directory Stores user directory information, including user names, addresses, groups, and attributes. The Directory Manager application manipulates the Directory subsystem.

Incoming Queue Holds messages that arrive from Clients. The messages pass to the MTA for processing. Only the MTA has direct access to this subsystem.

Outgoing Queue Holds messages that have been processed by the MTA and are waiting to be sent to the Clients. Only the MTA has direct access to this subsystem.

Messaging Log Records historical and statistical information about the flow of messages through the RemoteWare Server. Use the Messaging Log in Log Viewer to display entries in the Messaging Log subsystem.

Important: Never change any database subsystem values while the RemoteWare Server is still active. To do so may cause serious damage to one or more of the messaging subsystems. To change settings, shut down the RemoteWare Server, alter the database settings from the database server or ODBC icon in Control Panel, and use RemoteWare Setup to reinstall and rebuild the Messaging Services databases.


Messaging Log pageUse the Messaging Log page to set limits for recording events in the Messaging Log database. The Messaging Log is both a view in Log Viewer and a database that records the processing and delivery of messages by the MTA.

To display the Messaging Log property page, click the Messaging Log tab, or select Messaging Log from the Pages menu.

The property page is divided into messages and recipients per message:


• Set the options for these stages of the messaging process:

• Message. Generates log entries related to the receipt of the message by the Server and its processing by the MTA. Choices are None (never generate a log entry), Errors Only (create entry for unsuccessful message receipt or processing), or All (record every message transaction).

• Recipients per Message. Generates a log entry for each message that has completed delivery to the recipients. Only one message is generated for each message, regardless of the number of recipients. Choices are None (never generate a log entry), Errors Only (create log entry for unsuccessful or partially successful messages), or All (log every message delivery).


Directory Synchronization pageUse the Directory Synchronization property page to specify when to synchronize the Server’s and Client’s address book. Synchronization reconciles the addressing and assignment information for each user in the Server and Client address directories. Messaging queues the updates for delivery to each Client and applies updates when the Client receives messages. The status of the synchronization operation appears in the Server Log.

To display the Directory Synchronization page, click the Directory Synchronization tab, or select Directory Synchronization from the Pages menu.

Under Set Directory Synchronization, use the following controls to set the conditions for initiating a synchronization operation:

• Check every n days. Specifies how many days to skip between synchronization operations. By default, this value is 3 days; it can range from 1 to 30 days. The Next Synchronization Starting Time field also influences the number of days.

The factors that determine how often to synchronize include the number of times Clients connect to the Server, the number of changes made to the user directory, the number of changes made to published items in RemoteWare Workshop or Subscriber, the Server’s activity level, and the number of defined users and Clients. One strategy is to synchronize at approximately the same interval that the majority of your Clients connect.


• Check Now. Initiates synchronization for all eligible users. Update records are queued for delivery to users when the Clients connect. Clicking this button also resets the Last Time Checked and Next Time to Check fields based on the Check Every n Days value.

• Next Synchronization Starting Time. Indicates the starting date and time for automatic synchronization. Click this button to change the date or 24-hour time.

The Status area displays the past and future dates and times when user addresses were synchronized. These two dates and times are available:

• Last Time Checked. Shows the date and time when synchronization was last run. The date/time format conforms with the settings in the Regional Settings in Control Panel.

• Next Time to Check. Displays the time and date when synchronization will occur based on the values specified under Set Directory Synchronization.


Non-Delivery Receipt pageUse the Non-Delivery Receipt property page to set the conditions for generating non-delivery receipts (NDRs). Non-delivery receipts occur when the MTA or Server cannot deliver a message to one or more recipients.

To access this page, click the Non-Delivery Receipt tab, or select Non-Delivery Receipt from the Pages menu.

On this page, use the following controls to specify parameters:

• Produce Non-Delivery Receipt if message has not been delivered to the Client in n Days. Controls how many days to hold an undelivered message in the outbound queue before it is deleted. By default, messages are held for 30 days; however, values in this field can range from 1 to 60 days. Select the number of days based on: • the size of your Outgoing Queue database • the number of messages received at the Server per day• how often Clients connect to pick up messages.

A smaller value may unnecessarily delete messages, but larger values may overflow your database with undeliverable messages waiting to be delivered.

Note: The starting date begins after the message is processed by the MTA and placed in the outgoing queue.


This value is not affected by the Check every n days field below. Messages are deleted based solely on this control’s value. Messaging generates an NDR for each deleted message.

Set Non-Delivery OptionsUse the controls in this area to specify the conditions for checking pending messages. Controls include:

• Check Every n Days. Determines how often to scan for deleted messages, collect NDRs, and deliver NDRs for messages whose processed date exceeds the time limit. The system checks every one (1) day by default; values can range from 1 to 30 days. Set this value to suit your requirements. If you prefer Clients receiving NDRs in bulk, use a large value. To deliver NDRs on a timely and regular basis, use a small value.

The Next Non-Delivery Receipt Starting Time field displays the actual scheduled date for an NDR check; in addition, Check Now resets the next time to check. The actual scheduled date and time for the previous and next scan also appear in the Status area.

• Check Now. Immediately collects and places NDRs in the outgoing queue for each originating user. The Server delivers messages to users when the Clients connect. This operation also resets the Next Time to Check value under Status.

• Next Non-Delivery Receipt Starting Time. Indicates the starting time for the next NDR check. Click this button to change the date or 24-hour time.

StatusThe Status area displays the dates and times when Non-Delivery Reports were collected and queued for user delivery.

• Last Time Checked. Shows the date and time of the last NDR check. The date/time format conforms with the settings in Control Panel (Regional Settings).

• Next Time to Check. Displays the next time and date an NDR check will occur based on the values under Set Non-Delivery Options.


Gateway Manager pageRemoteWare Gateway consists of software at the Exchange Server and RemoteWare Server computers. Its function is to exchange messages between the two messaging subsystems. The Gateway Manager page in the Messaging Administration program displays the current settings for the RemoteWare Gateway; use this page to set the available address types. You can also use the Gateway Manager page to view the settings and status of the messaging gateways that interact with the RemoteWare Server. A gateway is a set of programs that handles the exchange of messages between two messaging systems.

To display this page, click the Gateway Manager tab, or select Gateway Manager from the Pages menu.

Each registered gateway appears on a separate line in the list box. These entries are view-only; you cannot alter the settings on this page. If the gateway changes its name, type, or directory, then you must rerun RemoteWare Setup to recreate the necessary structures in the Gateway database. For each gateway, the following information is available:

• Name. Represents a gateway visible to RemoteWare and responsible for exchanging messages between RemoteWare and another messaging system.

• Type. Lists the message types supported by this gateway.

• Directory. Displays the gateway’s path name. This path is usually in UNC format.

• Description. Displays the description provided by the gateway.

• Status. Displays the operational status of the gateway.


RemoteWare Gateway detail windowOn the Gateway Manager page, double-click an item in the list to display the RemoteWare Gateway window.

The RemoteWare Gateway window contains these fields:

• Synchronized every n days. Determines the time interval (in days) between gateway synchronizations. Changing this value also changes the date and time in the Next Synchronization field. Unless both messaging systems experience constant user directory changes, you should try to perform changes in bulk. To minimize the amount of traffic generated by a gateway synchronization, perform as few synchronizations as possible, and then only after you make all the user directory changes.

• Sync Now. Not available for this version. Released version may not include this button.

• Next Synchronization. Displays the date and time of the next gateway synchronization.

The Gateway Type Configuration area determines which addressing types are available for the remote users defined in the Directory Manager program.

• Selected Type. Displays valid address types for remote users. The items in this box originate from the Address Type field in Directory Manager (remote user profile). The following table contains the valid address type values for the gateway.


• Type List. Lists all available address types. This list is not necessarily the list of all types supported by either messaging system. The following table contains the valid address type values for the gateway.

Table 65. Gateway address types

Message type Address type Message type Address type

3COM 3+ Open Mail MSA Microsoft Mail for Appletalk

ATT AT&T Mail MSN The Microsoft Network

CCMAIL Lotus CC:Mail MSPEER Microsoft MSPeer

COMPUSERVE Compuserve PROFS IBM PROFS

EX Microsoft Exchange RW RemoteWare

FAX FAX SMTP Internet Mail

MCI MCI Mail SNADS IBM SNADS

MHS Message Handling System

TELEX TELEX

MS Microsoft Mail for PC Networks

X400 X.400

X500 X.500

Note: The Extended Attributes area is reserved for future use. It lists any special modifiers applicable to this gateway.

P e r s o n a l F o l d e r s ( M e s s a g e S t o r e s e r v i c e ) 419

Personal Folders (Message Store service)On the Command menu, click MAPI Message Store Service to display the Personal Folders window. Use this window to maintain the attributes of MAPI’s Message Store (also known as Personal Folders). This window provides the same functionality as the RemoteWare profile in Control Panel Mail.

The General property page contains the following:

• Name. Displays the name of the information service. This name is used to identify the service within the profile. You can change it, if necessary.

• Path. Displays the current path and file name for the Personal Folder File (PST file). You cannot modify this value.

• Encryption. Displays the encryption options selected when the file was created. Options are: No Encryption, Compressible Encryption, and Best Encryption. If message security is not a great concern, select Compressible Encryption for a good balance between optimized data compression and good security during the transmission and in the message store.

• Change Password. Click to modify the password for RemoteWare’s Personal Folders file. Displays the Change Password dialog box. Options in this dialog box include:

• Old password. Supply the current password. Leave this field blank if this is the first time a password has been specified or if there is no current password.

• New password. Enter up to 15 characters to maintain privacy of electronic mail.

• Verify password. Re-enter the value in the New password field to avoid mistyping the new password.

• Save this password in your password list. Select this check box to save this password as an encrypted value in the password file. Saving the password avoids


having to repeatedly enter it each time you access messaging. Saved passwords are never stored, used, or transmitted as unencrypted values.

• Compact Now. Click to scan the Personal Folders file and remove empty spaces created when the MTA deletes messages. Perform this operation to decrease the size of the file, especially when heavy messaging activity occurs.

• Comment. Provide up to 256 characters of text to annotate this service.

P e r s o n a l A d d r e s s B o o k s e r v i c e 421

Personal Address Book serviceRemoteWare creates a (or uses an existing) Personal Address Book (the .PAB file) when RemoteWare Setup is run for the first time. Similar to the Client’s address books, it contains the settings that affect MAPI and RemoteWare.

On the Command menu, click MAPI Address Book Service to display the Personal Address Book window. This window provides the same functionality as the RemoteWare profile in Control Panel Mail.

The Personal Address Book property page contains the controls that affect MAPI and RemoteWare. The Notes property page accepts freeform comments to this PAB file, but the information is not used by any programs. Items on the Personal Address Book page include:

• Name. Defines the label for this address book. The default is Personal Address Book and appears under the appropriate service profile in Control Panel. Change this value to differentiate it from other address books in your system.

• Path. Specifies the path and file name for the Personal Address Book. These files typically use the .PAB extension. Click Browse to select another file, or type the full path and file name in the field.

• Show names by. Determines the order of presentation for the user names in the address book. Click the appropriate control to choose the user’s First name or the Last name as first in the naming order.

Note: If the address file is on a network (and not local to the computer), be certain to use UNC path names and avoid drive letters. A UNC path name (such as \\Machine1\Directory\File.pab) can always access the remote computer, even if the user logs out.

C H A P T E R

16

Directory Manager

Use Directory Manager to create and manage users and groups in the RemoteWare

network.


• “Directory Manager at a glance” on page 424


• “Directory Manager main window” on page 428


Directory Manager at a glanceDirectory Manager provides a user interface to the User Directory database, which contains the master copy of all users and groups in the RemoteWare system. It also provides a way to view synchronized users of messaging gateways that are accessible by RemoteWare. Messaging gateways are used to exchange messages between different mail or messaging systems.

Use Directory Manager to add, change, remove, and organize users into groups and distribution lists. After changes occur, a synchronizing process reconciles the Server and Client address book differences and distributes updates to all Clients.

Directory Manager consists of a main window divided into the user groups and user types in the left pane and assigned users for the item selected in the right pane. For information about starting or using the main window, see “Directory Manager main window” on page 428.

User group fundamentalsDefined user groups appear in the left pane under Groups. User groups serve two functions:

• A tool used by the administrator to organize one or more users that share a common trait. A user group is not visible to other users unless it is a distribution list.

• As a distribution list, a user group presents a collection of users in the address book that can be referred to as one item, rather than selecting each individual user. Once defined, a distribution list appears in every user’s address book.

When you install RemoteWare Messaging Services, RemoteWare creates the ALL user group. Although this group’s description can be changed, it is the only group that cannot be deleted or have its member list altered. The ALL group by default is a distribution list.

User fundamentalsA user consists of an individual’s or entity’s name and other information defined in the Directory Manager program. A user interacts, exchanges data, and communicates with RemoteWare and other users accessible to the RemoteWare network. Users are the basic operating unit for all RemoteWare Messaging Services, RemoteWare Workshop, and RemoteWare Subscriber transactions. This means Client users cannot exchange information with others unless it is through a user account. Clients cannot directly communicate to Clients using messages.

Use Directory Manager to create users and define their properties. Properties include

D i r e c t o r y M a n a g e r a t a g l a n c e 425

personalized information (such as name), addressing or Client assignment, group membership, and address type. For more information on these properties, see “Profile window (user)” on page 429.

Users are created as either local or remote users:

• Local Users. A local user resides on a RemoteWare Client and transacts its business using RemoteWare as its address type (that is, using RemoteWare Messaging Services as its transport). Local users rely on Clients as their base system to exchange messages and application data (such as RemoteWare Subscriber) with other users. They can also exchange messages with remote users if an appropriate gateway accesses another messaging system.

For additional information on assigning local users to Clients, see “Profile window (user)” on page 429.

The Local User option in the Profile window defines a local user. To exchange messages, a local user must be assigned to exactly one Client. However, a Client may have up to 100 local users assigned to it, although 25 users per Client is the recommended maximum. Assign local users to Clients in the Profile window. (For steps on assigning a Client, refer to the RemoteWare Server Administrator’s Guide.)

• Remote Users. A remote user represents a user or a destination external to the RemoteWare network. These users could be an Internet address or a user or system accessible through a gateway.

The Remote User option in the Profile window defines a remote user. Remote users do not have a Client assignment and therefore cannot use the RemoteWare applications based on your system. The Addressing Type value in the Profile window determines which gateway RemoteWare chooses to handle message exchanges with other gateway users. Each remote user has exactly one Addressing Type. For a list of valid options, see “Table 67. Gateway address types” on page 431.

Note: Do not use a RemoteWare address type for remote users. Although this configuration is permitted, it should not be used because remote users are always non-RemoteWare.


In the Messaging Administration program, the Gateway Manager page lists the gateways available to this RemoteWare system and which address types the gateway supports. For details, see “Gateway Manager page” on page 416.

User typesThe Users item in the left pane categorizes users by their user type (for Local or Remote Users), and by address type (for Remote Users). Users appear in the Gateway Users folder based on the value in their Addressing Type field.

• Local Users. Lists users defined as Local Users on the Profile page.

• Remote Users. Lists users defined as Remote Users on the Profile page.

• Gateway Users. Displays available gateways under this item in the left pane. Users are not directly assigned to gateways. Gateway items list users whose messages (the value in the Addressing Type field) can be processed by the gateway.

Note: The recommended maximum number of users for Directory Manager is 20,000. It will work with large numbers of users, provided the temporary database in SQL Server is large enough; however, its operation will be very slow. For example, for 70,000 users, it can take 45-60 seconds to display users when moving between user groups.

The records occupied by deleted users are not automatically removed from the Directory Manager table. This can cause the database table to reach its maximum, size of 32,000 records. To remove deleted records and reuse the space they occupy, use the GEN utility GENUSER to create a User ECF, drop the rows from the table, and then process the User ECF to repopulate the table. You should then perform both a Directory synchronization and a Gateway synchronization.


Menu commandsThe following table lists the commands specific to Directory Manager. Not included are the menu commands available to most RemoteWare Server programs. For a description of the general options, see “Menu commands common to most programs” on page 25.

You can combine filters as needed; each filter is cummulative of any filter already in use until you choose the Remove All Filters command.

Table 66. Directory Manager menu commands


File New User Displays the Profile window, where you create and define a new user.

New Group Creates a new user group and assigns users to it.

Edit Opens the Profile property page for the selected user or group. Permits viewing or changing properties.

Synchronize Client Directories

Manually starts the process that reconciles changes between the Server’s and Clients’ address books.

Filter by Client Displays users who are assigned to the Clients you select in the Select Clients window.

by Changed Users Shows only those users whose information has changed since the last synchronization. Users appear in the list as entries with bold type.

by Unchanged Users Lists users that are up to date.

by Synchronized Users

Displays users which receive and are included in the synchronization process, which occurs to update the address book.

by Unsynchronized Users

Shows only the users who do not receive address updates. The symbol appears to the left of these users in the main window. (This symbol also appears when the Include User in Address Books check box is not selected on a user’s Profile page.)

Remove All Filters Clears all filter settings and displays the entire user list.


Directory Manager main window

To start Directory Manager, double-click the Directory Manager icon in RemoteWare Menu (located in the All Utilities or Messaging Operations group). The main window displays user groups and users, which are organized by type.

The left pane contains the following items:

• Groups. Lists folders that contain collections of users defined by RemoteWare (for example, the ALL group) or the administrator. Use groups to treat multiple Clients as a unit, or as a distribution list in an address book. When you select a group in the left pane, its members appear in the right pane.

To collapse or expand the list of groups, click or , respectively. It is not possible to nest or embed groups into other groups.

• Users. Provides a list of users based on their type or the ability for a gateway to process the user’s address type.

When you select an item in the left pane, the right pane displays the following information:

• Group Members, Local Users, or Remote Users. Displays the number of users in the currently selected group. (This field appears in the top of the right pane, above the list box.)

Entries displayed in regular type are synchronized or up to date.Entries displayed in bold type have changes that are not yet synchronized with the Client.

D i r e c t o r y M a n a g e r m a i n w i n d o w 429

• Description. Provides a short description for the currently selected user group. The value originates from the Profile page in the user group’s Profile window. For details, see “Profile page (user group)” on page 436.

• Synchronization indicator. The symbol appears to the left of a user name if it is unsynchronized or if no Client is assigned to the user. Unsynchronized users do not receive address updates.

• Name. Lists a combination of the last name, first name, and middle initial values for a user description. The name fields are used in address books to identify the user; they originate in the user’s Profile window.

• Client Name. Displays the Client assigned to this user. Clients are defined in the Client Profile program, and they may have one or more user assignments. Once assigned, a user must always log in from the same Client. Remote users do not have a Client assignment.

• Address Type. Defines which messaging transport to use for this user. RW represents the RemoteWare transport, but other transports may be used to exchange messages between non-RemoteWare systems. For more information on address types, see “Profile page (user)” on page 430.

• Address. Lists the name or label the user provides when logging into the RemoteWare services at the Client. The address is also a unique identifier for the user within an address type.

Profile window (user) This section describes the Profile window for individual users. For information about the Profile window for user groups, see “Profile window (user group)” on page 436.

To create and edit individual user definitions, use the Profile window. This window contains four property pages. You can reach a user’s profile window by:

• Creating a new user. In the Directory Manager main window, click New User, or select New User from the File menu.

• Copying or editing an existing user. On the File menu, click Edit, or double-click a user in the right pane.

At the bottom of the user’s Profile window, these controls are available for every property page:

• OK. Updates the user definition and closes the Profile window.

• Cancel. Closes this window and discards any changes. A message box appears, asking to confirm that you want to discard changes.

• Apply. Accepts changes on this page and updates the database. (Does not close the Profile window. To close the window, click OK.)

• Help. Displays context sensitive Help for the Profile window.


Profile page (user)When creating or editing a user definition, use the Profile page to set the user type, name, password, login name, and assigned Client or address type. It is the first page in the Profile window, and the first page that appears when you create a new user.

To view this page, double-click a user in the right pane of the main window. If you’re viewing another page in the Profile window, click the Profile tab.

The top area of the page displays the type of operation you are performing on this user, such as Update User, Add User to Directory, or Copy this User. Other controls are:

• Local User. Creates a user on a RemoteWare Client. When you select this option, you must fill out the information in the Client area to enable the user.

• Remote User. Creates a definition for a user or system external to the RemoteWare network. Remote users do not use a Client in this system. The Address Type determines which gateway handles the messages for this user.

• First Name. (Optional) Displays the user’s first name.

• MI. (Optional) Displays the user’s middle initial.

• Last Name. Displays the user’s last name. If the user is a company or other entity, place the name here instead of in the First Name field; the user list sorts alphabetically by last name.

A value in the Last Name field is required, but does not have to be unique.

Note: To accept any changes you make on the Profile page, you must click Apply or OK before exiting or moving to another page.


• Address/Client Login. Shows the value that uniquely represents this user and its messages or actions to the RemoteWare system. A local user types this value each time he or she accesses RemoteWare from a Client. Therefore, consider making the login easy to type and remember.

For remote users, provide a fully qualified address, such as [email protected] for Internet destinations, or EXCH:Sonia.Wu@CRPXCHG3 for Exchange Gateway destinations.

• Include User in Address Books. Prevents or allows the Server to update this user with changes to the address list. When you select this check box, updates to the address book are queued for the user and sent when the Client connects.

Select this option whenever a local user is enabled and assigned to a Client. Clear the check box for remote users who should not appear in the user’s address book, when the user is not assigned to a Client, or when the Client is not currently active.

Do not use a RemoteWare address type for remote users. Although this configuration is permitted, it should not be used because remote users are always non-RemoteWare.

• Address Type. For remote users, specifies the transport method for message exchange. Click the arrow and select a value in the list provided. The following table lists the possible address types; however, the types available on your system may differ depending on the gateway’s ability to process address types.

Note: The following characters in Exchange Server mailbox names or addresses are not supported by RemoteWare Gateway Synchronization: tilde “~”, vertical bar “|”, and comma “,”.

Table 67. Gateway address types

Message type Address type Message type Address type

3COM 3+ Open Mail MSA Microsoft Mail for Appletalk

ATT AT&T Mail MSN The Microsoft Network

CCMAIL Lotus CC:Mail MSPEER Microsoft MSPeer

COMPUSERVE Compuserve PROFS IBM PROFS

EX Microsoft Exchange RW RemoteWare

FAX FAX SMTP Internet Mail

MCI MCI Mail SNADS IBM SNADS

MHS Message Handling System

TELEX TELEX

MS Microsoft Mail for PC Networks

X400 X.400

X500 X.500


• Client. This area contains settings which apply to a Local User. Client values are not available for Remote Users. The fields in the Client area are:

• Enabled. Select this check box to assign a RemoteWare Client to this user. Clear the check box to disable this user and clear the Client assignment. If the term <NOT SET> is visible, then this user has not been assigned to a Client. When you select this check box and click the corresponding button, the Select Client window appears.

Select one Client in the list and click OK to accept the choice. The Client name appears in the field below the Enabled check box. Use the Client Profile program to create or modify a Client if no existing definitions are appropriate for this user.

• Password. Enter up to 19 characters for the default user password. The user enters this password along with the Address/Client Login to access RemoteWare applications at the Client. This password is not the same as the Client password in Client Profile.


Groups page

This page is similar to the Members page for a user group. For details, see “Members page (user group)” on page 438.

Use the Groups property page to add, remove, or display the groups that include this user as a member. To view this page, click the Groups tab in the Profile window. (For instructions on accessing this window, see “Profile window (user)” on page 429.)

The list box contains the names of each user group which includes this user as a member. Under the list box are the following controls:

• Assign. Adds one or more user groups to this user. When you click Assign, the Select User Groups window appears.

Select one or more user groups in the list and click OK. You can click All User Groups to automatically select and assign this user to all defined user groups.

• Unassign. Removes this user from the selected user group. No warning occurs before removing this user group entry from the Groups page. To reverse an inadvertent unassignment, select the group and click Assign.


• Unassign All. Removes the user from every assigned user group. A message box appears, asking to confirm that you want to complete this operation.

Applications pageUse the Applications property page to assign any Application work object defined in the Work Object Editor program. Application objects include RemoteWare Workshop, Subscriber, as well as objects you define. To display this page, click the Applications tab after opening the Profile window for a user.

The list box contains the name of each Application work object assigned to this user. Under the list box are the following controls:

• Assign. Displays the Select Application Objects window, which lists all Application work objects available to the user. To assign one or more Application objects, select them in the list and click OK. To assign all available objects, click All App Objects.


• Unassign. Removes the selected application from the list box on the Applications page. No warning occurs before removing the application. To reverse an inadvertent unassignment, click Assign.

• Unassign All. Removes every application assignment from this user. A message box appears, asking you to confirm that you want to complete this operation.

Attributes pageUse the Attributes property page to define a set of user specific attributes and corresponding fixed values. Attributes are a constant name and value pair and are used by RemoteWare Workshop and RemoteWare Subscriber at the Client.

To display this page, open the Profile window for a user and click the Attributes tab.

The list box displays the user’s defined attributes in the order they were created. For each attribute, the following information appears:

• Attribute Name. Displays the label for the attribute. The name must be unique and can contain up to 25 characters.

• Value. Lists the text or number assigned to the attribute name. The Value is substituted for the attribute name whenever the name is used at the Client. This field can contain up to 254 characters.

Note: Attributes cannot contain user-defined, environment, or system variables; also, the attribute name must be unique.


To modify the attributes list, use the following controls:

• Add. Displays the Edit Attribute dialog box, where you create a new attribute. In the text boxes provided, specify an attribute Name and Value. Click OK to add the attribute to the Attributes property page.

• Edit. Opens the Edit Attribute window for the selected attribute. Make changes in the window, then click OK to update the entry.

• Remove. Permanently deletes the selected attribute from the Attributes page. No warning occurs when you click this button.

Profile window (user group) This section describes the Profile window for user groups. For information about the Profile window for individual users, see “Profile window (user)” on page 429.

To view, create, and modify user groups, use the Profile window and its property pages. The Profile and Members pages contain all the information for a user group. Display the Profile window for a user group by:

• Creating a new group. In the Directory Manager main window, click New Group, or select New Group from the File menu.

• Copying or editing an existing user group. On the File menu, click Copy or Edit. You can also double-click the user group entry.

At the bottom of the user group’s Profile window, these controls are available for every property page:

• OK. Updates the user group and closes the Profile window. (Similar to Apply, but also closes the window.)

• Cancel. Closes this window and discards any changes. A message box appears, asking to confirm that you want to discard changes.

• Apply. Accepts changes on this page and updates the database. (Does not close the Profile window. To close the window, click OK.)

• Help. Displays context sensitive Help for the Profile window.

Profile page (user group)When creating, copying or editing a user group, use the Profile page to set the group name, description, and distribution status. It is the first page in the Profile window, and the first page that appears when you create a new group.

To view this page, double-click a user group in the Directory Manager main window. If


you’re viewing another page in the Profile window, click the Profile tab.

The top area of the page indicates the type of operation you are performing on this user group, such as Update Group, Add Group to Directory, and Copy Group Item. Other fields are:

• Group. The name of the user group. This name appears under Groups in the left pane of the main window. The group name is required and must be unique. In the text box, enter from 1 to 15 characters to specify the name for this group.

• Description. An optional area for providing a longer description of the group. This value can range from 0 to 149 characters.

• Distribution List. Determines whether this group is used as a distribution list. Select this check box to allow Client users to view the user group in the address book and use the group to send messages to member users. Clear this check box to prevent the group from being visible at the Client; instead, the user group serves as an organizing tool for Server administration.

Note: To accept any changes you make on the Profile page, you must click Apply or OK before exiting or moving to another page.


Members page (user group)

This page is similar to the Groups page for an individual user. For details, see “Groups page” on page 433.

Use the Members property page to add, remove, or display the users in the selected user group. To view this page, open the Profile window for a user group and click the Members tab.

The list box contains the names of each user in this group. Under the list box are the following controls:

• Assign. Displays the Select Users window, where you can select one or more users to add to this user group.

Select one or more users in the list and click OK. To assign all defined users to this user group, click All Users. Click Item Detail to display the User Information window for the first selected user.

• Unassign. Removes the selected user from the current user group. No warning occurs before removing this user from the Members page.


• Unassign All. Removes every assigned user from this user group. A message box appears, asking you to confirm this operation.

Applications page (user group)Use the Applications property page to view, assign, or remove Application work objects from a user group. To view this page, click the Applications tab when the Profile window is visible for a user group.

The list box displays the Application work objects assigned to each user in this group. Under the list box are the controls which add and remove application objects from this user group. The buttons are identical to those on a user’s Applications page; for details, see “Applications page” on page 434.

Note: Actions on this page can also be accomplished from the Work Object Editor program.

A P P E N D I X

A

Events

Events are RemoteWare commands used to instruct the Server on how to complete

tasks on the Server and the Client. Worklist and ESD work objects use events to

perform actions during a communications session.

This appendix includes:

• “Event types” on page 442

• “Event Details window” on page 446

• “Event specific fields” on page 447

• “Optimizing event execution” on page 459

• “Event properties” on page 466


Event typesEvents are added and modified in the Work Object Editor or Worklist Editor through the Event Details window.

The events in the following table are part of five major event categories. These categories make up the Add Events menu item on the Work Object Editor’s Events property page and in the Worklist Editor.

• File Transfer. Events that perform file exchanges between the Client and the Server. The File Transfer Log provides information about the execution of File Transfer events.

• Operating System. Events that execute system commands, such as DIR or COPY, on either the Server or the Client. You can find information about the execution of operating system events in the Session Log and in the reports generated in Report Manager.

• Session Control. Events that control how the Server progresses through the list of events. Includes conditional statements, events that set and test variables, and events that test Client inclusion in groups. Information about the execution of events and sessions can be found in the various RemoteWare logs and in Report Manager.

• Server. Events specific to the Server. Used to process external event files, set alarms, contact other RemoteWare servers via named pipes, and exchange message queues. Report Manager and the various RemoteWare logs provide information about the execution of Server events.

• Scripting. Scripting events specific to the Server or Client. Scripting enables the RemoteWare administrator to call and execute custom scripts from a worklist. Supported scripts are VBScript and JScript. Client script events are supported only for Windows Clients.

The following table lists events as they appear on the Add Events menu in Worklist Editor and Work Object Editor.

Table 68. Event types and descriptions All events are valid for Worklist objects; events marked with an asterisk * are valid for ESD objects;

events marked with a dagger † are valid for Multicast work objects.

Event type Events Description Page

File Transfer GET file(s) from Client Retrieves Client files and puts them on the Server.

506

E v e n t t y p e s 443

*† SEND file(s) to Client Transfers file(s) from Server to Client.

543

* CHECK SEND file(s) to Client

Compares a file’s time stamp and size. If it does not exist or is out-of-date, transfers the file from Server to Client.

479

Operating System

APPEND file(s) to another Combines one or more files. 466

ASCII APPEND file(s) to another

Combines one or more text files. 469

CHECK DISK Retrieves storage characteristics for a disk drive.

475

* CHECK file Compares file time stamp and size.

477

COPY file(s) Duplicates files on the same computer.

482

† DELETE file(s) Removes files from a computer. 486

DIRectory listing Creates a list of directories and files and places it in a text file.

495

† EXECUTE program Runs an application. 503

SET file ATTRIButes Changes a Windows/DOS or UNIX file’s attributes.

548

get FILE STATUS Determines if a file exists. 509

* MAKE DIRectory Creates a new directory. 522

REBOOT Client at end of session

Reboots DOS or Windows Clients after the communication session ends.

531

REMOVE DIRectory Deletes an empty directory. 534

RENAME file(s) Changes file names on the same computer.

536

SET Client TIME Synchronizes the time based on Server time and timezone.

547

WAIT for file to exist Pauses until file appears; continues if the specified wait time is exceeded.

564

Table 68. Event types and descriptions (Continued) All events are valid for Worklist objects; events marked with an asterisk * are valid for ESD objects;




CREATE REGISTRY KEY Creates a key in the registry. 484

DELETE REGISTRY KEY Deletes a key from the registry. 491

GET REGISTRY VALUE Gets a value from the registry and places it into a worklist variable.

511

SET REGISTRY VALUE Sets a value in the registry to a specified string.

550

DELETE REGISTRY VALUE

Deletes a value from the registry.

493

Session Control * COMMENT Includes a non-executable remark.

481

ELSE IF Begins an alternate case of events.

497

END IF Ends an IF or ELSE IF block of events.

497

begin QUOTA block Defines the time or number of bytes allocated to a block of segmented-delivery File Transfer events.

471

END QUOTA block Ends a QUOTA block. 498

END REPEAT Ends a REPeat block. 498

END SESSION Stops a session and ends communication.

499

END WORK OBJect Stops executing an object and continues with next.

500

IF Executes an event based on conditional logic.

515

REPeat IF previous event FALSE

Repeatedly runs events when the previous event is false.

538

REPeat IF previous event TRUE

Repeatedly runs events when the previous event is true.

538

SET VARiable Defines variables for this object. 552

READ INI FILE Reads a value from a variable file and places the value into a worklist variable.

529




E v e n t t y p e s 445

WRITE INI FILE Writes the specified value(s) to an .ini file and places these value(s) into a user-defined variable.

566

DELETE INI FILE Deletes a value from an .ini file. 488

TEST VARiable Compares variables and text. 558

TEST if Client is in GROUP Determines if a Client is a member of a group.

556

Server EXCEPTION worklist Executes events in an event file when a session fails.

502

NOTIFY nt server Sends a message to a RemoteWare server.

525

USER defined ALARM Displays a user alarm in the Server Log.

562

insert WORKLIST Executes events in an event file. 518

MESSAGE EXCHANGE Exchanges message queues on the Client and Server.

524

UNASSIGN from client Unassigns a work object or session from a Client.

560

Scripting LOAD SCRIPT file Loads, parses, and executes script files. (Windows Clients only)

520

SET VARiable in SCRIPT Sets a global variable in the script. (Windows Clients only)

554

GET VARiable from SCRIPT

Retrieves the value of a global script variable. (Windows Clients only)

513

RUN SCRIPT FUNCTION Invokes specific scripting functions provided by the RemoteWare administrator. (Windows Clients only)

541

RELEASE SCRIPT Releases a specific instance of a script engine. (Windows Clients only)

532





Event Details window For more information, see “Events property page” on page 196.

In Work Object Editor, both the Events property page and the Add Events menu provide the controls to view and manipulate events. In Worklist Editor, you can also use the Add Events menu and the main window to create and edit events.

Almost every event has a detail window, and the options and fields available vary from event to event. The following table presents an overview of each area in the window. Later sections in this chapter describe each area in detail.

Table 69. Event Details window areas

Area name Description

Event specific fields The top area of the window displays text and controls used to define file names, directories, disks, comments, Server commands, application names, times, and messages. The fields and controls in this area vary depending on the event. For more information, see “Event specific fields” on page 447.

Options Influences various event characteristics. These controls appear for all events, but those that do not pertain to the event are unavailable. For additional information, see “Options area” on page 454.

Note: The Retry, True, and False options become available once the Critical Event and Conditional options are selected.

Execute Determines when and where this event executes. Choices are sometimes limited depending on the scope or function of the event. For details, see “Execute area” on page 458.Note: The On Client option is only available for During events.

E v e n t s p e c i f i c f i e l d s 447

Event specific fieldsSome events use the top area of the Event Details window to enter drive letters, directory names, file names, comments, commands, variables, Client groups, and timing information. This section covers the formatting and general usage of these fields. The specific fields available for each event are described later in this appendix.

VariablesIn events, variables are placeholders for different event parameters. The Server replaces the variable placeholders with the appropriate information when the event executes. Variables are always enclosed in “<>” characters and are not case sensitive; for example, <time> is the same as <Time>.

The following table describes the three types of variables and gives an example of each. Later sections discuss each variable type, the variables available, and their usage.

Predefined variablesRemoteWare includes a set of predefined variables for inserting the current time or date, Client information, or Server information. The following table lists every variable.

Table 70. Variable types and examples

Type Format Example Description

Predefined <variable> <time> Defined by RemoteWare; valid at all times. For a list of these variables, see “Predefined variables” on page 447.

User defined <%variable> <%MyVar> Created in a work object; valid in session once defined. For more information, see “User-defined variables” on page 450.

Environment <$variable> <$TMP> Created in Control Panel System; valid at all times. For details, see “Environment variables” on page 451.

Table 71. Predefined variables

Variable Example and Description Returned Value

<ClientBin> FILE STATUS <ClientBin>\Rwncomm.logRefers to the <ClientInstall>\nodesys directory at the Client. Does not include the drive letter.

\Program Files\ Remote\NodeSys


<ClientESD> SEND C:\service.dat TO <ClientESD>\Refers to the <ClientInstall>\nodesys\updates directory at the Client.

C:\Program Files\ Remote\NodeSys\ Updates

<ClientHome> GET <ClientHome>\ FROM D:\Sales\ Saledata.dat Server directory where Client-specific files reside. Resolves to the \NODE\<ClientName> directory.

C:\RWS\node\Andover

<ClientInstall> WAIT <ClientInstall>\Now.flg :05 Refers to the Path defined on the Client Profile General property page.

C:\ProgramFiles\ Remote

<ClientName> DELETE C:\Files\<ClientName>.dbf Replaces the variable with the Client’s name.

ANDOVER

<d> ASCII APPEND C:\Sales\Day<d>.txt TO C:\Sales\Daylog.txt Day of the month (00 to 31).

06

<dw> MAKE DIR F:\Week<dw> Day of the week (1 to 7).

2

<dy> EXECUTE C:\Windows\Bin\Dateset -d <dy> Day of the year (001 to 366).

241

<Date> GET <ServerData>\SALES<Date>\ <ClientName>.rpt FROM C:\Daysales.rpt Replaces the variable with the numerical month, day, and year in the form mmddyy.

060808

<GetFilesAttempted> USER ALARM Total: <GetFilesAttempted> Total number of files which were attempted during the current session.

12

<GetFilesFailed> USER ALARM Total: <GetFilesFailed>Total number of files for which send failed during the current session.

2

<GetFilesSuccessful> USER ALARM Total: <GetFilesSuccessful>Total number of files which were successfully sent during the current session.

10

<hh> USER ALARM Schedule complete at <hh>:<mm>:<ss>. Current 24-hour value on Server (00 to 23).

17

<m> DELETE C:\Prices\Prices<m>.dat Numerical month (01 to 12).

03

Table 71. Predefined variables (Continued)



<mm> USER ALARM Client <ClientName> connected at <mm> after the hour. Current minutes value at Server (00 to 59).

58

<SendFilesAttempted> USER ALARM Total: <SendFilesAttempted> Total number of files which were attempted for the current session.

13

<SendFilesFailed> USER ALARM Total: <SendFilesFailed>Total number of files for which send failed for the current session.

1

<SendFilesSuccessful> USER ALARM Total: <SendFilesSuccessful>Total number of files which were successfully sent for the current session.

12

<Serial#> DIR X:\Srvr\Dir.txt FROM C:\Client\<Serial#>Inserts the Server or cluster’s Serial Number.

25

<Server> USER ALARM <Server> is down.Refers to the Server currently processing this session.

Perfect40

<ServerData> GET <ServerData>\Sttb.txt FROM “D:\Client\ Sttb.txt”Inserts the System Data Path value from the Server Profile Information page.

C:\RWS

<ServerExecution> EXECUTE <ServerExecution>\System\ Genall.exe Genfile.ecfInserts the System Execution Path value from the Server Profile Information page.

C:\RWS

<Session_Origin> GET <ServerData>\<Session_Origin>\*.* FROM C:\Xfer\Indicates which computer originated the session. Either Inbound or Outbound.

Inbound

<ss> COPY D:\Begin.flg D:\Begin<ss>.flgCurrent seconds value at Server (00 to 59).

56

<Time> RENAME C:\Done.flg TO <ClientBin>\ <Time>.flgInserts the current Server’s 24-hour time in the form hhmmss.

010634




User-defined variables

Because of the optimized nature of ESD objects, the values in user defined variables are not preserved across Pre-, Post-, and ESD worklist sections.

The SET VARiable event creates custom placeholders for any event that can use variables. A user defined variable can be identified by the form <%VariableName>. Every work object in a session has access to the variable once it has been defined. As a result, user defined variables can be used as parameters to another worklist in the same session. User defined variables cannot be used across sessions.

For information on how to create user defined variables, see “SET VARiable” on page 552.

<WindowsDir> DIR C:\Dirtext\<ClientName>.txt FROM <WindowsDir>\*.bmpFully qualified (including drive letter) Windows directory for Windows based Clients. Since the Client reports this value, it may not be available for On Server events.

C:\Windows

<WindowsSysDir> EXECUTE <WindowsSysDir>\Mviewer2.exeReturns the fully qualified (including drive letter) Windows system directory.

C:\Windows\System32

<WindowsESD> COPY <WindowsESD>\Info.doc TO D:\Winapps\Info.docTemporary storage for files destined for the \windows directory.

C:\Program Files\Remote\Nodesys\WinESD

<WindowsSysESD> DELETE <WindowsSysESD>\Rio_433.fon Temporary storage for files destined for the \windows\system32 directory.

C:\Program Files\Remote\Nodesys\WinESD\System32

<y> ASCII APPEND C:\Daily.log TO C:\Archive\ Year<y>.logNumeric year (00 to 99).

08

<y1> RENAME C:\Date.fil TO C:\Date<y1>.filNumeric one digit year (0 to 9).

8

<y4> RENAME C:\date.file TO C:\Date<y4>.filNumeric four digit year.

2008



Note: Session variables can contain up to 255 characters. If a resolved user-defined variable exceeds 255 characters, the resulting variable may be truncated.


Environment variablesYou can also use environment variables as placeholders in event text. To be recognized by the Server, these environment variables must be defined in Control Panel. (To do this, open Control Panel. Double-click the System icon and use the System Environment Variables box.) For example, if a line in the System Environment Variables box defines the variable SessionHome=Z:\RemoteWare\Sessions, the event to copy a file to this directory would be:

COPY C:\Temp\File1.dat TO <$SessionHome>\File1.dat

Literal stringsIn the top area of the Event Details window, use literal strings to include a space or other reserved character in a file or path name. Examples of reserved characters are the backslash “\” directory symbol and wildcard characters. Characters in a literal string pass unchanged and uninterpreted to the destination operating environment. To specify a literal string, enclose the path and file name in (“ ”) double quotes. The double quote prevents the Server from adding the default drive or path and allows you to use reserved characters.

It is possible to use any type of variable in a literal string. The Server substitutes the actual variable value when the event runs; the variable name will not be sent as part of the literal string. For example, typing:

GET FILE “\<ClientName>\Sales results” FROM “\<%SALES>\Sale*orders.dat”

will substitute the Client’s name for <ClientName> and the defined value for the SALES user defined variable.

Wildcard charactersWildcards are reserved characters, and you use them to carry out a task on multiple files with similar names or extensions. Instead of individually selecting many files or directories, you can use a wildcard to reference these files or directories as a group. The wildcard characters in events are identical to those used in the Interactive Session program, but different from those used to select items in list boxes. Wildcard characters in RemoteWare have the same behavior as those in the DOS and Windows operating environments.

The ? (question mark) and * (asterisk) are two reserved characters used as wildcards for directory and file names. Use ? to represent a single character that a group of files or directories has in common. The * represents one or more characters that files or directories have in common. The following table lists the events that support the use of wildcard characters and presents examples of how to use wildcards to specify event parameters. For more detailed information about wildcard usage in specific events,


refer to the appropriate sections later in this chapter.

Using wildcards with the RENAME, COPY, SEND, CHECK SEND, and GET events requires the event to be in one of two formats listed in the following table.

Table 72. Examples of events with wildcards

Example Description

APPEND C:\???.log TO C:\Allfiles.log

Locates all .log files in the root of the C drive with three or less characters and appends them to C:\allfiles.log.

ASCIIAPPEND <ServerData>\EC403\U*.* TO <ServerData>\ECTotals\Usage<d>.log

Concatenates one or more files that begin with the same letter to a destination file using a variable.

CHECK SEND FILE C:\Test*.txt D:\Test*.txt D:\Dir

Compares one or more files that begin with the word TEST and have the .txt extension and sends the files to the specified directory on the Client if the files differ.

CD COPY D:\*.doc D:\ Copies one or more Client files to the same directory without changing their file names.

DELETE sales??.* Removes all files beginning with the word SALES and having two or less characters at the end of the name, regardless of the extension.

DIR <ServerData>\Dir.txt FROM a* Finds all Client directories that begin with the letter “a” and places the results on the Server file dir.txt.

D GET “F:\File storage\” FROM C:\Oldfiles\*.dat

Locates all files in a directory with the .dat extension and transfers them to a Server directory.

RENAME C:\*.dat TO D:\Data\*.old Renames all .dat files and places them in another directory.

D SEND <ServerData>\Indo\*.dat TO C:\Data\*.dbf

Sends all .dat files in a Server directory to a Client directory, changing the extension to .dbf.

Note: If an event that uses wildcards fails for one file, the remaining matching files are skipped and the Server goes to the next event.

Table 73. Wildcards and file manipulation events

Parameters Example

Event SourceWildcard DestinationWildcard RENAME C:\*.txt TO C:\*.wri

Event SourceWildcard DestinationDirectory COPY E:\*.* TO D:\Folder


If the first parameter is a wildcard character but the second parameter is not, then the second parameter is assumed to be a directory.

Directory and file namesAs a basis, events use the standard DOS conventions for referencing drive, directory, and file names. Clients or Servers using Windows can also use Universal Naming Convention (UNC) paths, such as \\ServerName\Dir\SubDir\File. You can use file and directory names, drive letters, and server volumes on operating systems where they are valid.

All events use the following default paths and drives when no drive or path is specified:

• Server default path <ServerData>\. The predefined variable <ServerData> is a placeholder for the Server’s System Data Path as defined on the Server Profile Information page. (For details, see “Information property page” on page 70.) If you do not specify an explicit directory, then the <ServerData> directory is used to store retrieved Client files and run worklists for the EXCEPTION worklists and insert WORKLIST events.

The default path is also added before any partial file path that has no leading backslash. For example, Sales\Monday.doc will be <ServerData>\Sales\Monday.doc.

• Client default path <ClientInstall>\. This variable is set from the Default Drive and Path field on the Client Profile General page. (For details, see “General property page” on page 135.) Not specifying a Client directory causes any file or directory based operation to reference the <ClientInstall> directory.

The event also includes the default path before a file path with no leading backslash. For example, Training\Agenda.doc becomes <ClientInstall>\Training\Agenda.doc.


Options area For more information about this window, see “Event Details window” on page 446.

In the Event Details window, the Options check boxes determine the circumstances under which events execute. Not all options are available for all events; unavailable options appear dimmed and cannot be selected.

Options include:

• Byte Level Differencing. This feature detects differences between file versions at the Server and the Client and sends only the differences to the Client or Server, which reduces the time required to update files and software. Byte Level Differencing is available for the SEND and GET events in the Work Object Editor and Worklist Editor.

Byte Level Differencing is supported only on Windows and Linux Clients.

• Xpress Transfer. Speeds up the transfer of the SEND and GET events by removing all packet and window sizing, along with the RemoteWare protocol. This option takes advantage of the reliability of TCP/IP and disregards any Quota Block events.

Xpress Transfer is supported only on Windows and Linux Clients. It is a valid option for sessions using TCP/IP. Xpress Transfer is not available for Interactive Session or Worklist ECFs.

• Do not overwrite. Will not copy over an existing file if the source file name matches that of the destination file.

• Safe transfer. Does not create a destination file until it has been successfully transferred. Instructs the Server to use a hidden, temporary file until the file transfer is complete. Once complete, the Server renames the temporary file to the destination filename. For unsuccessful transfers, the temporary file remains hidden so the transfer can continue from the point of failure if a retry is executed. Selecting Safe transfer ensures that no corruption occurs as a result of an incomplete file transfer. This feature is also called checkpoint restart.

Safe transfer option processing for GET files, APPEND files, and ASCII APPEND files events ensures that the event uses a unique temporary file name and a valid character set for the file server in use. RemoteWare implements two registry keys for the safe transfer option with these events to control the naming of temporary files for Windows and Novell file servers. See “File server considerations for “safe transfer” processing” on page 456 for important implementation information.

• Check updates only. Instructs the Server to transfer only files with different sizes or dates.


• Check if newer. Transfers a file only if the source file has a more recent date and time stamp than the destination file.

The Delete after (-) option is similar to moving a file, or cutting and pasting an item.

• Delete after (-). Deletes the source file after it has been transferred.

• Turn compression off. Does not use data compression when transferring files during this event. Select this check box for files that are already compressed or do not compress well.

• Not required for successful session. Indicates that this event does not have to be executed successfully for the session to be logged as Successful. Sessions are logged as Successful when every event was processed without failure. Completed sessions process all events in the session, but individual events may have failed.

• Work Object Critical event (+). Ends the work object if this event fails. A failure is an event that executes but cannot be successfully finished. Events that do not execute because of conditional options are not considered failures and do not terminate the session. When this option is selected, the Critical event option is disabled.

A critical event that fails prevents any remaining events that have the same execute time value—Before, During, or After—from executing. However, work object events that have a different execute time value can still execute. For example, a critical During event that fails prevents any remaining During events from executing, but remaining After events can still execute.

• Critical event (*). Ends the session if this event fails. A failure is an event that executes but cannot be successfully finished. Events that do not execute because of conditional options are not considered failures and do not terminate the session. For example, a Critical GET file event that did not execute because of the Send Updates ONLY option results in a status of “no execute,” not “failed.”

• Retry. (Available when Critical event is selected.) If the session has retries enabled, then a critical failure causes the session to be retried. The retry attempts to restart the session at this event.

• Conditional - True (&). Only executes the event if the previously executed event was successful.

• Conditional - False (|). Executes this event only if the previous event failed or was a “no-execute.”

• Make Destination Path. Establishes a destination path for the event and creates directories when necessary.

• Recursive. Includes subdirectories with the event.


File server considerations for “safe transfer” processing Safe transfer option processing for GET files, APPEND files, and ASCII APPEND files events ensures that the event uses a unique temporary file name and a valid character set for the file server in use.

RemoteWare implements two registry keys to control the naming of temporary files. File server considerations for meeting the RemoteWare requirements for safe transfer processing varies for Windows and Novell file servers.

Key: TempFileNameTableThis key is optional. The key’s default value is implicit in RemoteWare operations if you do not create the key. The key is required if you want to use a non-default value.

RemoteWare uses the TempFileNameTable key to define the character set to use for creating temporary file names. Use this key to ensure that the characters that RemoteWare uses for temporary file names during safe transfer processing are valid for the associated file server.

The length of the resulting temporary file name is the same as the source file name length.

• Key location — HKLM\RemoteWare\Server

• Name — TempFileNameTable

• Type — REG_DWORD

• Data • 0 — Default. Character set for Windows file servers. • 1 — Character set for Novell file servers.

Key: TempFileNamePrefix This key is optional and is used only if you create it in your RemoteWare Server’s registry. Using this key overrides the character mapping implemented by the TempFileNameTable key. It is recommended that you use this key for RemoteWare environments that use Novell file servers.

RemoteWare uses the TempFileNamePrefix to define a file name prefix to use when creating temporary files during safe transfer processing for events that execute “On Server”. You must ensure that the characters are valid for the operating system on both the RemoteWare Server and the file server.

The length of the resulting temporary file name is the length of the prefix concatenated with the source file name length.

• Key location — HKLM\RemoteWare\Server


• Name — TempFileNamePrefix

• Type — REG_SZ

• Data — Define your own prefix. Maximum of 7 characters. Exceeding the maximum causes RemoteWare to revert to using the character mapping implemented by the TempFileNameTable key.

Key use example: Setting the value to “~” would create the temporary file for the file “filename.txt” as “~filename.txt”, and then rename the file back to “filename.txt” when the transfer is complete.


Execute area For more information about this window, see “Event Details window” on page 446.

In the Event Details window, use the controls under Execute to specify when and where the event will occur. Exactly one choice exists for the time (Before, During, or After) and location (On Server or On Client) for each event.

The following table describes how events execute and which are necessary for specific events or session types.

Table 74. Execute options

Option Description Example of use

Before Executes this event before starting the communications session with the Client.

Process Only sessions require all events to be Before events; otherwise, they are ignored. For other session types, Before events can minimize connect time by completing operations that are not dependent on the Client.

During Runs the event while connected to a Client.

Select this option for file transfer events. Also, you must select During for events that execute On Client.

After Executes the event after the Client has disconnected.

Select this option to shorten the connect time while processing events that no longer require a connected Client, such as maintenance or data processing events.

On Server Runs the event on the Server. Select this option for Operating System events that are relevant on both the Client and the Server.

On Client Runs the event on the Client. Select this option for Operating System events that are relevant on both the Client and the Server.

O p t i m i z i n g e v e n t e x e c u t i o n 459

Optimizing event executionAlthough your worklists may be functional, you may want to fine tune them to increase resource efficiency and decrease completion time. This section describes methods to optimize worklists and ESD lists and to reduce connect time between the Server and a Client. The three classes of optimization are preprocessing, execution optimization, and worklist optimization.

PreprocessingThe single most important step you can take to ensure that events are processed quickly and efficiently is to preprocess as much data as possible.

For example, three files must be appended together and sent to the Server, as follows:

CD APPEND D:\app\File1.DAT TO D:\app\File2.datCD APPEND D:\app\File2.DAT TO D:\app\File3.dat D GET C:\Inbox\File3.DAT FROM D:\<Clientpath>\File3.dat

If the APPEND commands were completed by the Client application before the session begins, the worklist would be reduced to:

D GET C:\Inbox\File3.dat FROM D:\<Clientpath>\File3.dat

Use preprocessing any time you can eliminate events in this manner. For example, each event in a session to an Asynchronous Client takes about one second to send the low level command(s). Events such as APPEND, COPY, and DELETE also add disk I/O time needed to process the command at the Client. Thus, you may be able to save several minutes per session by letting the Client application do most of the heavy work and having all the data at the Client ready – before the session runs.

Important: Preprocessing means that any task that can be performed on the Client by the Client software should be completed before a session begins.


Execution optimizationThe second class of session optimization is through the optimization of the events that cannot be preprocessed.

Use ESD when possibleThe best way to optimize these events is to use ESD lists whenever possible. ESD is much more efficient than SEND events in a worklist object because all ESD is checked at one time at the Client. For SEND events with updates only, the ESD-like check must be done each time a SEND event is encountered, and this extra action wastes time.

Wildcard characters increase efficiencyAnother way to process events more quickly is to use wildcard characters. An event with wildcards is expanded into several events at runtime; however, this is still faster than explicitly naming each file. When you use a wildcard character, the file status of the affected files can all be checked at once in a similar fashion to ESD.

The only exception to this rule is when the wildcard character yields only one or two file names. In this case, the overhead of expanding the Master Worklist will be greater than the time savings from using the wildcard. For more information, see “Rebuilding the Master Worklist during a session” on page 463.

FILE STATUS eventDo not use the FILE STATUS event to check a file that is about to be transferred. FILE STATUS is meant to be used to check for the existence of a flag. For example:

CD FILE STATUS C:\Dir\Data.dat& D GET D:\In\Data.dat FROM C:\Dir\Data.dat

should be replaced with:

D GET D:\In\Data.dat FROM C:\Dir\Data.dat

If the file does not exist, the GET event fails. There is nothing wrong with letting an event fail, and it only takes one event instead of two. If it is important that the failure not cause the session status to fail, use the GET command’s ‘Not required for successful session’ option.

CHECK SEND file(s) to Client eventThe CHECK SEND file(s) event combines the CHECK file and SEND file events into a single event. When checking and transferring a file, use this event whenever possible


to reduce the total number of events in a work object.

For example, instead of using several events:

CHECK FILE C:\File.txt D:\File.txt IF FALSE SEND FILE C:\File.txt TO D:\File.txtEND IF

use just one CHECK SEND event:

CHECK SEND FILE C:\File.txt D:\File.txt TO D:\File.txt

Conditional checksUse the SET VARiable event to avoid multiple FILE STATUS events and other conditional checks at the Client. The first time a condition is checked, use SET VARiable and reference that variable in subsequent work objects. SET VARiable does not send a command to the Client, and the variable can then be used throughout the entire session. For example:

All but one of the FILE STATUS events can be replaced with TEST VARIABLE:

Note: The CHECK SEND event does not support the use of wildcards; you must use explicit file names.

Object 1 Object 2

CD FILE STATUS C:\Flag.flg CD FILE STATUS C:\Flag.flg

IF TRUE IF TRUE

<several events> <several events>

END IF END IF

<several events>

CD FILE STATUS C:\Flag.flg

IF TRUE

<several events>

END IF

Object 1 Object 2

ND FILE STATUS C:\Flag.flg D TEST VARIABLE <%FLAG> TRUE

& D SET VARIABLE <%FLAG> TRUE IF TRUE


Session executionWhen you understand how a session is executed, you can determine how to make your sessions more efficient. The following steps occur when a session runs on the Server.

The RemoteWare Server:

1 Reads the work objects to be executed.

2 Sorts objects by object priority.

3 Removes ESD and/or Application objects if they are disabled globally or for that Client.

4 Builds the Master Worklist.*

5 Executes BEFORE events.

6 Starts connect processing.

7 Once connected, starts processing DURING events.*

8 When first ESD Object is encountered, checks ESD for all ESD objects.*

9 Finishes executing DURING events.*

10 Starts disconnecting.

11 Executes AFTER events.

IF TRUE <several events>

<several events> END IF

END IF

<several events>

D TEST VARIABLE <%FLAG> TRUE

IF TRUE

<several events>

END IF

Note: The steps followed by an asterisk (*) have the most impact on session optimization.

Object 1 Object 2


Rebuilding the Master Worklist during a sessionIn step 4 above, the Server builds the Master Worklist, which is a list of all events that will execute during a session. It is important to understand that some session events cause the Server to rebuild the Master Worklist while the session executes. Time is lost when the Master Worklist must be rebuilt. Events that cause the Master Worklist to be rebuilt are events with wildcard characters, insert WORKLIST, and REPEAT loops.

• Wildcards. Events with wildcards are faster than their corresponding single events. Even though the Master Worklist must be rebuilt, don’t hesitate to use wildcards unless the wildcard will consistently yield a very small number of files. For more information, see “Wildcard characters increase efficiency” on page 460.

• insert WORKLIST. These events require a list of events to be inserted into the Master Worklist at runtime. For example: D SEND D:\Outbox\Msg*.txt TO <ClientInstall>\Inbox\Msg*.txt CD FILE STATUS <ClientInstall>\Inbox\Flag.flg& SD WORKLIST D:\Worklist\Wklist1.evf

In this example, the insert WORKLIST event should be replaced with the events from Wklist1.evf written out explicitly so that they are not read from disk during session execution. These events would instead be read before a connection with the Client (step 1 under “Session execution”). The insert WORKLIST event also causes problems when several sessions try to read the same worklist file during session execution while connected to several Clients. In short, avoid using insert WORKLIST if possible.

• REPEAT loops. Avoid REPEAT loops if possible. Every time a loop repeats, the Master Worklist is rebuilt. REPEAT loops should be used only when repeat logic must be performed during the session. If a worklist can be structured sequentially, use the simpler sequential logic.


Worklist optimizationAn optimized worklist has as few events as possible. In general, a worklist that has fewer events runs faster than a worklist that has more. This is because each event occupies a record in the Master Worklist which must be loaded and processed. Smaller worklists also use less memory and disk space.

Consolidate multiple COMMENT eventsA COMMENT event takes up space in the Master Worklist. Each COMMENT event contains up to 251 characters which can include several lines of text. Therefore, instead of using five one-line COMMENT events, it is more efficient to use just one COMMENT event that contains five lines of text.

Use conditional attributes within eventsWorklist events provide a Conditional True (&) and Conditional False (|) attribute. When enabled, the event executes based on the result of the last event.

For example, a worklist GETs a file. If the GET is successful, the file is renamed.

D GET D:\Data\File.dat FROM <ClientInstall>\File.dat IF TRUE CD RENAME <ClientInstall>\File.dat TO <ClientInstall>\File.old END IF

Instead of using the IF statement for just one event, you can simplify the worklist by using the Conditional True (&) attribute. This reduces the number of events in the worklist from four to two:

D GET D:\Data\File.dat FROM <ClientInstall>\File.dat& CD RENAME <ClientInstall>\File.dat TO <ClientInstall>\File.old

You can use the Conditional FALSE (|) attribute to replace an ELSE event. In the previous example, if you want to trigger a user alarm when GET is not successful, you need only add the one USER ALARM event:

D GET D:\Data\File.dat FROM <ClientInstall>\File.dat& CD RENAME <ClientInstall>\File.dat TO <ClientInstall>\File.old| SD USER ALARM Warning: Get File.dat failed.

You can use several Conditional TRUEs in succession to have the effect of an AND condition. For example, to execute a GET event if flag files Flag1.flg and Flag2.flg both exist, you could use IF events in the worklist:

CD FILE STATUS <ClientInstall>\Flag1.flg IF TRUE CD FILE STATUS <ClientInstall>\Flag2.flg IF TRUE


D GET C:\Data\File.dat FROM <ClientInstall>\File.dat END IF END IF

Or, you can use two Conditional TRUE (&) attributes to reduce this worklist to only three events:

CD FILE STATUS <ClientInstall>\Flag1.flg& CD FILE STATUS <ClientInstall>\Flag2.flg& D GET C:\Data\File.dat FROM <ClientInstall>\File.dat

Use the Delete after (-) attributeUse the Delete after (-) attribute instead of a DELETE event. Worklist events also provide a Delete after (-) attribute. This attribute deletes the source file on the Server or Client after the file has been processed.

For example, instead of using two events to GET and then DELETE a file at the Client,

D GET C:\Data\File.dat FROM <ClientInstall>\File.dat CD DELETE <ClientInstall>\File.dat

you can use just one event with the Delete after (-) attribute:

- D GET C:\Data\File.dat FROM <ClientInstall>\File.dat


Event properties To view events listed by type, see “Event types and descriptions” on page 442.

The following topics provide information about event properties. Events are presented in alphabetical order.

APPEND file(s) to another If you are working with text files, see “ASCII APPEND file(s) to another” on page 469.

Use this event to add the contents of one or more binary files to the end of a file. To display Event Details window for the APPEND event:

• On the Add Events menu, select Operating System and click APPEND file(s) to another.

• Double-click an APPEND event to edit an existing event.

Two fields specific to the APPEND event:

• Source Filename or Wild Card. The path name, file name, or wildcard parameter for one or more files to be appended to the destination file. Click Select File to choose a Server file, or type the path name and file name in the field. If this field is blank or if there is no path name, the default <ServerData>\ or <ClientInstall>\ directory is used.

• Destination Filename. The specific file name that is used to add data from the source file(s). Include the path for the destination file; otherwise, the default <ServerData>\ or <ClientInstall>\ directory is used. If the destination file does not exist, RemoteWare creates it.

Note: The destination file cannot be one of the files in the Source Filename field.

E v e n t p r o p e r t i e s 467

Temporary file useBy default, this event uses a temporary file for server-side execution. You can use a registry key to control this behavior:

• Key – Hkey_Local_Machine\Software\Remoteware\Server

• Name – DoNotUseTempFile value

• Data

• 0 – default, server uses temporary file for server-side event

• 1 – server does not use temporary file for server-side event

ExamplesTo append one Client file to another:

CD APPEND D:\Index2.dat TO <ClientInstall>\Index.dat

To append one or more Server files with the .pm6 extension before a communications session begins (or for a Process Only session):

SB APPEND <ServerData>\T2200\*.pm6 TO

Table 75. Options for the APPEND file(s) to another event

Option Remarks

Safe transfer See “File server considerations for “safe transfer” processing” on page 456.

Delete after (-) Deletes every source file once the event completes.

Not required for successful session Marks the session as successful even if this event did not successfully complete.

Work Object Critical Event Stops the work object if this event fails. When selected, this option disables the Critical event option.

Critical event (Retry) Stops the session if this event fails. When selected, this option disables the Work Object Critical Event option.

Conditional (True/False) Executes this event only if the previously executed event ended with a true/successful value or false/failed value.

Execute On Client: During only. On Server: Before, During, and After.


<ServerData>\T2200\All.pm6

To append every file in a directory to a Server file after a communications session:

SA APPEND D:\Data\*.* TO E:\Collect.dat

Note: If the destination file exists prior to the previous example event, then it is not appended to itself and is not included in the list of source files.


ASCII APPEND file(s) to another To join two or more non-text files, see “APPEND file(s) to another” on page 466.

Use this event to join two or more text files together. To display the Event Details window for the ASCII APPEND event:

• On the Add Events menu, select Operating System and click ASCII APPEND.

• Double-click an ASCII APPEND event to edit an existing event.

Two fields specific to the ASCII APPEND event:

• Source Filename or Wild Card. The path name, file name, or wildcard parameter for one or more text files. Click Select File to choose a Server file, or type the path name and file name in the text box. If this field is blank or if there is no path name, the <ServerData>\ or <ClientInstall>\ directory is used by default.

• Destination Filename. A specific text file name used to add data from the source file(s). Include the path for the destination file; otherwise, the default <ServerData>\ or <ClientInstall>\ directory is used. If the destination file does not exist, RemoteWare creates it. If the destination file is one of the source files, then it is not appended to itself.

Note: Appending ASCII files using WordPad with the .doc file extension is not supported.


The options available for the ASCII APPEND event include:

Temporary file useBy default, this event uses a temporary file for server-side execution. You can use a registry key to control this behavior:

• Key – Hkey_Local_Machine\Software\Remoteware\Server

• Name – DoNotUseTempFile value

• Data

• 0 – default, server uses temporary file for server-side event

• 1 – server does not use temporary file for server-side event

ExamplesTo append a Client text file to another, then erase the source file:

-CD ASCII APPEND C:\New.txt TO <ClientInstall>\ReadMe.txt

To concatenate one or more files that begin with the same letter to a destination file using a variable:

SA ASCII APPEND <ServerData>\EC403\U*.* TO <ServerData>\ECTotals\Usage<d>.log

Table 76. Options for the ASCII APPEND file(s) to another event

Option Remarks

Safe transfer See “File server considerations for “safe transfer” processing” on page 456.

Delete after (-) Deletes every source file once the event completes.







begin QUOTA block You can include only File Transfer events (GET, SEND, or CHECK SEND) in a QUOTA block.

Use this event in conjunction with the END QUOTA block event to wrap a group of file transfer events for segmented delivery. Segmented delivery breaks large files such as software packages into smaller segments; the segments can then be sent to a Client in stages. This event offers you more control over the length of communications sessions.

The begin QUOTA block event defines the maximum length of time and/or number of bytes allotted for each set of file transfer events. Events in the block are processed normally; however once this limit is exceeded, RemoteWare stops processing the wrapped events and begins processing the next session event after the QUOTA block. If the event that is executing when the quota runs out has the Safe transfer option enabled, it is interrupted and marked as Failed. Otherwise, the event proceeds normally to completion and no subsequent events in the QUOTA block are processed.

During the next communications session, RemoteWare begins processing the QUOTA block at the point at which the events stopped during the previous session. Once the Client receives all the file’s segments, the file is reassembled and processed.

You can “nest” QUOTA events. In other words, a QUOTA block can contain another QUOTA block, which in turn can include a third block, and so on. The maximum nesting depth is 10; any QUOTA block contained within 10 or more QUOTA blocks is ignored. Quota checks are performed for each nested block, not just the innermost one.

The events in a QUOTA block are processed sequentially, not concurrently. In other words, RemoteWare does not begin processing the second event until the first one is finished. The block does not transfer pieces of several files. If you want to distribute bandwidth among several file transfer events, you must use separate QUOTA blocks for each of them.

To display the Event Details window for the begin QUOTA block event:

• On the Add Events menu, select Session Control, and then click begin QUOTA block.

Note: During subsequent sessions, RemoteWare can process any interrupted event in a QUOTA block starting at the point of interruption, rather than from the beginning of the event. However, this feature applies only to GET, SEND, or CHECK SEND events where the Safe transfer option is selected.


• Double-click a begin QUOTA block event to edit an existing event.

Two fields specific to this event:

Tip: You can specify a value of zero (0) for one or both event specific fields, this indicates there is no limit. If you set both values to zero, RemoteWare ignores the QUOTA event.

• Data limit (Kilobytes). Specifies the maximum amount of uncompressed data to be transferred by SEND, CHECK SEND, and/or GET events within one quota block. You can transfer compressed data files, but the amount of data transferred may differ from the defined data limit.

• Time limit (mm:ss). Indicates the maximum time in minutes and seconds to be used to process the events in one quota block.

Table 77. Options for the begin QUOTA block event

Option Remarks





Execute On Server: Before, During, and After.


ExamplesTo send two files without taking more than five minutes or transferring more than approximately 1 MB of data:

SD QUOTA 1024K 05:00SD SEND <ServerData>\FileA.dat TO C:\Data\SD SEND <ServerData>\FileB.dat TO C:\Data\SD END QUOTA

In this example of nested QUOTA events, the second and third SEND files events and the GET event must be processed within a maximum time of five minutes.

To send three files and get one file from the Client within ten minutes time:

SD QUOTA 1000000K 10:00SD SEND <ServerData>\File1.exe TO D:\File1.exeSD QUOTA 500000K 05:00SD SEND <ServerData>\File2.exe TO D:\File2.exeSD SEND <ServerData>\File3.exe TO D:\File3.exeSD GET <ServerData>\NewFile.dat FROM C:\Data\Output.datSD END QUOTASD END QUOTA

QUOTA events and session restarts/retriesWhen you restart a failed session, any QUOTA blocks that were interrupted when the original session failed are still in effect; the quotas are not reset. The quota values in the resumed session may be less than the values specified in the QUOTA event because data may have already been transferred and time may have already passed during the session that failed. This is cumulative over successive retries or restarts.

For example, a session with a QUOTA block fails after three minutes of processing. The original session processed 100 KB of data, at which point the session failed. The begin QUOTA block event specifies a data limit of 500 KB and a time limit of 10 minutes. When the failed session is resumed, the QUOTA event now has a data limit of 400 KB and a time limit of seven minutes. If the session fails again after one minute, the next restart would have a time quota of six minutes, despite the fact that the QUOTA event shows a time limit of 10 minutes.

This feature only applies to restarts and retries of failed sessions, not to subsequent sessions. If a session runs daily, for example, the quota values on the second day are not

Important: You must specify the same Execute option (Before, During, or After) for the QUOTA event as well as its individual File Transfer events. For example, if a QUOTA block with three SEND events is set to execute during the session, the Execute option for each of the SEND events must also be set to During. An event whose Execute option does not match that of its “parent” QUOTA event is treated as though it were outside the QUOTA block; it will not be subject to the quota and instead will be processed like a normal event.


affected by the quota values on the first day.


CHECK DISKUse this event to determine the available storage space on a local, network, or remote drive, or to determine whether a specific quantity of storage is available. The Server logs an alarm in the Server Log and Network Status programs if the percent used exceeds the threshold on the Alarms page in Server Profile. (For more information, see “Alarms property page” on page 113.)

To display the Event Details window for the CHECK DISK event:

• On the Add Events menu, select Operating System, and click CHECK DISK.

• Double-click a CHECK DISK event to edit an existing event.

Two fields specific to the CHECK DISK event:

• Disk to Check. Instructs the Server to report the total and available size in bytes for this disk or volume. Also compares used storage on this drive against the threshold and reports an alarm if the disk is close to full. Enter a drive letter with or without the colon or backslash. By default, the Server checks the <ServerData> or <ClientInstall> drive if this field is blank.

• Free space required (optional). Enter a value representing the number of bytes needed for an operation. Optionally follow the number with K or M to indicate kilobytes or megabytes, respectively. You do not need to include a space between the number and the units. For example, 64 is 64 bytes, while 64K is 65536 bytes. The conditional status is set to the appropriate value based on the result.


ExamplesTo check a previously mapped network drive on the Server:

SB CHECK DISK Z:

To determine if a Client has one megabyte of available space on its C drive:

CD CHECK DISK C: for 1M free space

Check a Client drive:

CD CHECK DISK D:

After the event executes, the Client returns the following information about the drive:

CHECK DISK D: Disk Size:2756864 Bytes Free:24838144 Bytes

Table 78. Options for the CHECK DISK event

Option Remarks



Critical event (Retry) Stops the session if this event fails. When selected, this option disables the Work Object Critical event option.




* CHECK file * indicates that this event is valid for ESD work objects.

Use this event to compare the time, date, and file size for a Server and Client file. This event is often used to test the state of a file before a transfer event.

To display the Event Details window for the CHECK file event:

• On the Add Events menu, select Operating System and click CHECK file.

• Double-click a CHECK file event to edit an existing event.

Two fields specific to the CHECK file event:

• Server Filename. The drive, path, and file name of the Server file to be compared with the Client file. Type a path and file name in the text box, or click Select File to search the Server drives for the file. By default, RemoteWare uses the <ServerData>\ drive if this field is blank or has no path.

• Client Filename. Specifies the drive, path, and file name for the Client file. By default, uses the <ClientInstall>\ directory if this field is blank or without a path name.


ExamplesTo check a file on the Server and the Client:

CD CHECK FILE D:\Server\File.txt <ClientInstall>\File.txt

In RemoteWare ESD objects, the CHECK file event and SEND file(s) to Client event are often paired to update potentially active files on a Client. Combine these events to check files in one directory and send them to another directory. The Server sends the file only if the CHECK file event fails and the file does not exist in the Updates folder. For example:

CD CHECK FILE <ServerData>\File.exe C:\Files\File.exeD SEND FILE <ServerData>\File.exe C:\Files\Updates\File.exe

The Server checks both the \files and \files\updates directories, but only sends to \files\updates. The files may be deleted from the \updates directory once they are copied to \files.

Table 79. Options for the CHECK file event

Option Remarks

Check updates only (Always selected. Cannot be cleared.) Sets this event to successful only if the two files are identical.

Check if newer The event is successful only if the Client file is newer than the Server file.




Conditional (True/False) Executes this event only if previously executed event ended with a true/successful value or false/failed value.

Execute During and On Client only.


* CHECK SEND file(s) to Client * indicates that this event is valid for ESD work objects.

Use this event to compare a Server file’s time, date, and file size against a Client file. If the file does not exist on the Client or if it differs in size or date, the CHECK SEND event transfers the file from the Server to the Client.

To display the Event Details window for the CHECK SEND event:

• On the Add Events menu, select File Transfer and click CHECK SEND file(s) to Client.

• Double-click a CHECK SEND event to edit an existing event.

The three fields specific to the CHECK SEND event:

• Server Filename. The drive, path, and file name of the Server file to be compared with the Client file. Click Select File to choose a file, or type the path and file name in the text box. By default, RemoteWare uses the <ServerData>\ directory if this field is blank or if the file name has no path.

• Client Filename. The drive, path, and file name of the Client file against which the Server file will be checked. By default, the <ClientInstall>\ directory is used if this field is blank or the file name has no path.

• Client Destination Filename. The drive, path, and file name of the Client file to be sent. By default, the <ClientInstall>\ directory is used if this field is blank or the file name has no path.

Note: The CHECK SEND event does not support the use of wildcards; you must use explicit file names.


ExampleTo transfer and rename one Server file to the Client:

CHECK SEND file C:\File.txt D:\File.txt TO D:\File.txt

Table 80. Options for the CHECK SEND file(s) to Client event

Option Remarks

Do not overwrite Does not copy over an existing file if its name matches that of the destination file.

Safe transfer (Selected by default.) Ensures that files are not corrupted during transfer from Server to Client. Do not clear this check box unless space is limited on the Client or potential corruption of the destination file is not important.

Check updates only (Selected by default.) Instructs the Server to transfer only files with different sizes or dates.

Check if newer Transfer occurs only if the Server file has a more recent date and time stamp than the destination file on the Client.

Delete after (-) Deletes the source file once the transfer is successful.


Turn compression off Prevents file compression for this event only.




Make Destination Path Establishes a destination path for the event and creates directories when necessary.

Recursive Includes subdirectories with the event.

Execute During and On Client.


* COMMENT * indicates that this event is valid for ESD work objects.

Use this event to add comments to a worklist or to separate event blocks with a blank line. To display the Event Details window for the COMMENT event:

• On the Add Events menu, select Session Control and click COMMENT.

• Double-click a COMMENT event to edit an existing event.

Enter the comment text (up to 251 characters, including line breaks) you want inserted into the worklist. The comment text can span several lines and can be longer than the area displayed in the list box or the worklist window.

This event has no options and does not execute. The comment text appears in the worklist as it was typed in the Event Details window.


COPY file(s)Use the COPY file(s) event to duplicate one or more files to another file name or directory. To display the Event Details window for the COPY file(s) event:

• On the Add Events menu, select Operating System and click COPY file(s).

• Double-click a COPY file(s) event to edit an existing event.

Two event specific fields:

• Source Filename or Wild Card. The path, file name, or wildcard parameters for one or more files to copy. If the event occurs on the Server, you can click Select File to set the value. The event is unsuccessful if the source file does not exist or if the wildcard parameter does not locate any files.

If this field is blank or if the value does not have a path, the event uses the default directory: <ServerData>\ (on the Server) or <ClientInstall>\ (on the Client). If you use a wildcard in this field, the Destination field must contain a directory. If you use a file name, the Destination field must contain a file name.

• Destination Filename or Directory or Wild Card. The path, file name, or directory for the file or directory that will receive the copied files. This value should be a file if the Source field contains a file, or a directory if the Source field uses a wildcard parameter. If this field is blank or contains no path, the event uses the default directories (<ServerData>\ or <ClientInstall>\) for Server and Client execution.

Table 81. Options for the COPY file(s) event

Option Remarks

Delete after (-) Erases the source file(s) after the event is successful.


ExamplesTo copy one file on the Server before a communications session begins (or for a Process Only session):

SB COPY <ServerData>\File.txt E:\Archives\File.txt

To copy one or more Client files to the same directory without changing their file names:

CD COPY D:\*.DOC D:\

To copy one or more Server files to a different directory:

SA COPY <ServerData>\Storage\File.txt E:\Archives\File.txt



Critical event (Retry) Stops the session if this event fails. When selected, this option disables the Work Object Critical event and the Not required for successful session options.


Execute On Client: During only. Critical event option. On Server: Before, During, and After.

Table 81. Options for the COPY file(s) event (Continued)

Option Remarks


CREATE REGISTRY KEYUse this event to create a key in the registry.

To display the Event Details window for the CREATE REGISTRY KEY event:

• On the Add Events menu, select Operating System and click CREATE REGISTRY KEY.

• Double-click a CREATE REGISTRY KEY event to editing an existing event.

One event specific field:

• Root key\key1\keyN. The complete path and name of the key to be created. The path must exist for the event to be successful unless you select the Make Destination Path option.

This parameter supports the use of the following abbreviations:HKLM = HKEY_LOCAL_MACHINEHKCU = HKEY_CURRENT_USERHKCR = HKEY_CLASSES_ROOTHKU = HKEY_USERS

This event fails if the parameter is not a valid registry key or if the specified key already exists.

Note: This event is applicable only for Windows Client types.


ExampleTo create a new registry key on a local machine:

CD CREATE REGISTRY KEY HKLM\Software\Key

Table 82. Options for the CREATE REGISTRY KEY event

Option Remarks








† DELETE file(s) † indicates that this event is valid for Multicast work objects.

Use this event to permanently remove one or more files from the Server or Client. To display the Event Details window for the DELETE file(s) event:

• On the Add Events menu, select Operating System, and click DELETE file(s).

• Double-click a DELETE file(s) event to edit an existing event.

One field specific to DELETE file(s) event:

• Filename or Wild Card. The path, file name, or wildcard parameter for one or more files to delete. Type the value in the text box. Or, if the event occurs on the Server, click Select File to choose a file. The event uses the default <ServerData>\ or <ClientInstall>\ directory if the field is blank or if there is no path.

• Client Acknowledgement timeout (mm:ss). The amount of time the system should wait for acknowledgement from all the Clients that the file has been received.

Table 83. Options for the DELETE file(s) event

Option Remarks





ExamplesTo delete all .doc files on the Server after a communications session:

SA DELETE E:\D01819\*.DOC

To delete one Client file:

CD DELETE <ClientInstall>\Revenue\Stats\Stat04.dbx


Execute On Client: During only. On Client, in Multicast work object: Before only. On Server: Before, During, and After.

Table 83. Options for the DELETE file(s) event (Continued)

Option Remarks


DELETE INI FILEUse this event to delete a user-defined variable within an .ini file.

To display the Event Details window for the DELETE INI FILE event:

• On the Add Events menu, select Session Control and click DELETE INI FILE.

• Double-click a DELETE INI FILE event to edit an existing event.

Two fields specific to the DELETE INI FILE event:

• Filename. The name of the variable file to be deleted.

• User Variable Name. The name of the user variable whose value is to be deleted. [Section] is an optional parameter which enables you to specify a section of the .ini file.


Table 84. Options for the DELETE INI FILE event

Option Remarks


Work Object Critical Event Stops the work object if this event fails. When selected, disables the Critical event option.


ExamplesThe following examples use the sample .ini file shown below:

Test.ini [Section1]Help=TrueUser=TestUser

[Section2]Help=False

To delete the value of the test1.ini file’s Help item in Section 1:

DELETE INI FILE C:\Directory\test1.ini <%[Section1].Help>

Resulting .ini file:

Test.ini [Section1]User=TestUser


To delete all Help items in the test1.ini file:

DELETE INI FILE C:\Directory\test1.ini <%.Help>

Resulting .ini file:

Test.ini [Section1]

Critical event (Retry) Stops the session if this event fails. When selected, disables the Work Object Critical Event and the Not required for successful session options.



Table 84. Options for the DELETE INI FILE event (Continued)

Option Remarks


User=TestUser

[Section2]

Note: To read a variable from an .ini file, see “READ INI FILE” on page 529. Or, to write values to an .ini file, see “WRITE INI FILE” on page 566.


DELETE REGISTRY KEYUse this event to permanently remove a key from the registry.

To display the Event Details window for the DELETE REGISTRY KEY event:

• On the Add Events menu, select Operating System and click DELETE REGISTRY KEY.

• Double-click a DELETE REGISTRY KEY event to edit an existing event.

One field specific to the DELETE REGISTRY KEY event:

• Root key\key1\keyN. The complete path and name of the key to delete. The path must exist for the event to be successful.



Table 85. Options for the DELETE REGISTRY KEY event

Option Remarks

Not required for successful session Marks session as successful even if this event did not successfully complete.


ExampleTo delete a registry key on a local machine:

CD DELETE REGISTRY KEY HKLM\Software\Key


Critical event (Retry) Stops the session if this event fails. When selected, disables the Work Object Critical event and the Not required for successful session options.



Table 85. Options for the DELETE REGISTRY KEY event (Continued)

Option Remarks


DELETE REGISTRY VALUEUse this event to permanently remove a value from the registry. This event can be used to delete values of any type, not just REG_SZ.

To display the Event Details window for the DELETE REGISTRY VALUE event:

• On the Add Events menu, select Operating System and click DELETE REGISTRY VALUE.

• Double-click a DELETE REGISTRY VALUE event to edit an existing event.

One field specific to the DELETE REGISTRY VALUE event:

• Root key\key1\keyN[value]. The complete path and name of the value to be deleted. This event fails if the key from which the value is to be deleted does not exist. However, the event returns as successful if the key exists but the value to be deleted does not.

This parameter supports the use of the following abbreviations:HKLM = HKEY_LOCAL_MACHINEHKCU = HKEY_CURRENT-USERHKCR = HKEY_CLASSES_ROOTHKU = HKEY_USERS



ExampleTo delete the value in a specified registry key:

CD DELETE REGISTRY VALUE HKEY_CURRENT_USER\Temp\Value

Table 86. Options for the DELETE REGISTRY VALUE event

Option Remarks







DIRectory listingUse this event to copy the list of files in a directory into an output file on the Server. This output file is text and has the same format as a DOS DIR command. The event is unsuccessful if the event cannot find the directory or if the directory contains no files.

To display the Event Details window for the DIRectory listing event:

• On the Add Events menu, select Operating System and click DIRectory listing.

• Double-click a DIRectory listing event to edit an existing event.

Two event fields specific to the DIRectory listing event:

• Output Filename. Instructs the event to create a file at this location on the Server. Enter the directory, path, and file name that will contain the directory listing. The event replaces the file if it already exists; it does not create the path if the directories or subdirectories do not exist.

• Directory Wild Card. Specify the path or wildcard to use to get the directory listing. For the Client only, end the path with a backslash “\” to list the contents of a directory. On the Server, add *.* after the backslash “\” to list all the files in the directory. See the following examples for more information.

Table 87. Options for the DIRectory listing event

Option Remarks




ExamplesList every file in the Client’s \FILES directory:

CD DIR <ServerData>\Listings\Files.dir from C:\Files\

List the Client’s \FILES directory (not its files) if it exists (note that the event omits the last backslash to list the actual directory):

CD DIR <ServerData>\Listings\Filedir.dir from C:\Files

Generate a directory listing of all .bas files in a Server directory before a communications session begins (or for a Process Only session):

SB DIR <ServerData>\Baslist.txt from <ServerData>\Prog\*.bas




Table 87. Options for the DIRectory listing event (Continued)

Option Remarks


END <event>There are several END events that are paired with other originating events to terminate the originating event’s affect.

ELSE IFThe ELSE IF conditional event is optional and is used with other IF conditional events (IF, END IF, and so on) to control the execution of a block of events. Use this event to specify which block of events to execute in the alternate case.

To add an Else If event, on the Add Events menu, select Session Control, and click ELSE IF.

The ELSE IF event does not have an Event Details window.

ExampleThe ELSE IF event appears on its own line as part of a conditional block. If it is used incorrectly, the Work Object Editor or Worklist Editor program generates a syntax error. The following example illustrates a typical IF block. The ELSE IF block executes if the file exists.

CD FILE STATUS “C:\Is It There.fil” IF FALSESD USER ALARM Could not locate the file. ELSE IFSD USER ALARM The file was found. END IF

END IFUse this conditional event with the other IF conditional events (IF, ELSE IF, and others) to control the execution of a block of events. Place END IF at the very end of each IF block (see the following examples for details). The Worklist Editor or Work Object Editor issues an error when an IF block ends without an END IF event, or when the END IF event appears out of sequence. For details, see “IF” on page 515.

In Work Object Editor or Worklist Editor, add this event by displaying the Add Events menu, pointing to Session Control, and selecting END IF. (In Work Object Editor, you must display the Events page to use the Add Events menu. For details, see “Add

Note: The ELSE IF event is the same as an “else” in some programming languages – it does not indicate nested IFs. For more information, see “IF” on page 515.


Events menu” on page 198.)

The END IF event does not have an Event Details window.

ExamplesThese two worklist examples illustrate the correct and incorrect way to use END IF.

END QUOTA block Use this event to end a block of QUOTA events or to end each block in a nested set of QUOTA events. For more information, see “begin QUOTA block” on page 471.

You can add this event to a worklist in the Work Object Editor or Worklist Editor programs. On the Add Events menu, point to Session Control. Then select END QUOTA block. The END QUOTA block event does not have an Event Details window.

END REPEATUse this conditional event with the REPEAT IF conditional events to mark the end of a REPEAT IF block of events. Place END REPEAT at the end of each REPEAT IF block. A REPEAT IF block of events without an END REPEAT event generates an error upon exiting the worklist window. For more information, see “REPeat IF previous event FALSE / TRUE” on page 538.

In Work Object Editor or Worklist Editor, add this event by displaying the Add Events menu, pointing to Session Control, and selecting END REPEAT. The END REPEAT event does not have an Event Details window.

Correct Incorrect

CD MAKE DIR D:\TTX CD MAKE DIR D:\TTX

IF TRUE IF TRUE

CD SEND Z:\T1.IDX TO D:\TTX\ CD SEND Z:\T1.IDX TO D:\TTX\

ELSE IF END IF

SD USER ALARM Transfer fails. ELSE IF

END IF SD USER ALARM Transfer fails.

END IF

Note: Repeat blocks can only be used as During events.


ExampleTo mark the end of a REPEAT IF block:

SA WAIT D:\Dbase\Query.qry 1:00 REP IF FALSE 2:00 1:00 5SA EXECUTE D:\Dbase\Start.exeSA WAIT D:\Dbase\Query.qry 1:00 END REPEAT D SEND D:\Dbase\Query.qry TO C:\Inbox\<ClientName>.qry

END SESSIONUse this event to stop a session and disconnect the communications line before the session reaches the end of the worklist or the end of the session. The event is useful for stopping execution in a specific condition, rather than continue an operation or initiate a connection.

To display the Event Details window for the END SESSION event:

• On the Add Events menu, select Session Control, and click END SESSION.

• Double-click an END SESSION event to edit an existing event.

There are no event specific fields in this window.


If you are planning to use this worklist in a Process Only session, make sure to select the Before option (located under Execute).

ExampleTo stop a session before the end of the worklist:

D GET D:\SALES\Money.dat FROM C:\Totals\Money.dat IF FALSESD USER ALARM <ClientName> lost the money file.SD END SESSION END IFSD USER ALARM Money received from <ClientName>.

END WORK OBJectUse this event to terminate the current work object and proceed to the next one, if any. END WORK OBJect is useful for ending a task based on a certain condition, but without ending the entire session. Upon encountering this event during the last work object, the Server will continue with other scheduled (or blocked) sessions for this Client if the Maintain Dial Connection option is enabled on the Server Profile Settings page. For details, see “Maintain Dial Connection” on page 73.

To display the Event Details window for the END WORK OBJect event:

• On the Add Events menu, select Session Control and click END WORK OBJect.

Table 88. Options for the END SESSION event

Option Remarks





• Double-click an END WORK OBJect event to edit an existing event.

There are no event specific fields for the END WORK OBJect event.

ExampleTo stop a work object because of inadequate storage:

SB CHECK DISK C for 1M free space IF FALSESB USER ALARM Could not install <ProductName>.SB END WORK OBJ END IFSB USER ALARM Sufficient space to install <ProductName>.

Table 89. Options for the END WORK OBJect event

Option Remarks




Note: If you plan to use this worklist in a Process Only session, select the Before option (under Execute).


EXCEPTION worklist For information on executing events in an external events file, see “insert WORKLIST” on page 518.

An exception worklist is a list of events executed after a session when a Client has failed with a Failed-Final status, except when the Server has been rebooted or the session fails with a Scheduler Overrun. Use exception worklists to perform cleanup tasks or to complete salvage and recovery procedures. All events in the exception worklist must run on the Server as After events; other event execution types are ignored.

To display the Event Details window for the EXCEPTION worklist event:

• On the Add Events menu, select Server and click EXCEPTION worklist.

• Double-click an EXCEPTION worklist event to edit an existing event.

One event specific field identifies the worklist file:

• Exception Worklist Filename or @Indirect File. Specifies a file containing a worklist, or an indirect file containing the name of a worklist file. Indirect files are useful when the worklist may vary or when session conditions mandate the use of different worklist files. You can select a file by clicking Select File or typing the path and file name. Use the “@” symbol before the path and file name (for example, @C:\tempo\det.wrk) to specify a file that contains the worklist’s name.

No options apply to this event. EXCEPTION worklist always runs After and On Server.

ExamplesTo execute a set of events in the cleanup.evf file:

SA EXCEPTION <ServerData>\Events\Cleanup.evf

To reference an indirect file containing the file name of an exception worklist:

SA EXCEPTION @E:\Process\Recovery\Exsessio.txt


† EXECUTE program † indicates that this event is valid for Multicast work objects.

This event provides the same capability as the DOS command line for running programs; it launches the program via the information in the Command Line field. EXECUTE does not monitor the status or completion of the program that is executed.

To display the Event Details window for the EXECUTE program event:

• On the Add Events menu, select Operating System and click EXECUTE program.

• Double-click an EXECUTE program event to edit an existing event.

One field specific to the EXECUTE program event:

• Command Line. Enter the path and name of the application’s executable file. Include command line options after the file name.

• Client Acknowledgement timeout (mm:ss). The amount of time the system should wait for acknowledgement from all the Clients that the file has been received.

Note:When you use the EXECUTE event with files that have spaces and parameters, you must encapsulate the entire line in quotes as well as the paths, executables, or parameters. For example on the Server use the following:““E:\my files\myexe.exe” “file w spaces as parameter””

On the Client only no additional quotes are needed around the entire line. Use the following:

“e:\my files\myexe.exe” “file w spaces as parameter”


The options available for the EXECUTE event include:

ExamplesTo run the Windows File Manager on a Client:

CD EXECUTE C:\Windows\Winfile.exe

To execute a compression utility (using command line switches) on the Server prior to a communications session (or for a Process Only session):

SB EXECUTE D:\Apps\Utils\Compress.exe -c1 -v <C:\Files\*.tif >C:\Files.cm

Advanced applications of the EXECUTE event When executed on the RemoteWare Server, the EXECUTE event uses the Execution Server, which is a RemoteWare Server component used to execute commands or start user programs on the Server. The Execution Server uses both Windows Queues and Named Pipes to interact with other applications.

When the RemoteWare Server service uses the system account and is set to interact with the Desktop, the EXE_SERV Execution Server program opens an MS-DOS window when executing a background process.

A typical application for the Execution Server occurs when there is a mismatch between the number of resources and the number of concurrent sessions that require a resource. For example, if you have 10 active sessions that require a micro-to-mainframe file transfer and only one micro-to-mainframe link is available, you can use the EXECUTE event to establish and maintain the link.

To use the Execution Server, the program must be on the Server and must not require user input or a user interface to run. Programs execute in the background, rendering interactive programs (that is, those that require a user interface) useless. Furthermore, a user cannot terminate these programs normally; they occupy a resource on the Execution Server until their processes are stopped.

To display the executed program, open Control Panel and double-click Services. Double-click the RemoteWare service. In the Service dialog box, select the Allow Server to Interact with Desktop check box and click OK. For the change to take

Table 90. Options for the EXECUTE program event

Option Remarks



Execute On Client: During only. On Client, in Multicast work object: Before only. On Server: Before, During, and After.


effect, you must stop and restart the RemoteWare service(s).

ExamplesYou can start or adjust the Execution Server from the Administrator program, or by issuing this command at the command line or from the Run NT command (File menu):

START exe_serv 2 >nul

One concurrent execute is the default, and the default queue name is exe_serv.que. The default pipe is exe_serv.pip. You can specify up to 20 concurrent executes, each having a unique queue name. For example, to specify a maximum of five concurrent executes:

START exe_serv 5 2 >nul

In this case the default queue is exe_serv.que, and up to five processes can be executed at the same time. To specify a new queue name:

START exe_serv 5 /QUEUES/<QueueName> 2 >nul

To use pipes, specify the pipe name:

START exe_serv 5 /QUEUES/<QueueName> /PIPE/<PipeName> 2 >nul

If the RemoteWare Server processes an Execute event whose command line references an executable file that can’t be found, the error “The handle is invalid” is generated to the Session History log.

When the session runs, the EXECUTE event sends its commands to the Execution Server, and then the next event is processed. The session does not wait for the command to complete. If your session requires the command to complete before moving onto another event, use the WAIT event. For information, see “WAIT for file to exist” on page 564.


GET file(s) from ClientUse this event to locate one or more Client files and transfer them to the specified file or directory on the Server. Wildcards used with this event will retrieve a group of files whose names have something in common or that are in the same directory.

To display the Event Details window for the GET file(s) from Client event:

• On the Add Events menu, select File Transfer and click GET file(s) from Client.

• Double-click a GET file(s) from Client event to edit an existing event.

Two fields specific to the GET file(s) from Client event:

• Server Filename or Wild Card or Directory. Instructs the event to store one or more Client files at this Server location. Specify the destination file name, directory name, and optionally the path name. To change this field, click Select File, or type the directory or file name in the text box. The default value is the <ServerData>\ directory.

• Client Filename or Wild Card. Locates and transfers one or more Client files that match this value to the Server. Specify the file name or wildcard parameter for the Client file(s). The default path value is the <ClientInstall>\ directory.

Table 91. Options for the GET file(s) from Client event

Option Remarks

Byte Level Differencing

This detects differences between file versions at the Server and the Client and sends only the differences to the Client or Server, which reduces the time required to update files and software.


Xpress Transfer Speeds up the transfer of the SEND and GET events over TCP/IP connections by removing all packet and window sizing, along with the RemoteWare protocol. See “Notes on Xpress Transfer option” on page 508 for more information.

Do not overwrite No transfer occurs if a file by the same name exists at the Server.

Safe transfer (Selected by default.) Ensures that files are not corrupted during transfer from Server to Client. Do not clear this check box unless space is limited on the Client or potential corruption of the destination file is not important. See “File server considerations for “safe transfer” processing” on page 456.

Check updates only

(Selected by default.) Instructs the Server to transfer only files with different sizes or dates.

Check if newer Transfer occurs only if the Server file does not exist or the file is less recent than the Client file.

Delete after (-) Deletes the Client file if transfer is successful.

Not required for successful session

Marks the session as successful even if this event did not successfully complete.

Turn compression off

Prevents file compression for this event only.

Work Object Critical Event

Stops the work object if this event fails. When selected, disables the Session Critical event option.

Critical event (Retry)

Stops the session if this event fails. When selected, disables the Work Object Critical Event option.

Conditional (True/False)

Executes this event only if the previously executed event ended with a true/successful value or false/failed value.

Make Destination Path

Establishes a destination path for the event and creates directories when necessary.


Execute During and On Client.

Note: If you use the Recursive option and a directory name is specified in the Server Filename or Wild Card or Directory field, the directory name must be followed by \. For example:

c:\serverdirectory\

Table 91. Options for the GET file(s) from Client event (Continued)

Option Remarks


Notes on Xpress Transfer optionXpress Transfer option can be enabled in the Work Object Editor and the Worklist Editor.

Xpress Transfer is available for the following:

• Windows and Linux Clients • TCP/IP connections only• ESD

Xpress Transfer is not available for the following:

• Interactive Session• Worklist ECF

Xpress Transfer and unsupported Clients

If you are connecting to an unsupported Client type, Xpress Transfer is ignored.

Xpress Transfer with Checkpoint Restart

To use Checkpoint Restart with Xpress Transfer, select the Xpress Transfer and Safe Transfer options only.

Xpress Transfer within a quota block

Xpress Transfer disregards any Quota Block events.

ExamplesTo transfer one Client file to the Server’s data drive:

D GET <ServerData>\FileB.dat FROM <ClientInstall>\FileA.dat

Locate all files in a directory with the .dat extension and transfer them to a Server directory:

D GET “F:\File storage\” FROM C:\OldFiles\*.dat

Copy all files from the Client’s default directory to a Server directory:

D GET <ServerData>\DirStor\ FROM <ClientInstall>\


get FILE STATUSFILE STATUS determines whether a file exists at the specified location. Use this event to set the conditional value to true or false based on a file’s presence. The event often precedes a conditional event (such as IF or REPeat IF previous event FALSE) or an event with the Conditional option enabled.

To display the Event Details window for the get FILE STATUS event:

• On the Add Events menu, select Operating System and click get FILE STATUS.

• Double-click a get FILE STATUS event to editing an existing event.

One field specific to the FILE STATUS event:

• Filename. The Server attempts to locate a file at the specified path and file name. If the event occurs on the Server, you can click Select File to locate the file. If this field is blank, the event uses the default <ServerData>\ path for a Server executed event and <ClientInstall>\ for a Client executed event.

Table 92. Options for the get FILE STATUS event

Option Remarks



Critical event (Retry) Stops the session if this event fails. When selected, disables the Work Object Critical Event option and the Not required for successful session option.


ExamplesTo check for a flag file on the Server after a communications session:

SA FILE STATUS <ServerData>\updates\ok.flg

To use the event and conditional logic to determine a Client’s current status:CD FILE STATUS D:\Apps\Status\Fini.flg IF FALSESD USER ALARM <ClientName> has not finished processing. ELSE IFD GET <ServerData>\Collect\ FROM D:\Files\Dayend*.* END IF



Table 92. Options for the get FILE STATUS event (Continued)

Option Remarks


GET REGISTRY VALUEUse this event to retrieve a value from the registry and place it into a user worklist variable. This event can only be used to get values of String and DWORD types.

To display the Event Details window for the GET REGISTRY VALUE event:

• On the Add Events menu, select Operating System and click GET REGISTRY VALUE.

• Double-click a GET REGISTRY VALUE event to edit an existing event.

Two fields specific to the GET REGISTRY VALUE event:

• User variable name. The user-defined variable for which the registry value is being set.

• Root key\key1\keyN. The complete path and name of the registry key whose value is to be placed in the specified variable. This event fails if the value does not exist in the specified key or if the path is not a valid registry path.




ExampleTo set the value of the user-defined variable <%MyVar>:

CD GET REGISTRY <%MyVar> HKEY_CURRENT_USER\Temp\Value

Table 93. Options for the GET REGISTRY VALUE event

Option Remarks







GET VARiable from SCRIPT (Windows Clients only)

Use this event to allow the session to retrieve the value of an global script variable. Use this event after calling a function that would have been assigned a value to a script variable during execution.

The RemoteWare administrator provides the name of the script variable and the session variable name where the retrieved value is stored.

To display the Event Details window for the GET VARiable from SCRIPT event:

• On the Add Events menu, select Scripting and click GET Script Variable.

• Double-click a GET Script Variable event to edit an existing event.

Fields specific to the GET VARiable from SCRIPT event:

• Path to Script File. The complete path and name of the script. The path must exist for the event to be successful. Maximum length is 256 characters.

• Script Variable Name. The name of the script variable provided by the RemoteWare administrator.

• Session Variable to Receive Script Variable Value. The name of the session variable that will store the retrieved variable value as provided by the RemoteWare administrator.


ExampleTo allow the session to retrieve the value of an global script variable:

GET SCRIPT VAR c:\test.vbs Name to <%MyName>

Table 94. Options for the GET SCRIPT VARiable from Script event

Option Remarks







IFUse this conditional event to control the execution of one or two blocks of events in a session. A block of events begins with an IF event and ends with the END IF event. An IF event executes the following block of events if the specified conditions are met. IF events can be nested. That is, a block of events inside an IF block can contain more than one IF event, and so on. Remember to end each IF block with an END IF event. For more information, see “END IF” on page 497. The worklist window indents IF events, IF blocks, and nested IF blocks for readability.

To display the Event Details window for the IF event:

• On the Add Events menu, select Session Control and click IF.

• Double-click an IF event to edit an existing event.

Three fields specific to the IF event:

• Argument 1. Specifies the first <VariableName>, <TextString>, or numeric value for the conditional statement.

• Argument 2. Specifies the second <VariableName>, <TextString>, or numeric value for the conditional statement.

• Comparison. Indicates the type of condition that must exist between the two arguments. Select one of the following options:

• Equals. Executes the event if Argument 1 matches Argument 2.

• Not Equal. Executes the event if Argument 1 does not match Argument 2.

• Greater. Executes the event if the value of Argument 1 exceeds the value of Argument 2.


• Greater or Equal. Executes the event if the value of Argument 1 matches or exceeds the value of Argument 2.

• Less. Executes the event if the value of Argument 1 is less than the value of Argument 2.

• Less or Equal. Executes the event if the value of Argument 1 matches or is less than the value of Argument 2.

• Previous Event Succeeded. Executes the event if the previous event completed successfully.

• Previous Event Failed. Executes the event if the previous event failed.

There are no options for this event.

ExamplesThe first example shows how to retrieve a Client’s daily sales report only if sales are complete. This example expects to find the closed.out control file. A process creates this file when the daily sales report is finished. If this file exists, then the session retrieves the report and deletes the control file. When the next day’s sales report is ready, the process repeats itself and creates another file called “Closed.out.”

CD FILE STATUS C:\Salesdat\Closed.out IF Previous Event True D GET <ServerData>\SD\<ClientName>\Daily.rpt FROM \Salesdat\Daily.rptCD DELETE C:\Salesdat\Closed.out END IF

Adding to the previous example, an ELSE IF event instructs the session to log a user alarm if the daily sales report is not ready.

CD FILE STATUS C:\Salesdat\Closed.out IF Previous Event True D GET <ServerData>\SD\<ClientName>\Daily.rpt FROM \Salesdat\Daily.rptCD DELETE C:\Salesdat\Closed.out ELSE IFSD USER ALARM <ClientName>’s sales report not ready END IF


The next example uses nested IF events to receive a Client’s files. If the directory is not found, USER ALARM logs a message to the Server Log and tries to create the directory for a new Client. Creating the directory successfully causes the session to send and execute a job to create the print files. ELSE IF is used with IF TRUE to log another USER ALARM if the directory could not be created.

CD GET C:\Printing\*.* FROM D:\Print\*.pm6 IF Previous Event FalseSD USER ALARM No files exist or directory not found. New Client assumed.CD MAKE DIR D:\Print IF Previous Event TrueCD SEND Z:\Apps\Print\Collect.exe TO D:\Apps\*.*CD EXECUTE D:\Apps\Collect.exe -q -d D:\PrintWait one minute, then try again (Nofile.flg does not exist on the Server)SD WAIT C:\Nofile.flg 1:00 D GET C:\Printing\*.* FROM D:\Print\*.pm6 ELSE IFSD USER ALARM Could not create directory. END IF END IF

The final example shows a simple conditional argument:

IF Var1 = = Var2


insert WORKLIST To run a worklist when a session has failed, see “EXCEPTION worklist” on page 502.

Use this event to insert one or more events from an external worklist file into an object’s worklist of events. To display the Event Details window for the insert WORKLIST event:

• On the Add Events menu, select Server and click insert WORKLIST.

• Double-click an insert WORKLIST event to edit an existing event.

One field specific to the WORKLIST event:

• Worklist Filename or @Indirect File. Specifies the path and name of the worklist file or an indirect file that contains the worklist file name. To select an existing Server file, click Select File, or type the path and file name in the text box.

For indirect files, you must use the @ symbol before the file name; for example, @F:\Lookhere.fil. Indirect files are a versatile and powerful method for specifying the worklist file name from session or Client control. For details, see the examples later in this section.

The options available for the insert WORKLIST event.

Table 95. Options for the insert WORKLIST event

Option Remarks



Work Object Critical Event Stops the work object if this event fails. When selected, disables the Critical event and the Not required for successful session options.

Critical event (Retry) Stops the session if this event fails. When selected, disables the Work Object Critical Event option.


ExamplesTo execute events in a specific worklist file:

SB WORKLIST <ServerData>\Worklist\Work32.wrk

In this example, the session chooses which worklist to execute:

SA SET VARIABLE <%Execute-This> Work<m><d>.wrkSA WORKLIST D:\Works\<%Execute-This>

The final example shows how to allow a Client to choose which worklist to execute. The Client chooses the worklist and places it in the get.txt file. The Server retrieves the file and uses it as the external file:

SD GET D:\Request\<ClientName>.txt FROM <ClientInstall>\Request\Get.txtSD WORKLIST @D:\Request\<ClientName>.txt


Execute On Server: Before, During, and After. Use Before for Process Only sessions.

Note: The insert WORKLIST event only executes on the Server, and can be used as a Before, During, and After event. Remember to set this event to Before when using it in a Process Only session.

Table 95. Options for the insert WORKLIST event (Continued)

Option Remarks


LOAD SCRIPT file (Windows Clients only)

Use this event to load and parse script files so that the script is available to other session events. RemoteWare administrators provide the path name of the script file the type of script used.

During session execution, the script file is loaded, parsed and executed. If all three steps are successful, the script is retained for further use. If an error occurs in loading, parsing or executing, the event fails and any allocated scripting resources are released.

To display the Event Details window for the LOAD SCRIPT file event:

• On the Add Events menu, select Scripting and click LOAD Script.

• Double-click a LOAD Script event to edit an existing event.

Fields specific to the LOAD Script file event:

• Path to Script File. The complete path and name of the script to load. The path must exist for the event to be successful. Maximum length is 256 characters.

• Script Type. The type of script to be loaded. The script is provided by the RemoteWare administrator. Supported script types are VBScript and JScript.

Table 96. Options for the LOAD SCRIPT file event

Option Remarks



ExampleTo load a script:

LOAD SCRIPT c:\test.vbs TYPE: VBScript





Table 96. Options for the LOAD SCRIPT file event (Continued)

Option Remarks


* MAKE DIRectory * indicates that this event is valid for ESD work objects.

Use this event to create a new Client or Server directory. As an ESD event, it creates the directory only if necessary. To display the Event Details window for the MAKE DIRectory event:

• On the Add Events menu, select Operating System and click MAKE DIRectory.

• Double-click a MAKE DIRectory event to edit an existing event.

One field specific to the MAKE DIRectory event:

• Directory Path. Specifies the path and directory name of the new directory. The path must exist for the event to be successful; MAKE DIR does not create the directories in the specified path. If no path is specified, the event uses the default path (<ServerData>\ on the Server and <ClientInstall>\ on the Client).

Table 97. Options for the MAKE DIRectory event

Option Remarks






ExampleTo create a directory on the Server before a communications session begins (or during a Process Only session):

SB MAKE DIR <ServerData>\Newdir



Table 97. Options for the MAKE DIRectory event (Continued)

Option Remarks


MESSAGE EXCHANGEThis event transfers the contents of the RemoteWare message queues between the Server and the Client. It is part of RemoteWare Messaging Services. To display the Event Details window for the MESSAGE EXCHANGE event:

• On the Add Events menu, select Server and click MESSAGE EXCHANGE.

• Double-click a MESSAGE EXCHANGE event to edit an existing event.

There are no event specific fields for this event.

ExampleThe command RemoteWare uses to exchange the message queues:

CD MESSAGE XCHG

Table 98. Options for the MESSAGE EXCHANGE event

Option Remarks





Execute During only, and On Client.


NOTIFY nt serverThe NOTIFY event sends a message to the specified Windows server process, using either a Windows NT server queue or named pipe. Servers can use this event to trigger processes on either a local Server (using queues) or on any LAN attached machine, including other clustered Servers (using named pipes). To display the Event Details window for the NOTIFY nt server event:

• On the Add Events menu, select Server and click NOTIFY nt server.

• Double-click a NOTIFY nt server event to edit an existing event.

Two event specific fields determine destination, method, and content of the notification:

• Server Queue or Server Named Pipe. Indicates which queue or named pipe to address. Use queues to send messages to the local computer; use pipes for local or LAN-based messages. Later in this section are queue and pipe name examples.

• Notify Text or @Indirect File. Optionally sends text to the destination Windows server. You can enter up to 270 characters in this field. You can include predefined variables (such as <Time>) anywhere in the text. The text can also come from an

Table 99. Queue and pipe name formats

Type Format Example

Queue /queues/<Queue Name> /queues/queue.que

Pipe \\<Server Name>\pipe\<Pipe name> \\RWS4\pipe\gate.pip

Note: Remember to use two backslashes “\\” in front of the Server name and forward slashes “/” in the queue name.


indirect file. Use the @ symbol before the name of the file that will be your source text (as in @C:\Notif.txt).

ExamplesTo awaken the ECF Server on the local computer in a Process Only session:

SA NOTIFY /Queues/rws/ecfservr.que x

To awaken the ECF Server on another computer:

SA NOTIFY \\Rws_serv_2\Pipe\Ecfservr.pip x

Use a variable and an indirect file Nottext.dat containing the notify text to perform a task on the local computer:

SB NOTIFY /Queues/<queue name> @Nottext.dat

To notify the Execution Server on a clustered Server connected to a mainframe to transfer files to the mainframe:

SB NOTIFY \\CommServer2\Pipe\Exe_serv.pip mf_send \Data\ <ClientName>.dat

Table 100. Options for the NOTIFY nt server event

Option Remarks





Execute On Server: Before, During, and After. Set to Before for Process Only sessions.

Important: In these two examples, place the x in the Notify Text or @Indirect File field, which is the second text box in the Event Details window.


Advanced applications of the NOTIFY event The Execution Server is a RemoteWare Server component that executes commands or starts programs on the Server. The commands originate from a NOTIFY event. The Execution Server works with both Windows NT queues and named pipes.

A typical application for the Execution Server occurs when there is a mismatch between the number of resources and the number of concurrent sessions that require a resource. For example, if you have 10 active sessions that require a micro-to-mainframe file transfer and only one micro-to-mainframe link is available, you can use the NOTIFY event to start the Execution Server.

To use the Execution Server, the program must be accessible to the Server and must not require user input or a user interface to run. Programs execute in the background, rendering interactive programs (those that require a user interface) useless. A user cannot terminate these programs normally; they occupy a resource on the Execution Server until their processes are stopped.

Starting additional Execution ServerTo start an additional Execution Server, the following files must be available in the locations listed below:

Exe_serv.exe <ServerInstall>\systemOS2map.dll <ServerInstall>\systemQueues.dll <ServerInstall>\systemRwsnls.dll <ServerInstall>\systemMsvcrt40.dll \winnt\system32

If you are starting an Execution Server on a RemoteWare Server or Workstation, these files are already present and should be in the path; you will not need to copy them. To start an Execution Server on another computer in the network (for example, to offload processor time when programs are executed), then you must create a directory on that computer, copy it, and run Exe_serve.exe from that directory using the following syntax (from a DOS command window):

Exe_serv -pn \\.\pipe\<pipename> -qn /queues/<queuename> -p#

The “.” period after the \\ is important. It enables the Exe_serv program to populate the machine name itself. The pipe name (-pn) uses backslashes “\” and the queue name

Note: The Notify command expects a DWORD return code from third party applications. A return of zero indicates success, anything else is logged. The solution is for the third party to change their application to write the DWORD 0 to the pipe after successfully reading the pipe data. If the third party application returns more data than the size of a DWORD, our application reports the error “more data expected”.


(-qn) uses forward slashes “/”. You can use any name you want for the <pipename> and <queuename> (for example, Update.pip and Update.que). The -p# should be the number of threads the Execution Server can use. By default, this is (p2) if no p# parameter is used. This means that four different programs can be executed at the same time.

Once this process is started, the DOS window will be occupied by the process and cannot be used for anything else. You can see the Notify events in this window when the Execution Server is notified.

In a work object, the syntax for the Notify event is:

Notify \\machinename\pipe\<pipename> program

An example of this is:

Notify \\se_cluster\pipe\update.pip c:\update.bat

You must specify the machine name if it is local or another machine on the same network. A queue is used for local executes and notifies; a pipe is used to notify either a local pipe or a pipe on another machine.


READ INI FILE This event sets variables by reading values from an .ini file and placing those values into a user-defined variable.

To display the Event Details window for the READ INI FILE event:

• On the Add Events menu, select Session Control and click READ INI FILE.

• Double-click a READ INI FILE event to edit an existing event.

Two event specific fields:

• Filename. The name of the variable file to be read.

• User Variable Name. The name of the user variable whose value is to be set. [Section] is an optional parameter which enables you to specify a section of the .ini file.


Table 101. Options for the READ INI FILE event

Option Remarks




The following examples use the sample .ini file shown below:

Test.ini [Section1]Help=TrueUser=TestUser


To place the value of the test1.ini file’s Help item in Section 1 into user variable [Section1].Help:

READ INI FILE C:\Directory\test1.ini <%[Section1].Help>

Result:

To create variables for all Help items in the test.ini file:

READ INI FILE C:\Directory\test1.ini <%.Help>

Result:



Execute On Server: Before, During, and After. Set this event to Before for a Process Only session.

User variable Value

<%[Section1].Help> True

User variable Value

<%[Section1].Help> True

<%[Section2].Help False

Note: To write values to an .ini file, see “WRITE INI FILE” on page 566. Or, to delete an .ini file variable, see “DELETE INI FILE” on page 488.

Table 101. Options for the READ INI FILE event (Continued)

Option Remarks


REBOOT Client at end of session Use this event to reboot a DOS or Windows Client at the end of a session. To display the Event Details window for the REBOOT event:

• On the Add Events menu, select Session Control and click REBOOT Client at end of session.

• Double-click a REBOOT event to edit an existing event.

Table 102. Options for the REBOOT Client event

Option Remarks



Execute On Client: During only.


RELEASE SCRIPT (Windows Clients only)

Use this event to release a specific instance of a script engine. Releasing a script also frees up the cache and any scripting resources.

To display the Event Details window for the RELEASE SCRIPT file event:

• On the Add Events menu, select Scripting and click RELEASE Script.

• Double-click a RELEASE Script event to edit an existing event.

The field specific to the RELEASE SCRIPT event:


Table 103. Options for the RELEASE SCRIPT event

Option Remarks






ExampleTo release a script:

RELEASE SCRIPT c:\test.vbs


Table 103. Options for the RELEASE SCRIPT event (Continued)

Option Remarks


REMOVE DIRectoryUse this event to delete a Client or Server directory. The directory must be empty of subdirectories or files before it can be removed. To display the Event Details window for the REMOVE DIRectory event:

• On the Add Events menu, select Operating System and click REMOVE DIRectory.

• Double-click a REMOVE DIRectory event to edit an existing event.

One field specific to the REMOVE DIRectory event:

• Directory Path. The full path and name of the directory to be removed.

Table 104. Options for the REMOVE DIRectory event

Option Remarks



Work Object Critical Event Stops the work object if this event fails. When selected, disables the Critical event and the Not required for successful session options.





ExampleTo remove an empty Client directory:

CD REMOVE DIR C:\DOS


RENAME file(s)Use this event to move files or change the name of one or more files on either the Server or a Client. To display the Event Details window for the RENAME file(s) event:

• On the Add Events menu, select Operating System and click RENAME file(s).

• Double-click a RENAME file(s) event to edit an existing event.

Two fields specific to the RENAME file(s) event:

The RENAME command does not support the “?” wildcard.

• Old Filename or Wild Card. Specifies one or more source files to move or rename. If this event runs on the Server, click Select File to choose a path and file. When no path exists, the event uses the default <ServerData>\ directory for Server events and <ClientInstall>\ for Client events.

• New Filename or Directory or Wild Card. Enter the path and new file name, or the wildcard when more than one file is involved. Enter a directory to move one or more files without changing their names. Remember to end the directory name with a backslash (for example, C:\data\files\).

The event is logged as unsuccessful if there is already a file with this name. Renaming multiple files is also logged as unsuccessful if one of the files matching the wildcard already exists. In this case, the event does not rename subsequent files that match the wildcard. When no path exists, the event uses the default <ServerData>\ directory for Server events and <ClientInstall>\ for Client events.

Table 105. Options for the RENAME file(s) event

Option Remarks



To rename one Server file:

SA RENAME <ServerData>\Files\Oldfile.txt TO <ServerData>\Files\Newfile.txt

To rename all .dat files at a Client and place them in another directory:

CD RENAME C:\*.dat TO D:\Data\*.old

To move all .exe files in a Server directory to another directory:

SB RENAME F:\Hsx\*.exe TO D:\Bin\Hsx\





Table 105. Options for the RENAME file(s) event (Continued)

Option Remarks


REPeat IF previous event FALSE / TRUEUse these events to conditionally repeat a block of events. A REPeat block of events begins with the REPeat event and ends with an END REPEAT. REPeat IF previous event FALSE executes the event block if the previous event failed. REPeat IF previous event TRUE executes the block of events if the previous event was successful.

To display the Event Details window for the REPeat event:

• On the Add Events menu, select Session Control and click REPeat IF previous event FALSE or REPeat IF previous event TRUE.

• Double-click a REPeat event to edit an existing event.

If the REPeat condition is satisfied on its first encounter, the session executes every event in the REPeat block at least once. After the first pass through the events, the last event in the REPeat block determines if the loop repeats or if the next event after the REPeat block executes. Continued execution of the REPeat block depends on this last event’s status, but it can also be terminated by reaching one of three limits. The limit can be a timeout, an inactivity timeout, or a maximum number of repetitions.

These event specific fields determine when a REPeat loop terminates:

• Max Timeout. The maximum amount of time the REPeat block may execute repeatedly. The value may range in minutes and seconds from 00:00 (no max timeout; rely on other limits) to 59:59 (approximately 1 hour). The REPeat block finishes its current iteration after reaching the Max Timeout value.


• Inactivity Timeout. The maximum amount of time that execution of the block continues when no file transfer occurs. The value may range in minutes and seconds from 00:00 (no inactivity timeout; rely on other limits) to 59:59 (approximately 1 hour). If no activity occurs for that amount of time, the session finishes executing the current repetition. A timeout does not stop executing events in mid-block.

• Max Repeats. The maximum number of iterations for this REPeat block. Select from 0 (no limit) to 99 repetitions. Execution stops after the block has been performed the maximum number of times.

There are no options or execute settings for this event.

Like IF events, REPeat events can be nested inside one another.

ExampleIn this example, if a Client has requests for a database, it creates a control file called “Query.ctl” for the Server. If the file is found, the result of the first get FILE STATUS event is true, and the REPeat block executes.

The events in the REPeat block retrieve Client requests, query the database, and wait for a response. If the Server’s database generates any responses within thirty (30) seconds, then the responses are sent back to the Client. When the Client has no more requests, another process removes the Query.ctl file, and the block of events terminates.

CD FILE STATUS C:\Dbase\Query.ctl REP IF TRUE 10:00 5:00 50 D GET <ServerData>\Db\ FROM C:\Dbase\*.reqSD EXECUTE E:\bin\Db\Database.exeSD WAIT <ServerData>\Db\Query.rsp :30 D SEND <ServerData>\Db\*.rsp TO C:\Dbase\CD FILE STATUS C:\Dbase\Query.ctl END REPEAT

This REPeat block continues until one of these conditions occurs:

• Query.ctl is not found.• 10 minutes have elapsed in this event block.• 5 minutes have passed with no activity.

Note: If no limit is set for timeouts or repeats, a session could become caught in an endless loop.

Important: All events in the block must be During events. Before or After events in a REPeat block generate an error when you try to leave the Events window. An error message appears if you try to leave the Events window when the REPeat block does not end with an END REPEAT event.


• 50 repetitions have been completed.The Session Log shows only the last occurrence of the block. When a REPeat event is displayed, the block of events is indented for readability.


RUN SCRIPT FUNCTION (Windows Clients only)

Use this event to invoke a specific scripting function. The RemoteWare administrator provides the scripting function and any parameters or arguments passed to the function.

To display the Event Details window for the RUN SCRIPT FUNCTION event:

• On the Add Events menu, select Scripting and click RUN Script Function.

• Double-click a RUN Script Function event to edit an existing event.

Fields specific to the RUN SCRIPT FUNCTION event:


• Function Name. The name of the script function provided by the RemoteWare administrator. Maximum length is 127 characters.

• Argument List. A comma-delimited list containing either text or numeric values, or session variables.

• Return Variable. (Optional) Must be a non-null, user-defined session variable. Maximum length is 127 characters.

Table 106. Options for the RUN SCRIPT FUNCTION event

Option Remarks



ExampleTo invoke a specific scripting function:

RUN SCRIPT FUNCTION c:\test.vbs Func1 <ClientName>, 10 <%RetVar>





Table 106. Options for the RUN SCRIPT FUNCTION event (Continued)

Option Remarks


*† SEND file(s) to Client * indicates that this event is valid for ESD work objects. † indicates that this event is valid for Multicast work objects.

Use this event to transfer one or more Server files to a file or directory on the Client. Using wildcards with this event transfers a group of Server files whose names have something in common or are in the same directory.

To display the Event Details window for the SEND event:

• On the Add Events menu, select File Transfer and click SEND file(s) to Client.

• Double-click a SEND event to edit an existing event.

Three fields specific to the SEND event:

• Server Filename or Wild Card. Indicates which directory or files to send to the Client. Enter the file name, path name, or directory on the Server. Click Select File to choose a file, or use wildcards to send files of the same type or that exist in one directory. If this field is blank or the file name has no path, RemoteWare uses the default <ServerData>\ directory.

• Client Filename or Wild Card or Directory. Places one or more Server files in this location at the Client. Specify the file name, wildcard parameter, or directory for the Client file(s). The default path value is the <ClientInstall>\ directory.

• Client Acknowledgement timeout (mm:ss). This box is displayed only for Multicast. The amount of time the system should wait for acknowledgement from all the Clients that the file has been received.

Note: For multiple files, the Server always assumes that the destination is a directory. For single files, directories must use a backslash “\” as the last character in the path name, otherwise the Server assumes the name to be the destination file name. See the following examples for details.


• Multicast Channel. This box is displayed only for Multicast. The Multicast channels to use to broadcast the RemoteWare event. The channels, as defined in your Client’s Multicast configuration file (fx.conf), must have a case-sensitive match with the name in the RemoteWare event. You must include any channel names in parentheses. Delimit multiple channels with a comma, without any spaces. Examples:

• (eastcoast)

• (EASTCOAST,WESTCOAST)

The options available for the SEND event include:

Note: All Multicast clients that are configured to listen to the named channels receive the associated files, regardless of whether they are assigned to the RemoteWare session. However, only Clients that are assigned to the session are captured in RemoteWare logs. The Multicast FX Monitor program does capture the activity for all of the receiving Multicast clients.

Table 107. Options for the SEND event

Option Remarks

Byte Level Differencing This detects differences between file versions at the Server and the Client and sends only the differences to the Client or Server, which reduces the time required to update files and software.

Xpress Transfer Speeds up the transfer of the SEND and GET events over TCP/IP connections by removing all packet and window sizing, along with the RemoteWare protocol. See “Notes on Xpress Transfer option” on page 545 for more information.

Do not overwrite Does not copy over an existing file if its name matches that of the destination file.

Safe transfer (Selected by default.) Ensures that files are not corrupted during transfer from Server to Client. Do not clear this check box unless space is limited on the Client or potential corruption of the destination file is not important.

Check updates only (Selected by default.) Instructs the Server to transfer only files with different sizes or dates.

Check if newer Transfer occurs only if the Server file does not exist or the file is less recent than Client file.

Delete after (-) Deletes the Client file if transfer is successful.



Notes on Xpress Transfer optionXpress Transfer option can be enabled in the Work Object Editor and the Worklist Editor.

Xpress Transfer is available for the following:

• Windows and Linux Clients • TCP/IP connections only

• ESDXpress Transfer is not available for the following:

• Interactive Session• Worklist ECF

Xpress Transfer and unsupported Clients

If you are connecting to an unsupported Client type, Xpress Transfer is ignored.

Xpress Transfer with Checkpoint Restart

To use Checkpoint Restart with Xpress Transfer, select the Xpress Transfer and Safe Transfer options only.

Turn compression off Prevents file compression for this event only.


Critical event (Retry) Stops the session if this event fails. When selected, disables the Work Object Critical Event option.




Do not use Multicast Access File Prevents the use of the access list so all “listening” Multicast clients can receive files on a per event basis only.

Execute On Client: During only. On Client, in Multicast work object: Before only.

Table 107. Options for the SEND event (Continued)

Option Remarks


Xpress Transfer within a quota block

Xpress Transfer disregards any Quota Block events.

File transfer indicators

During the transfer of smaller files, the RemoteWare Client Status and Network Status may indicate 0% because of the refresh rate. The files successfully transfer.

ExamplesTo transfer and rename one Server file to the Client:

D SEND <ServerData>\FileA.dat TO <ClientInstall>\FileB.dat

To send a Server file to a Client directory:

D SEND <ServerData>\FileA.dat TO C:\Data\

To send all .dat files in a Server directory to a Client directory, changing the extension to .dbf:

D SEND <ServerData>\Info\*.dat TO C:\Data\*.dbf


SET Client TIME This event checks and resets, if necessary, the clock on the Client to match the time on the Server machine. You can add this event to a worklist in the Work Object Editor or Worklist Editor programs.

• On the Add Events menu, select Operating System and select SET Client TIME.

• Double-click an existing event to display an empty Event Details window.There are no fields and no options for the event. SET Client TIME only executes on a Client during the session.

ExampleThe event is always listed in the worklist as:

CD SET CLIENT TIME


SET file ATTRIButesUse this event to modify an attribute of a file on a Windows/DOS or UNIX Client. For example, you could use this event to change a file to Hidden or Read-Only if the Client user is not authorized to view or edit the file, respectively. To display the Event Details window for the SET file ATTRIButes event:

• On the Add Events menu, select Operating System and click SET file ATTRIButes.

• Double-click a SET file ATTRIButes event to edit an existing event.

Three fields specific to the SET file ATTRIButes event:

• Filename. The path and name of the Client file to modify.

• FAT Attributes. For Windows or DOS files, indicates the attribute(s) to modify.

• UNIX Attributes. For UNIX files, indicates the attribute(s) to modify. You can specify that the file’s attribute(s) be changed for all Clients (W, or World), a Group (G), or an individual Client (U, or User).


ExampleCD SET ATTRIBUTE C:\SysFile1.dat to SystemCD SET ATTRIBUTE C:\Games\Solitaire.exe to HiddenCD SET ATTRIBUTE C:\Winnt\System32\Notepad.exe to Normal

Table 108. Options for the SET file ATTRIButes event

Option Remarks






Execute On Server: Before, During, After.On Client: During only.


SET REGISTRY VALUEUse this event to set a value in the registry to a specified string. The string may contain system, user, or environment variables.

To display the Event Details window for the SET REGISTRY VALUE event:

• On the Add Events menu, select Operating System and click SET REGISTRY VALUE.

• Double-click a SET REGISTRY VALUE event to edit an existing event.

Three fields specific to the SET REGISTRY VALUE event:

• Root key\key1\keyN. Specifies the complete path and name of the registry key value to be set. This event fails if the path is not a valid registry path or the key does not exist, unless you select the Make Destination Path check box. If the value already exists in the specified key, it will be overwritten.

This parameter supports the use of the following abbreviations:HKLM = HKEY_LOCAL_MACHINEHKCU = HKEY_CURRENT-USERHKCR = HKEY_CLASSES_ROOTHKU = HKEY_USERS

• Variable or value. Indicates the string or variable to set as the registry value. The string cannot exceed 255 characters when expanded. If it does, then the value is truncated to 255 characters.

• Value type. Specifies whether the value is a string or DWORD.



ExamplesTo set a value in the registry to a specified string:

CD SET REGISTRY HKEY_CURRENT_USER\Temp\Value C:\Temp [String]

To set a DWORD value:

CD SET REGISTRY HKEY_LOCAL_MACHINE\Software\MyCompany\<ClientName>\NumericVal 15 [DWORD]

Table 109. Options for the SET REGISTRY VALUE event

Option Remarks





Make destination path Establishes a destination path for the event and creates directories when necessary.



SET VARiableUse this event to create user-defined variables. Once you define a user variable, you can use it anywhere in a session, including other work objects. A user-defined variable does not preserve its data across sessions.

To display the Event Details window for the SET VARiable event:

• On the Add Events menu, select Session Control and click SET VARiable.

• Double-click a SET VARiable event to edit an existing event.

Use the two event specific fields to set the variable name and its value:

• User Variable Name. Specifies the name for this user defined variable. The default value is <%variable-name>. Replace variable-name with a new name of your choosing, such as <%IntlDate>. See the examples later in this section. You can use up to 255 characters for the variable name.

• Value or @Indirect File. Sets the variable’s value or specifies the name of the file that contains the value. To choose a Server file, click Select File. This field may contain a path and file name to a text file, or any combination of text, numbers, predefined variables, or previously defined environment and user variables. When using a file, remember to precede the path and file name with an “@”, such as @C:\Q2.TXT.

Note: The variable names should be unique throughout all work objects in a session. Using SET VARIABLE on a previously defined variable will change the value. Although this may be needed for some applications, it can lead to unexpected results and side effects across work objects.


ExamplesThe first example shows how to set the <%IntlDate> variable to a short version of today’s date, such as 24-06-08 for June 24, 2008, and then use this variable in an alarm.

D SET VARIABLE <%IntlDate> <m>-<d>-<y>SD USER ALARM <%IntlDate>: Production Schedule begins.

To set a variable to a static value:

A SET VARIABLE <%kilobyte> 1024 D SET VARIABLE <%DatabasePath> C:\Dbase\

To set a variable from the value of other variables:

B SET VARIABLE <%ClientID> Client <ClientName> connected on <%IntlDate>.

To set a variable from a file:

D SET VARIABLE <%MessageOfTheDay> @C:\Messages\Motd.txt

Table 110. Options for the SET VARiable event

Option Remarks





Execute On Server: Before, During, and After. Set this event to Before for a Process Only session.


SET VARiable in SCRIPT (Windows Clients only)

Use this event to allow the session to set a global script variable used by the script in subsequent calls to script functions.

The RemoteWare administrator provides the name of the global script variable name and script variable value.

To display the Event Details window for the SET VARiable in SCRIPT event:

• On the Add Events menu, select Scripting and click SET Script Variable.

• Double-click a SET VARiable in Script event to edit an existing event.

Fields specific to the SET VARiable in SCRIPT event:


• Script Variable Name. The name of the script variable provided by the RemoteWare administrator.

• Script Variable Value. The value for the script variable as provided by the RemoteWare administrator. The value can contain a session variable.

Table 111. Options for the SET VARiable in SCRIPT event

Option Remarks



ExampleTo allow the session to set a global script variable:

SET SCRIPT VAR c:\test.vbs Name = <ClientName>





Table 111. Options for the SET VARiable in SCRIPT event (Continued)

Option Remarks


TEST if Client is in GROUP For a discussion of assignments and Client groups, see “Assignments property page” on page 144.

Use this event to determine if the current Client associated with this session is a member of a specified Client group. Some examples for the use of this event include setting a condition to not call a Client in group NIGHT during the day shift, or to stop a session scheduled to update a Client’s sales records before the figures have been received. The event is successful if the Client is directly or indirectly assigned to the Client group.

To display the Event Details window for the TEST GROUP event:

• On the Add Events menu, select Session Control and click TEST if Client is in GROUP.

• Double-click a TEST GROUP event to edit an existing event.

One field specific to the TEST GROUP event:

• Client Group Name. The session tests if this Client group includes the currently connected Client. Specifies the Client group name as it appears in the Name column of Client Profile. Type the value in the text box, or click Select Group to choose a defined Client group name.

Table 112. Options for the TEST GROUP event

Option Remarks




ExamplesTo determine if this Client is a member of the BIGCORP Client group:

SD TEST GROUP BigCorp

You can use the TEST GROUP event to transfer different data based on the Client. In the following example, the current Client receives the files in the first IF block if the Client is directly or indirectly assigned to the NTCLIENT Client group. Otherwise, the transfer in the ELSE IF block takes place.

SD TEST GROUP NTCLIENT IF previous event TRUE D SEND D:\WINNT35\Updates\*.ttf TO C:\WINNT35\System\ D SEND D:\WINNT35\Updates\*.fot TO C:\WINNT35\System\ ELSE IF Send files for a non-NT system. D SEND D:\Win3x\Updates\*.ttf TO C:\Windows\System\ D SEND D:\Win3x\Updates\*.fot TO C:\Windows\System\ END IF



Execute On Server: Before, During, and After. Set to Before for Process Only events.

Table 112. Options for the TEST GROUP event (Continued)

Option Remarks


TEST VARiableUse this event to test predefined or user-defined variables by comparing the variable to a known value. The session evaluates the variable and the result is compared to the specified value. To display the Event Details window for the TEST VARiable event:

• On the Add Events menu, select Session Control and click TEST VARiable.

• Double-click a TEST VARiable event to edit an existing event.

Two fields specific to the TEST VARiable event:

• Variable(s) and/or Text. The variable or text string to evaluate and compare with the value in the second field. You can use up to 260 characters in this field.

• Variable(s) and/or Text. The variable or text string to compare with the value in the first field. You can use up to 260 characters in this field.

Table 113. Options for the TEST VARiable event

Option Remarks






ExampleThe first event in this example determines if the evaluated variable is 01/01. If so, it runs the second event. The user alarm has the Conditional/True (&) option enabled.

D TEST VARIABLE <m>/<d> 01/01&SA USER ALARM Happy New Year!

Execute On Server: Before, During, and After. Set to Before for Process Only sessions.

Table 113. Options for the TEST VARiable event (Continued)

Option Remarks


UNASSIGN from clientUse this event to unassign either the work object or the session from the Client, depending upon the value selected in the Event Details window. The method of assignment between the Client and the work object and session (which contains the work object) determines whether the object or session is affected.

The UNASSIGN event never alters the assignments between the session and the object. Results of this event take effect during the next connection; that is, the work object or session continues to execute during this connection after the event has occurred.

To display the Event Details window for the UNASSIGN from client event:

• On the Add Events menu, select Server and click UNASSIGN from client.

• Double-click an UNASSIGN from client event to edit an existing event.

Table 114. Unassignment outcomes

If... Then the UNASSIGN from client event...

A work object is directly assigned to the Client Unassigns the work object from the Client.

A session is directly assigned to a Client and contains a work object with the Unassign event

Unassigns the session from the Client.

Note: It is not recommended to use the UNASSIGN from client event on system-owned sessions, such as RWS Default Inbound.


One field specific to the UNASSIGN event:

• Unassign From. Select either WORKOBJECT or SESSION. By default, the event unassigns the work object from the Client.

If you want to unassign a session or work object from more than one Client, you can modify the following registry key values:

• HKLM\Software\Remoteware\Server\UnassignRetry. Determines the number of retries; the default setting is 10 retries. You can also use this value to designate the number of Clients from which you want to unassign the object or session. Each Client represents one retry.

• HKLM\Software\Remoteware\Server\UnassignTimeout. Indicates the time in seconds between each retry. The default setting is two seconds.

ExamplesTo unassign a session from one Client after the connection ends:

SA UNASSIGN SESSION

To unassign a work object from one Client during the session:

SD UNASSIGN WORKOBJECT

Note: It takes one second per client to complete the unassign event. If you are using the unassign event for several hundred clients, it may take several minutes to complete the unassign.

Note: Registry keys UnassignRetry and UnassignTimeout, must first be manually created as DWORD values.

Table 115. Options for the UNASSIGN from client event

Option Remarks


Conditional (True/False) Executes this event only if the previously executed event ended with a true/successful or false/failed value.


Note: If you plan to use this worklist in a Process Only session, select the Before option (under Execute).


USER defined ALARMUse this event to display a message of your choice in the Server Log. In addition, the most recent alarm appears in the Network Status program.

To display the Event Details window for the USER defined ALARM event:

• On the Add Events menu, select Server and click USER defined ALARM.

• Double-click a USER defined ALARM event to edit an existing event.

One field specific to the ALARM event:

You can also use the Filter by Text button with the RWS0010 string to search the Server Log. This locates all user alarm messages.

• Message Text or @Indirect File. Defines the alarm content and format placed in the Server Log. Type the alarm message text (up to 80 characters) or specify an indirect file containing the text. The message can contain any character, predefined variable, user defined variable, or environment variable. The @ symbol must precede an indirect file name (for example, @C:\alarm.txt).

When the event executes, the Alarms item in Network Status displays the most recent user alarm. To view every alarm message, go to Log Viewer and click Server Message Logs and view by User. If the message exists in an indirect file, only the first line of the file displays in the log.

Table 116. Options for the USER defined ALARM event

Option Remarks




ExamplesTo place a text message in the Server Log:

SB USER ALARM Processing complete - no errors.

To use variables in the message text:

SB USER ALARM <d>-<m>-<y> / <h>:<m>:<s> ; <ClientName> session <%status>.

To use an indirect file to specify the USER ALARM text:

SB USER ALARM @D:\RWS\MSGS\Usralarm.txt



Execute On Server: Before, During, and After. Use Before for Process Only sessions.

Table 116. Options for the USER defined ALARM event (Continued)

Option Remarks


WAIT for file to existThe WAIT event instructs the session to pause until a Client or Server file exists, or a specified amount of time elapses, whichever comes first. If this is a During event, the Server does not interrupt the connection while the event waits. The session successfully continues with the next event if the file is found. If the file is not found before the specified time runs out, the session logs a “File not found” error for the event and continues to the next event.

To display the Event Details window for the WAIT event:

• On the Add Events menu, select Operating System and click WAIT for file to exist.

• Double-click a WAIT event to edit an existing event.

Two fields specific to the WAIT event:

• Filename. Identifies the Client or Server file to locate. If the event occurs on the Server, click Select File to select a Server file; you can also type the path and file name in the text box. If you do not specify a path, the Server uses the default <ServerData>\ for Server files and <ClientInstall>\ for Client files. This parameter supports the use of wildcards.

• Wait time (mm:ss). Specifies the time, in minutes and seconds, to wait for the file to exist. Use the keyboard and spin box to set the delay time. Times can range from :00 (instantaneous) to 59:59 (approximately 1 hour).

Note: Consider using the get FILE STATUS event if your wait time is close to :00. For details, see “get FILE STATUS” on page 509.


ExamplesTo wait two (2) minutes for a Client file to appear, then erase the file:

-CD WAIT D:\Prog\Core 2:00

To wait ten (10) seconds for a Server file:

-SA WAIT <ServerData>\Db\Dataout.dbf :10

Table 117. Options for the WAIT event

Option Remarks

Delete After Removes the file once it appears. Use this option to clean up flag files or large list files that are not needed.







WRITE INI FILEUse this event to set variables by writing value(s) to an .ini file and placing that value into a user-defined variable. For example, you can replace an existing variable in a Client’s .ini file with a new variable that you define.

To display the Event Details window for the WRITE INI FILE event:

• On the Add Events menu, select Session Control and click WRITE INI file.

• Double-click a WRITE INI FILE event to edit an existing event.

Two fields specific to the WRITE INI FILE event:

• Filename. Specifies the path and name of the Client .ini file you want to modify.

• User variable name. Indicates the name of the user variable whose value is to be set. [Section] is an optional parameter; you can use it to specify a particular section of the .ini file, if necessary.


Note: The user variable must already exist. Enter a previously defined user variable in the User variable name field.

You can define a new variable with a SET VARiable event. It should be placed in the worklist before the WRITE INI FILE event so that it is created before the WRITE INI FILE event runs.


ExampleB SET VAR <%[Location].Path> C:\data\SD WRITE INI FILE C:\MyApp.ini <%[Location].Path>

ResultThe example events result in the following item in MyApp.ini:

[Location]Path = C:\data\

Table 118. Options for the WRITE INI file event

Option Remarks






A P P E N D I X

B

RemoteWare System Limits

The RemoteWare system includes known operating limits. Consider operational limits

as you plan and execute RemoteWare tasks.


• “Work Object Editor Limits” on page 570

• “Session Editor Limits” on page 571

• “Schedule Manager Limits” on page 572


Work Object Editor LimitsThe following table identifies the limits for Work Object Editor operations.

*These limits can be exceeded through the use of Application and Application Group objects. For more information, see “Object assignment fundamentals” on page 202.

Table 119. System limits in Work Object Editor

Attribute Limit

Total work objects 5000

Objects assigned to a Client 200*

Objects assigned to a session 200*

Objects directly assigned to a group or session 200

Objects executed in a session 1000

Application or Application Group objects assigned to a user 256

S e s s i o n E d i t o r L i m i t s 571

Session Editor LimitsThe following table identifies the limits for Session Editor operations.

*These limits can be exceeded through the use of Application and Application Group objects. For more information, see “Object assignment fundamentals” on page 202.

Table 120. System limits in Session Editor

Attribute Limit

Total sessions 8000

System-defined sessions 5

Administrator-defined sessions 7995

Sessions per Client 250

Directly assigned objects per session 200

Total objects per session 1000


Schedule Manager LimitsThe following table identifies the limits for Schedule Manager operations.

Table 121. System limits in Schedule Manager

Attribute Limit

Total sessions 65,535

A P P E N D I X

C

External Configuration Files

External Configuration Files (ECFs) provide a way to create, change, or delete any

RemoteWare resource, Client, object, or session without using the Windows or

RemoteWare user interface. The ECF Server detects, processes, and executes ECFs,

which are text files. The GEN utilities are a related set of utilities that create ECFs

based on current system settings.


• “ECFs at a glance” on page 574

• “Guidelines for using ECFs” on page 577

• “ECF properties” on page 580

• “The GEN utilities” on page 630


ECFs at a glance For assistance with Subscriber ECFs, refer to the RemoteWare Subscriber Administrator’s Guide.

ECFs provide a way to build work objects, define scheduled sessions, configure Clients and Client groups, and perform Server maintenance without using RemoteWare’s graphical user interface. Use ECFs to save time when you create many Clients or objects, or when manipulating the Server(s) from another computer system with a text based interface. The following table lists the ECF types; each type is described later in this chapter.

Table 122. ECF types

ECF Type Description Details on page

DIAL_SCRIPT Dial Script ECFs add, update, or delete the dial scripts defined in the Server.

580

LD_SERVICE Long Distance Service ECFs add, update, or delete long distance definitions.

582

MODEM Modem ECFs add, update, or delete modem definitions. 583

CLIENT Client ECFs add, delete, update, unregister, or copy Clients. 586

CLIENT_GROUP Client Group ECFs add, copy, and delete Client groups. 593

PORTABLE_SECURITY

Portable Security ECFs add or update Portable users. 595

PROTOCOL Protocol ECFs modify Server protocol definitions. 596

RESOURCE Resource ECFs change the resource configuration for a particular Server or Servers.

598

SCHEDULER Scheduler ECFs schedule sessions to Clients and Client groups. 602

SESSION Session ECFs set session attributes such as schedule type and basis, start times and dates, retry intervals, and session priority. Session ECFs can also assign and unassign objects, Clients, and Client groups to sessions.

604

WORK_OBJECT Work Object ECFs modify work object definitions on the Server.

609

SYSTEM System ECFs change global Server settings and set Client registration preferences.

613

WORKLIST Worklist ECFs copy, delete, rename, and build new worklists. 617

MSG_ADMIN Messaging Administration ECFs control the Message Transfer Agent (MTA) and message logging functions.

625

E C F s a t a g l a n c e 575

The ECF is a specially formatted ASCII text file that includes special keywords. You can generate these files with any text or word processing program (such as Notepad), or with a custom application. To be active, each ECF file must use an .ecf extension and reside in the ECF data file directory. By default, this directory is \ecf on the data drive and path where the Server was installed. For ECF settings, see “ECF Server command options” on page 575.

ECF Server The RemoteWare Server service starts the ECF Server program.

The ECF Server periodically checks for .ecf files in the ECF data file directory and processes any files it finds. You can modify ECF Server options in the Administrator program on the Command Options page located in the Server Control and Options window. For details, refer to the following section, or see “Command Options property page” on page 56. All ECF Server activities appear in the Server Log.

When the ECF Server processes an ECF, it temporarily gives the ECF file an .ecp extension. If the ECF Server encounters an error, it renames the file using an .ece extension. Otherwise, the ECF Server renames the processed file with an .ecb extension. The Server deletes all .ecb and .ece files after 24 hours.

ECF Server command optionsYou can modify ECF Server’s activity and behavior in the Administrator program. For additional information, see “ECF Server Options dialog box” on page 57.

• Serialize Between Clustered Servers. Use this option on clustered Servers to prevent two or more ECFs from trying to modify items simultaneously.

• Quiet Mode, No Messages Logged to Server Log. By default, each time an ECF is processed by the ECF Server, the RemoteWare Server logs the activity to

USER User ECFs create, modify, and delete RemoteWare users in the user directory.

627

USER_GROUP User Group ECFs create, delete, and modify user member assignments.

629

Note: In order to avoid processing an ECF before its creation is complete, give the file an extension other than .ecf, or create it in a directory other than the \ecf data file directory. Once the ECF is complete, you can rename it with an .ecf extension or move it to the \ecf directory.

Table 122. ECF types (Continued)

ECF Type Description Details on page


the Server Log. If you are processing a large number of ECFs, you may not want these ECF informational messages to fill the Server Log. Selecting this option causes logging to occur without the following messages: RWS2015: ECF Server: File filename ReceivedRWS2022: ECF Server: No errors for filename.ECF, backed to filename.ECBRWS2024: ECF Server: Errors for filename.ECF, backed to filename.ECE

Other ECF Server action messages, such as errors, modifications, deletions, and updates, are still logged.

• Use a Custom Update Time. By default, the ECF Server checks the ECF data file directory every 60 seconds. Change this setting if your installation requires that the files be processed at a different time interval.

• Use a Custom ECF Data File Directory. By default, the ECF Server uses the \ecf directory on the Server data drive. Specify a path or UNC path name to change the location of the ECF data file directory.

Polling for ECFs immediately

For more information, see “NOTIFY nt server” on page 525.

There are two ways to signal the ECF Server to poll immediately. From a session, use the NOTIFY event in the format below.

NOTIFY /QUEUES/rws/ecfservr.que x

You can also issue the previous command during an interactive session.

Important: You must place the x in the Notify Text or @Indirect File field, which is the second text box in the Event Details window. The x can be any character; it acts as a short message needed to start the ECF Server.

G u i d e l i n e s f o r u s i n g E C F s 577

Guidelines for using ECFsAlthough each type of ECF has its own keywords and format, there are a few guidelines that apply to all ECFs. This section describes the keywords and options that you will see in many of the ECF types.

Understanding the Action keywordsEvery ECF type has one or more ACTION= options available. Use these keywords to create, modify, or delete an item. In addition, some of the actions allow the Server to decide how to proceed without issuing an error. Some of the more common actions include:

• COPY. Uses an existing item as the basis for one or more new items. An error occurs if the source item does not exist, or if one or more new items exist.

• ADD. Builds a new item. If the item’s specified name already exists, an error appears in the Server Log and the definition is not added.

• UPDATE. Modifies one or more settings for the specified item. Produces an error if the item name does not exist.

• ADD_OR_UPDATE. Creates a new item if the item name does not exist, or modifies a current item. Suitable for refreshing or recreating a definition.

• ADD_IF_NOT_DEFINED. Creates a new item if the specified item name does not exist. If the item exists, makes no changes. Use when you want to preserve any current items and settings, but do not want the ECF to issue an error.

• DELETE. Removes the specified item name and definition. An error occurs if the item does not exist.

• RENAME. Changes the item’s name, keeping all other settings constant. Produces an error if the source name does not exist, or if the target name already exists.

Linking ECFsBy default, the ECF Server processes ECFs in the order in which they are found in the ECF data directory. You can include multiple ECF types in one file to control the processing order. You can also use the NEXT_ECF and NEXT_ECF_ON_ERROR keywords to process more than one file in a particular order. This keyword links to the


next specified ECF for both a successful and unsuccessful condition. The first ECF in the link uses the .ecf extension, but ECFs being linked need to have the .ecn file extension. For example:

Building ECFsKeep in mind these tips as you create ECFs:

• You can include more than one type of ECF in a single ECF file.

• To avoid processing an unfinished ECF, create ECFs in a directory other than the ECF data file directory (usually \ecf in the Server’s installation drive), or give the new file an extension other than .ecf, such as .txt. Once the file is complete, move it to the ECF data file directory or rename it with an .ecf extension.

• To be processed by the ECF Server, ECF file names must include an .ecf extension.

• Each ECF must follow the correct format for that ECF type. Refer to the later sections in this chapter for descriptions of each ECF’s format.

• If you encounter problems building an ECF and do not understand why, consider examining how the Server creates that ECF type. Using the appropriate Server program, define the item, then run the corresponding GEN utility to create the ECF. For more information, see “The GEN utilities” on page 630.

• TYPE keywords indicate the type of ECF: TYPE=DIAL_SCRIPT.

• GROUP keywords indicate the name of the item: DIAL_SCRIPT=DialScriptName.

• ACTION keywords indicate the action to perform on the item: ACTION=UPDATE.

• Specify TYPE keywords before GROUP keywords and GROUP keywords before ACTION keywords. For example:

• The ECF has the same constraints as its related RemoteWare program. For example, the capabilities of a Resource ECF are the same as the capabilities of the Server Profile program.

• The ECF is also limited by hardware and software. For example, if you do not have the cluster option installed, you cannot configure additional Servers using the

NEXT_ECF = goodecf.ecn

NEXT_ECF_ON_ERROR = error.ecn

TYPE = DIAL_SCRIPT

DIAL_SCRIPT = TESTSCRPT

ACTION = ADD_OR_UPDATE

G u i d e l i n e s f o r u s i n g E C F s 579

System ECF. Likewise, if your modem type is Microcom AX/2400C (with a maximum data rate of 2400 bps), you cannot specify 9600 as the data rate in the Client ECF.

• You do not need to include all possible keywords in your ECF. Use only those that are required and those that apply. For example, to create a basic Client, only 3 lines are required.

• When you update an item using an ECF, remember to change all related items. For example, if you change a protocol for a Client from NetBIOS to Async, you also should change the primary resource to Async, specify a modem type, and a phone number.

• Spaces between the keyword and the equal sign are ignored by the ECF Server.

• ECFs only support two digit dates, for example: mm/dd/yy. If you use a four digit date (mm/dd/yyyy), the ECF Server will not process the ECF; instead, an error is generated in the Server Log.

• In user defined fields, the comma is treated as an item separator. Literal commas must be preceded with a backslash (\). For example:

DESCRIPTION = Addresse 16e\, St. Croix

MODEM = Maxitumi\, Inc. 14.4K


ECF propertiesThe following topics provide information about ECF properties.

Dial Script ECF For information about the Dial Scripts page (Server Profile), see “Dial Scripts property page” on page 97.

Use Dial Script ECFs to add, update, or delete dial scripts listed on the Dial Scripts property page in Server Profile. Dial Script ECF’s use the format in the following table.

Dial Script ECF exampleTYPE = DIAL_SCRIPTDIAL_SCRIPT = TSTSCRPTACTION = ADD_OR_UPDATECOMMAND = TRANSMIT "!"COMMAND = TRANSMIT "C <PHONE#>!"COMMAND = PAUSE 5COMMAND = TRANSMIT "\10"

Table 123. Dial Script ECF format

Keywords Valid Options Default value and comments

TYPE= DIAL_SCRIPT Required.

DIAL_SCRIPT= DialScriptName Required.

ACTION= ADDDELETEUPDATEADD_OR_UPDATECOPY SourceDialScriptNameADD_IF_NOT_DEFINEDDELETE_IF_DEFINED

Specify one action.

COMMAND= REM “Remark text”; “Remark text”MODEMINIT “Modem Init string”DIAL “Dial string”TRANSMIT “Transmit string”PAUSE SecondsWAITFOR Seconds to wait “Text to wait for”DLLCALL #Index "Text argument"

Specify one option per command. Use as many of these keywords as needed to build the dial script.

NEXT_ECF= FileName.ecn Optional.

NEXT_ECF_ON_ERROR= Filename.ecn Optional.

E C F p r o p e r t i e s 581

COMMAND = PAUSE 3


Long Distance Service ECF For information about the Long Distance page (Server Profile), see “Long Distance property page” on page 77.

Use Long Distance Service ECFs to add, update, or delete long distance service definitions. Changes appear on the Long Distance page in Server Profile. The following table lists all of the keywords and options for Long Distance Service ECFs .

Long Distance Service ECF exampleTYPE = LD_SERVICELD_SERVICE = MaxiNetACTION = ADD_OR_UPDATESTATUS = ENABLEDIAL_STRING = 9*\,<phone #>

Table 124. Long Distance Service ECF format


TYPE= LD_SERVICE Required.

LD_SERVICE= Name of LD Service Required.

ACTION= ADDDELETEUPDATEADD_OR_UPDATECOPY Name of LD Service to copyADD_IF_NOT_DEFINEDDELETE_IF_DEFINED

Specify one action.

STATUS= ENABLE, DISABLE Default is DISABLE.

DIAL_SCRIPT= Dial script name Dial string must already exist. Do not use if DIAL_STRING is also defined.

DIAL_STRING= Dial string text Default is <Phone #>. Do not use if DIAL_SCRIPT is also defined.Note: If the dial string contains a comma (,) it must be preceded by a “\” to avoid errors.




Modem ECF For information about the Modem Types page (Server Profile), see “Modem Types property page” on page 102.

Use Modem ECFs to add, update, or delete modem definitions on the Server. Any changes made by a modem ECF appear on the Modem Types page in Server Profile. The following table lists all modem ECF keywords and options.

Table 125. Modem ECF format


TYPE= MODEM Required.

MODEM= Modem definition nameISDN <VendorName>

Required.

ACTION= ADDDELETEUPDATEADD_OR_UPDATECOPY Source modem definition nameRENAME Source modem definition nameADD_IF_NOT_DEFINEDDELETE_IF_DEFINED

Specify one action.

MODEM_INIT_STRING= Modem init string ATE0 V0 Q0 X4 S0=0 S7=45!

AUTO_ANSWER_STRING= Auto answer string AT S0=1!

NO_ANSWER_STRING= No answer string AT S0=0!

MODEM_DIAL_STRING= Modem dial string ATDT

MODEM_ESCAPE_STRING= Modem escape string +++

MODEM_HANGUP_STRING= Modem hangup string ATH!

ANSWER_ON_RING_STRING= Answer on ring string ATA!

ANSWER_ON_RING= ON, OFF ON

FLOW_CONTROL= ON, OFF OFF

MAX_DATA_RATE= 1200, 2400, 4800, 9600, 19200, 38400, 57600

1200 (bits per second)

MODEM_DELAY= 500 - 5000 1500 (msec)

MODEM_TIMEOUT= 30 - 255 45 (seconds)

OK= 0 - 99 0

CONNECT= 0 - 99 1


Modem ECF exampleTYPE = MODEMMODEM = QuasiModem FAX 28.8ACTION = ADD_OR_UPDATEMAX_DATA_RATE = 38400MODEM_DELAY = 1500MODEM_DELAY = 45MAX_DATA_RATE = 38400MODEM_INIT_STRING = ATE0 V0 Q0 X4 M0 S7=45 S0=0!AUTO_ANSWER_STRING = ATE0 V0 Q0 X4 M0 S0=1!NO_ANSWER_STRING = AT S0=0!MODEM_ESCAPE_STRING = +++MODEM_HANGUP_STRING = ATH!OK = 0CONNECT = 1RING = 2NO_CARRIER = 3

RING= 0 - 99 2

NO_CARRIER= 0 - 99 3

ERROR= 0 - 99 4

CONNECT_1200= 0 - 99 5

NO_DIALTONE= 0 - 99 6

BUSY= 0 - 99 7

NO_ANSWER= 0 - 99 8

CONNECT_2400= 0 - 99 10

CONNECT_4800= 0 - 99 11

CONNECT_9600= 0 - 99 12

CONNECT_19200= 0 - 99 14

CONNECT_38400= 0 - 99 15

CONNECT_57600= 0 - 99 9



Table 125. Modem ECF format (Continued)



ERROR = 4CONNECT_1200 = 5NO_DIALTONE = 6BUSY = 7NO_ANSWER = 8CONNECT_2400 = 10CONNECT_4800 = 11CONNECT_9600 = 12CONNECT_19200 = 14CONNECT_38400 = 15CONNECT_57600 = 9FLOW_CONTROL = OFF


Client ECFClient ECFs specify the same Client configuration information that you enter when you use the Client Profile program. The following table lists the valid keywords and options.

Table 126. Client ECF format


TYPE= CLIENT Required.

CLIENTS= ClientName1 [,ClientNameN]ALL

Required. ALL can only be used with UPDATE and DELETE actions.

ACTION= COPY name of Client to copyADDUPDATEADD_OR_UPDATEDELETEADD_IF_NOT_DEFINEDDELETE_IF_DEFINED

One action is required.

COPY_ASSIGNMENTS= YES, NO YES

CLIENT_TYPE= WINDOWS, WINDOWS_NT, DOS WINDOWS - This is a required field.

DESCRIPTION= Client description

STATUS= DISABLE, ENABLE ENABLE

PASSWORD= Password Required.

DRIVE= A - Z C

PATH= Path \

TIMEZONE= -11 to 12 Same time zone as Server.

PERMIT_SERVERS= Serial Number [,Serial Number...]NONE

NONEUp to 6 can be specified.

UNPERMIT_SERVERS= Serial Number [,Serial Number...]ALL

Up to 6 can be specified.

REGISTERED= YES registers the Client.NO unregisters the Client.

If value is omitted, no change occurs.


CONFIG= APPLICATIONS,ESD,INBOUND_OBJECT_SELECTION,REMOTEWARE_APPLICATIONS,ALL

NONE.Note: Varies from creation through Client Profile.

CONFIG_OFF= APPLICATIONS,ESD,INBOUND_OBJECT_SELECTION,REMOTEWARE_APPLICATIONS,ALL

INBOUND_OBJECT_SELECTION.Separate options with commas.

PROTOCOL= ASYNC - ProtoName [,ALTERNATEn]NETBIOS - ProtoName [,ALTERNATEn]SPX - ProtoName [,ALTERNATEn]TCP/IP - ProtoName [,ALTERNATEn]

ProtoName is defined on Protocols page in Server Profile. For details, see “Protocol property page” on page 109. Use ALTERNATE1 on second item. The n in ALTERNATEn is from 1 to 4.

MODEM_TYPE= RWS TAPI DEFINED

Modem type [,ALTERNATEn]. [,ALTERNATEn] refers to the secondary resource.

Use with TAPI modems.Use with RemoteWare defined modemsHayes V SeriesThe n in ALTERNATEn is from 1 to 4.

TAPI_USE DIAL_PROP ON, OFF OFF

TAPI_USE_SYS_LOCATION ON, OFF OFF

MODEM_PORT= Com1, ..., Com4 [,ALTERNATEn] Com1The n in ALTERNATEn is from 1 to 4.

DATA_RATE= 1200, 2400, 4800, 9600, 19200, 38400, 56700 [,ALTERNATEn]

38400The n in ALTERNATEn is from 1 to 4.

Table 126. Client ECF format (Continued)



SERVER_PHONE1= ASYNC - ServerPhone [,ALTERNATEn]NETBIOS- ServerName [,ALTERNATEn]TCP/IP or SPX - ServerAddress [,ALTERNATEn] <Server_Name>

Dependent on PROTOCOL and ALTERNATEn value.

SERVER_PHONE2= ASYNC - ServerPhone [,ALTERNATEn]NETBIOS- ServerName [,ALTERNATEn]TCP/IP or SPX - ServerAddress [,ALTERNATEn] <Server_Name>

Dependent on PROTOCOL and ALTERNATEn value.

INBOUND_TIME= hh:mm:ss, NONE [,ALTERNATEn] NONE

RETRIES= 0 - 20 [,ALTERNATEn] 0

PRIMARY_RESOURCE= NETBIOS, ASYNC, SPX, TCP/IP, NONE

ASYNC

PRIMARY_PHONE= Client phone (for ASYNC)Client name (for NETBIOS)Client address (for TCP/IP, SPX)

Required.

PRIMARY_ LD_CLASS= Long distance service name, NONE First enabled long distance service.Use only for Async items.

PRIMARY_CONFIG= PRIMARY, ALTERNATEn The n in ALTERNATEn is from 1 to 4.

ALTERNATE_RESOURCE= NETBIOS, ASYNC, SPX, TCP/IP, NONE

NONE

ALTERNATE_PHONE= Client phone (for ASYNC)Client name (for NETBIOS)Client address (for TCP/IP, SPX)

Dependent on ALTERNATE_RESOURCE.

ALTERNATE_ LD_CLASS= Long distance service name, NONE First enabled long distance service.Use only for Async items.

ALTERNATE_CONFIG= PRIMARY, ALTERNATEn The n in ALTERNATEn is from 1 to 4.




Adding and updating ClientsThis information supplements the Action keyword descriptions presented earlier in this chapter. For details, see “Understanding the Action keywords” on page 577.

• COPY. Assignments are also copied by default. Use COPY_ASSIGNMENTS=NO to avoid copying the source Client’s assignments.

• CLIENTS=ALL. You can use CLIENTS=ALL with the ACTION=UPDATE or ACTION=DELETE commands. For example, if you want to enable all Clients, the beginning lines in the ECF would look like this:

TYPE = CLIENTCLIENTS = ALLACTION = UPDATESTATUS = ENABLE

CONTACT1_NAME= Name

CONTACT1_PHONE= Phone contact

CONTACT1_STREET1= Street address line 1


CONTACT1_CITY_STATE = City and State

CONTACT1_ZIP= Postal code

CONTACT2_NAME= Name

CONTACT2_PHONE= Phone contact



CONTACT2_CITY_STATE= City and State

CONTACT2_ZIP= Postal code

COMMENTS= Comment text






Client ECF examples

To generate the basic TCP/IP Client:

TYPE = CLIENTCLIENTS = BASICACTION = ADD

PASSWORD = XYZ

PRIMARY_PHONE = 10.24.X.X

To unregister three template Clients:

TYPE = CLIENTCLIENTS = ATLANTA, BOSTON, SEATTLEACTION = UPDATEREGISTERED = NO

To create five new Clients using an existing definition:

TYPE = ClientCLIENTS = Client1,Client2,Client3,Client4,Client5ACTION = COPY ClientDESCRIPTION = Five Sisters CompanyMODEM_PORT = Com2MODEM_TYPE = Basic Modem DefinitionDATA_RATE = 4800TIMEZONE = -8DRIVE = cPATH = \files\inboxSTATUS = DISABLE

To create a fully defined Client:

TYPE = CLIENTCLIENTS = EXAMPLEACTION = ADD_OR_UPDATE

;========== GENERAL ==========CLIENT_TYPE = WINDOWSDESCRIPTION = A fully defined ClientSTATUS = ENABLE

Note: You can unregister a maximum of ten (10) Clients using one ECF. To unregister all Clients, set the CLIENTS keyword to “ALL”.


PASSWORD = clipperDRIVE = CPATH = \data\incomingTIMEZONE = -5PERMIT_SERVERS = 1, 3, 5, 2, 4, 6CONFIG = APPLICATIONS, ESDCONFIG_OFF = FILE_ATTRIBUTES, INBOUND_OBJECT_SELECTION

;========= CLIENT COMMUNICATIONS =========PROTOCOL = ASYNC - DefaultMODEM_TYPE = Hayes V SeriesMODEM_PORT = Com3DATA_RATE = 38400SERVER_PHONE1 = 540-4303SERVER_PHONE2 = 540-4304INBOUND_TIME = 01:00:00RETRIES = 2PROTOCOL = NetBIOS - Default, ALTERNATE1SERVER_PHONE1 = RW_SERV1, ALTERNATE1SERVER_PHONE2 = RW_SERV2, ALTERNATE1INBOUND_TIME = 05:00:00, ALTERNATE1RETRIES = 2, ALTERNATE1PROTOCOL = SPX - Default, ALTERNATE2SERVER_PHONE1 = 00000100 08005a3b0342, ALTERNATE2SERVER_PHONE2 = 00000100 08004b4c0453, ALTERNATE2INBOUND_TIME = 08:00:00, ALTERNATE2RETRIES = 4, ALTERNATE2PROTOCOL = TCP/IP - Default, ALTERNATE3SERVER_PHONE1 = 200.200.200.1, ALTERNATE3SERVER_PHONE2 = 200.200.180.100, ALTERNATE3INBOUND_TIME = 03:00:00, ALTERNATE3RETRIES = 5, ALTERNATE3PROTOCOL = ASYNC - Default, ALTERNATE4MODEM_TYPE = Megahertz PCMCIA, ALTERNATE4


MODEM_PORT = Com4, ALTERNATE4DATA_RATE = 9600, ALTERNATE4SERVER_PHONE1 = 203-003-0321, ALTERNATE4SERVER_PHONE2 = 203-003-0353, ALTERNATE4INBOUND_TIME = 01:00:00, ALTERNATE4RETRIES = 2, ALTERNATE4

;========= SERVER COMMUNICATIONS =========PRIMARY_RESOURCE = ASYNCPRIMARY_LD_CLASS = NormalPRIMARY_PHONE = 303-203-0320PRIMARY_CONFIG = PRIMARYALTERNATE_RESOURCE = TCP/IPALTERNATE_PHONE = 200.200.200.1ALTERNATE_CONFIG = ALTERNATE3;========= COMMENTS =========CONTACT1_NAME = Sonia MalachekCONTACT1_PHONE = (303) 430-2302CONTACT1_STREET1 = 83 Jonquil ReefCONTACT1_STREET2 = Suite 302CONTACT1_CITY_STATE = Tanga\, TanzaniaCONTACT1_ZIP = HT3 01G7CONTACT2_NAME = Milan AnouporosCONTACT2_PHONE = (303) 997-8484CONTACT2_STREET1 = Bvastra Corners #23CONTACT2_STREET2 = Grid 34x32\, shop CCONTACT2_CITY_STATE = Tanga\, TanzaniaCONTACT2_ZIP = HT3 01B4COMMENTS = Pager is 777-994-9999.


Client Group ECFUse Client Group ECFs to create, copy, delete, and update Client groups, or to assign or unassign Clients to a specified Client group. These ECFs follow the format in the following table.

Client Group ECF examples

To update all Client groups to add and remove some Clients:

TYPE = CLIENT_GROUPCLIENT_GROUPS = ALLACTION = UPDATEASSIGN_CLIENTS = DATONG, TAMBOV, NEPEAN

Table 127. Client Group ECF format

Keyword Valid Options Default value and comments

TYPE= CLIENT_GROUP Required.

CLIENT_GROUPS= GroupName1 [, ... GroupNamen]ALL

Required.ALL is only valid with the UPDATE and DELETE action keywords.

ACTION= COPY GroupNameADDDELETEADD_OR_UPDATEUPDATEADD_IF_NOT_DEFINEDDELETE_IF_DEFINED

Specify one action.

DESCRIPTION= Client group description

COPY_ASSIGNMENTS= YES, NO YES

ASSIGN_CLIENTS= ClientName1 [, ... ClientNamen]ALL

ASSIGN_CLIENT_GROUPS= GroupName1 [, ... GroupNamen]

UNASSIGN_CLIENTS= ClientName1 [, ... ClientNamen]ALL

UNASSIGN_CLIENT_GROUPS= GroupName1 [, ... GroupNamen]


NEXT_ECF_ON_ERROR= FileName.ecn Optional.


UNASSIGN_CLIENTS = THIMBU, SASEBO, SEPTILES

To assign one Client group to another:

TYPE = CLIENT_GROUPCLIENT_GROUPS = EUROPEACTION = UPDATEASSIGN_CLIENT_GROUPS = DEUTSCH


Portable Security ECF For information about the Portable Security page (Server Profile), see “Portable Security page” on page 120.

Use Portable Security ECFs to add and update users listed on the Portable Security property page in Server Profile. Portable ECF’s use the format in the following table.

Portable Security ECF exampleTYPE = PS_TYPEPS = Portable SecurityACTION = ADD_OR_UPDATECOMPUTER = DefaultUSER = DefaultPASSWORD = GBGEGNGJGOENCRYPT_PASSWORD = NO

Table 128. Portable ECF format


TYPE= PS_TYPE Required.

PS= Portable Security Required.

ACTION= ADDUPDATE

Specify one action.

COMPUTER= Default or ComputerName Required.

USER= Default or UserName Required.

PASSWORD= Password Required.

ENCRYPT_PASSWORD= YES, NO Optional




Protocol ECF For information about the Protocol page (Server Profile), see “Protocol property page” on page 109.

Protocol ECFs add, update, or delete protocol definitions, which are listed on the Protocol page in Server Profile. The following table lists the format and options for the Protocol ECF.

Table 129. Protocol ECF format


TYPE= PROTOCOL Required.

PROTOCOL= ResourceName - Description Required. Spaces must separate each part of the option. An example is TCP/IP - Default.

ACTION= COPY ResourceName - DescriptionADDUPDATERENAME ResourceName - DescriptionADD_OR_UPDATEDELETEADD_IF_NOT_DEFINEDDELETE_IF_DEFINED

Specify one action.

PACKET_SIZE= 128, 256, 384, 512, 640, 768, 896, 1024, 1536, 2048, 4096, 8192, 16384

Default is 640 bytes for async; 4096 for network protocols. Note: Packet size Window size 16384.

WINDOW_SIZE= 1, 2, 3, 4, 5, 6, 7, 8 Default is 3 for async; 4 for network protocols. Note: Packet size Window size 16384.

RETRANSMIT_TIMEOUT= 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60 Available only for asynchronous resources. Default is 15 seconds.

SESSION_TIMEOUT= 30, 45, 60, 75, 90, 105, 120 Default is 60 seconds.

COMPRESSION= ON, OFF Default is ON for async; OFF for network protocols.


Protocol ECF example

To fully define a new asynchronous protocol:

TYPE = PROTOCOLPROTOCOL = ASYNC - cellularACTION = ADDPACKET_SIZE = 1024WINDOW_SIZE = 2RETRANSMIT_TIMEOUT = 60SESSION_TIMEOUT = 120COMPRESSION = ON



Table 129. Protocol ECF format (Continued)



Resource ECFUse Resource ECFs to change a resource or resource configuration for one or more RemoteWare Servers. You can use this type of ECF to add, copy, delete, or update asynchronous ports; you can only update other resource types. The following table lists the valid keywords and options for the Resource ECF.

Table 130. Resource ECF format


TYPE= RESOURCE Required.

RESOURCES= NETBIOSPORT0..PORT31ASYNCPROCESS_ONLYTCP/IPSPXALLMULTICAST

Required.ALL is only valid with the UPDATE action.

ACTION= COPY PORTnADDUPDATEADD_OR_UPDATEDELETEADD_IF_NOT_DEFINEDDELETE_IF_DEFINED

Specify one action.PORTn can range from 0 to 31.

SERVERS= ServerName [, ServerName...],ALL

Default is the Local Server.

STATUS= DISABLE, ENABLE ENABLE

NUM_RESOURCES= 0 - 31 Only valid for Process Only and network resources.

DEVICE= COM1 Asynchronous resource only.

MODEM_TYPE= Modem type Basic Modem Definition, or last modem type used for a resource.

MAX_DATA_RATE= 1200, 2400, 4800, 9600, 19200, 38400, 57600

9600


DIRECT_CONNECT_CLIENT= Client name Asynchronous resource only.

SERVER_PHONE = Server phone number Asynchronous resource only.

SERVER_ADDRESS = Network address Network resources only.

USAGE= INBOUNDOUTBOUNDINOUT

OUTBOUND

INBOUND_DATA_RATE= 1200, 2400, 4800, 9600, 19200, 38400, 57600

Asynchronous resource only.

ASSIGN_LD_CLASSES= LD class1,..., LD classn, ALL


UNASSIGN_LD_CLASSES= LD class1,..., LD classn, ALL


PORT_PRIORITY= 0...9 Default is 0. Async resource only.



OUTBOUND_LIMIT_ALL ENABLE, DISABLE Optional.

OUTBOUND_LIMIT_ASYNC ENABLE, DISABLE Optional.

OUTBOUND_LIMIT_NETBIOS ENABLE, DISABLE Optional.

OUTBOUND_LIMIT_TCPIP ENABLE, DISABLE Optional.

OUTBOUND_LIMIT_SPX ENABLE, DISABLE Optional.

OUTBOUND_LIMIT_SES_ASYNC 1...64 Optional.

OUTBOUND_LIMIT_SES_NETBIOS 1...64 Optional.

OUTBOUND_LIMIT_SES_TCPIP 1...64 Optional.

OUTBOUND_LIMIT_SES_SPX 1...64 Optional.

PORT_GROUP 0...64 TCP/IP, SPX and NetBIOS resources only.

PORT_GROUP_NAME Name of the Port Group TCP/IP, SPX and NetBIOS resources only.

PORT_COUNT 0...max ports for specific resource

TCP/IP, SPX and NetBIOS resources only.

Table 130. Resource ECF format (Continued)


If you use an OUTBOUND_LIMIT keyword, you must pair it with its corresponding OUTBOUND_LIMIT_SES keyword. See the examples for more information.

Specify Port Groups and Network Groups at the end of the ECF for each TCP/IP, SPX, or NetBIOS resource. This block of keywords is repeated for each Port Group that belongs to the resource.


Resource ECF examples

To disable all resources on a clustered Server:

TYPE = RESOURCERESOURCES = ALLACTION = UPDATESTATUS = DISABLESERVERS = RWSERV3

To update all of the asynchronous resources on SERVER1 and SERVER2 by specifying a new modem configuration:

TYPE = RESOURCERESOURCES = ASYNCACTION = UPDATESERVERS = SERVER1, SERVER2MODEM_TYPE = YOA MODEM 19.2MAX_DATA_RATE = 19200INBOUND_DATA_RATE = 19200USAGE = INOUT

PORT_PRIORITY 1...10 TCP/IP, SPX and NetBIOS resources only.

PORT_GROUP_USAGE IN, OUT, INOUT TCP/IP, SPX and NetBIOS resources only.

NETWORK_GROUP Name of the Network Group


NETWORK_GROUP_INDEX 0...64 TCP/IP, SPX and NetBIOS resources only. Specify the Network Groups at the end of the Resource ECF file.

NETWORK_GROUP_NAME Name of the Network Group


NETWORK_GROUP_STATUS ENABLE, DISABLE TCP/IP, SPX and NetBIOS resources only.

Table 130. Resource ECF format (Continued)



To enable the ASYNC resource to run 5 sessions per second:

TYPE = RESOURCERESOURCES = ASYNCACTION = UPDATEOUTBOUND_LIMIT_ASYNC = ENABLEOUTBOUND_LIMIT_SES_ASYNC = 5

Note: In the third example, if the OUTBOUND_LIMIT_ASYNC keyword is not used, nothing happens when the ECF is processed. The reason is that Limit Outbound was not enabled for the async resource. The OUTBOUND_LIMIT and OUTBOUND_LIMIT_SES keywords must be paired.


Scheduler ECF Tip: To use a single Scheduler ECF to schedule several different sessions, repeat the SESSION=, STARTING_TIME=, and CLIENTS= lines for each session you want to schedule.

Scheduler ECFs specify a start time and date for a predefined session. The session must already be created and enabled on the Server through the Session Editor program, and the Clients must also already be created and enabled. The Scheduler ECF format appears in the following table.

Scheduler ECF example

To schedule a session in the future to four Clients and two Client groups:

TYPE = SCHEDULE

Note: You cannot use the Execute and Skip or Skip commands in the Schedule Sessions window for ECFs. Doing so generates the message, “Once-only sessions cannot be rescheduled.”

Table 131. Scheduler ECF format


TYPE= SCHEDULE Required.

SESSION= Session name Specify one session name as it is defined in the Session Editor.

STARTING_TIME= mm/dd/yy hh:mm:ss The start date and time must appear exactly as shown; format does not change with international setting. Hour follows the 24-hour clock and all values must use trailing zeros. 00/00/00 denotes the current date; omit time for the current system time.

CLIENTS= ClientName1[, ... , ClientNamen]ALLALL_ASSIGNED

CLIENT_GROUPS= ClientGroup1 [, ... , ClientGroupn]ALL




SESSION = Branch Office ESDSTARTING_TIME = 12/12/99 12:00:00CLIENTS = MIAMI,LEHAGUE,MOSCOW,TOKYOCLIENT_GROUPS = SUPPORT,DEVELOP


Session ECFUse Session ECFs to create or update sessions. You can use this type of ECF to set session attributes such as schedule type, enabled or disabled status, schedule basis, and start times and dates. The following table lists the valid keywords and options for the Session ECF.

Table 132. Session ECF format


TYPE= SESSION Required.

SESSIONS= sessionname1[, ... , SessionName-n]

Required. ALL may only be used with the UPDATE action. Sessions = newname can be used with RENAME action.

ACTION= COPY SessionName ADDDELETEADD_OR_UPDATE UPDATE RENAME OldName ADD_IF_NOT_DEFINED DELETE_IF_DEFINED


SCHEDULE_TYPE= INBOUND OUTBOUND BOTH PROCESS_ONLY MULTICAST

OUTBOUND

STATUS= ENABLE, DISABLE DISABLE

SCHEDULE_BASIS= FIXED_INTERVALCALENDAR DEPENDENT

FIXED_INTERVAL

START_SESSION= mm/dd/yy hh:mm:ss Current date at 00:00:00

REPEAT_HHMMSS= hh:mm:ss Use only when SCHEDULE_BASIS=FIXED_INTERVAL.

REPEAT_DAYS= 1 - 365 Use only when SCHEDULE_BASIS=FIXED_INTERVAL. Default is every 1 day.


REPEAT_WEEKS= 1 - 52, DayofWeek [,DayofWeek] Use only when SCHEDULE_BASIS=FIXED_INTERVAL. DayofWeek must be Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

ADD_EXCEPTION_DATES= mm/dd/yy [, mm/dd/yy] Use only when SCHEDULE_BASIS=FIXED_INTERVAL.

DELETE_EXCEPTION_DATES= mm/dd/yy [, mm/dd/yy]ALL

Use only when SCHEDULE_BASIS=FIXED_INTERVAL.

ADD_DATES= mm/dd/yy hh:mm:ss Use only when SCHEDULE_BASIS=CALENDAR.

DELETE_DATES= mm/dd/yy hh:mm:ss, ALL Use only when SCHEDULE_BASIS=CALENDAR.

ADD_OBJECTS= ObjectName [, ObjectName]

DELETE_OBJECTS= ObjectName [, ObjectName]

ASSIGNED_OBJECTS_ONLY= ON, OFF

DEPENDENT_OPTIONS_ON= COUNT_SUCCESSFUL COUNT_FAILED COUNT_OUT_OF_RANGE EXECUTE_AT_WINDOW_END ALL

Use only when SCHEDULE_BASIS=DEPENDENT.

DEPENDENT_OPTIONS_OFF= COUNT_SUCCESSFUL COUNT_FAILED COUNT_OUT_OF_RANGE EXECUTE_AT_WINDOW_END ALL

Use only when SCHEDULE_BASIS=DEPENDENT.

DEPENDS_ON_SESSION= Monitored Session Name Use only when SCHEDULE_BASIS=DEPENDENT.

SESSION_PRIORITY= 0 - 9 0

STOP_OUTBOUND= 1 - 24 1 (hours)

Table 132. Session ECF format (Continued)



EARLY_WINDOW= 1 - 24 1 (hours)

RETRY_INTERVAL= 1 - 60 5 (minutes)

NUM_RETRIES= 0 - 25 3

ALT_RETRY_THRESHOLD= 1 - NUM_RETRIES+1 1

ASSIGN_CLIENTS= ClientName1 [, ... , ClientName_n] ALL

ASSIGN_CLIENT_GROUPS= Groupname1 [, ... , GroupName_n]

UNASSIGN_CLIENTS= ClientName1 [, ... , ClientName_n] ALL

UNASSIGN_CLIENT_GROUPS= Groupname1 [, ... , Groupname_n]

OPTIONS_ON= ASSIGNED_OBJECTS_ONLY NO_APPLICATIONS NO_ESD ALL ENCRYPT_WHEN_POSSIBLE ENCRYPTION_REQUIRED

ALLUse only one encryption keyword at a time. Using session encryption requires additional processing time and resources, the extent of which may vary by file size and type. You are advised to evaluate the impact of encrypting sessions in your environment.

OPTIONS_OFF= ASSIGNED_OBJECTS_ONLY NO_APPLICATIONS NO_ESDALL ENCRYPT_WHEN_POSSIBLE ENCRYPTION_REQUIRED

ALLSession encryption is off when both encryption keywords are in use.

ASSIGNED_OBJECTS_ONLY= ON, OFF OFF



Table 132. Session ECF format (Continued)



Session ECF examples

An example of using SESSIONS=ALL to update all defined sessions:

TYPE = SESSIONSESSIONS = ALLACTION = UPDATESTATUS = DISABLEOPTIONS_ON = ENCRYPT_WHEN_POSSIBLE

An example of a fully defined fixed interval session:

TYPE = SESSIONSESSIONS = Shipping MaintenanceACTION = ADD_OR_UPDATESCHEDULE_TYPE = BOTHSTART_SESSION = 02/26/97 05:00:00STOP_OUTBOUND = 2SESSION_PRIORITY = 4EARLY_WINDOW = 2NUM_RETRIES = 4RETRY_INTERVAL = 6ALT_RETRY_THRESHOLD = 2SCHEDULE_BASIS = Fixed_intervalREPEAT_WEEKS = 2, MONDAY, THURSDAY, FRIDAYADD_EXCEPTION_DATES = 02/28/97, 04/28/98OPTIONS_ON = NO_APPLICATIONS, NO_ESD,

ASSIGNED_OBJECTS_ONLYASSIGN_CLIENTS = PLYMOUTH, NAZARETH, MONTREALADD_OBJECTS = RWS System ESD, Transfer Shipping

Data

To define a dependent session:

TYPE = SESSIONSESSIONS = Process Arrived OrdersACTION = ADD_IF_NOT_DEFINEDSCHEDULE_TYPE = OUTBOUNDSTOP_OUTBOUND = 24NUM_RETRIES = 0SCHEDULE_BASIS = DependentDEPENDS_ON_SESSION = Retrieve OrdersDEPENDENT_OPTIONS_ON = COUNT_SUCCESSFUL, COUNT_FAILED, COUNT_OUT_OF_RANGE,

EXECUTE_AT_WINDOW_END


OPTIONS_ON = ASSIGNED_OBJECTS_ONLYOPTIONS_OFF = NO_APPLICATIONS, NO_ESDASSIGN_CLIENTS = JALAPA, PSKOV, PRAGUEASSIGN_CLIENT_GROUPS = AUDITING, EXECUTVE, OVERSITE, ACCTNGADD_OBJECTS = Order Fulfillment ESD, Order TallyADD_OBJECTS = Order Retrieval


Work Object ECFUse Work Object ECFs to add, update, or delete work object definitions on a RemoteWare Server. The following table lists this ECF’s keywords and options.

Table 133. Work Object ECF format


TYPE= WORK_OBJECT Required.

OBJECTS= Objectname1 [, ... , Objectname_n] Specify at least one object.

ACTION= copy ObjectnameADDUPDATEADD_OR_UPDATEDELETEADD_IF_NOT_DEFINEDDELETE_IF_DEFINED


COPY_ASSIGNMENTS= YES, NO Default is YES. Only valid for COPY action.

OBJECT_TYPE= ESDWORKLISTGROUPAPPLICATIONAPPLICATION GROUP

One object type is required.

STATUS= ENABLE, DISABLE DISABLE

EXECUTION= DEFAULT, FORCED, REQUESTABLE

DEFAULT

EXECUTION_WINDOW= NONE, hh:mm:ss TO hh:mm:ss Default is NONE.All times are 24-hour and must be formatted exactly as shown. Example: 00:00:00 to 23:59:59

PRIORITY= 0..255 Default is 0. 255 is highest priority.

LIMIT_CLIENT_TYPES= ALL, WINDOWS, WINDOWS_NT, DOS

ALL

UNLIMIT_CLIENT_TYPES= ALL, WINDOWS, WINDOWS_NT, DOS

ALL

ACTIVATE= OFF, mm/dd/yy hh:mm:ss OFF


DEACTIVATE= OFF, mm/dd/yy hh:mm:ss OFF

PRIMARY_SERVER= ON, OFF OFF

INSTALLATION_KIT= ON,OFF ON



Keywords for WORKLIST, ESD, or GROUP Objects only:

ASSIGN_CLIENTS= Clientname1 [, ... , Clientname_n], ALL

ASSIGN_CLIENT_GROUPS= Groupname1 [, ... , Groupname_n]

UNASSIGN_CLIENTS= Clientname1[, ... , Clientname_n], ALL

UNASSIGN_CLIENT_GROUPS= Groupname1 [, ... , Groupname_n]

ASSIGN_SESSIONS= Session1 [, ... , Session_n], ALL

UNASSIGN_SESSIONS= Session1 [, ... , Session_n], ALL

Keywords for WORKLIST Objects only:

IMPORT_WORKLIST= Worklist filename These files typically use the .wrk extension.

Keywords for ESD Objects only:

IMPORT_WORKLIST= Worklist filename Worklist must only contain SEND FILE, CHECK FILE, MAKE DIRECTORY, and COMMENT events; other events are ignored.

BEFORE_WORKLIST= Worklist filename

AFTER_WORKLIST= Worklist filename

Keywords for GROUP, APPLICATION, or APPLICATION GROUP Objects only:

ADD_OBJECTS= Object1 [, ... , Object_n]

DELETE_OBJECTS= Object1 [, ... , Object_n]

Keywords for APPLICATION or APPLICATION GROUP Objects only:

Table 133. Work Object ECF format (Continued)


The Application and Application Group keywords are not available for use until RemoteWare Messaging Services, Workshop, and Subscriber have been installed on your Server.


Work Object ECF examples

To define a fully populated worklist work object:

TYPE = WORK_OBJECTOBJECTS = Update 95 System DirectoryACTION = ADD_OR_UPDATEOBJECT_TYPE = WORKLISTSTATUS = ENABLEOWNER = USEREXECUTION = DEFAULTLIMIT_CLIENT_TYPE = WINDOWSPRIORITY = 254EXECUTION_WINDOW = 01:30:00 TO 03:00:00ACTIVATE = 03/03/96 00:00:00DEACTIVATE = 06/12/98 12:00:01ASSIGN_CLIENTS = PIRNA, SUFFOLK, LUCERNEIMPORT_WORKLIST = swo00000.wrkINSTALLATION_KIT = OFF

To create an ESD work object:

TYPE = WORK_OBJECTOBJECTS = Periodic Office ESDACTION = ADD_OR_UPDATEOBJECT_TYPE = ESD

ASSIGN_USERS= Username1 [, ... , Username_n], ALL

ASSIGN_USER_GROUPS= Groupname1 [, ... , Groupname_n]

UNASSIGN_USERS= Username1 [, ... , Username_n], ALL

UNASSIGN_USER_GROUPS= Groupname1 [, ... , Groupname_n]

Keywords for APPLICATION Objects only:

EXE_FILE= Executable file name

WORKING_DIR= Application’s default working directory

COMMAND_LINE= Command line string

Table 133. Work Object ECF format (Continued)



STATUS = ENABLEOWNER = USEREXECUTION = FORCED

To define a group work object:

TYPE = WORK_OBJECTOBJECTS = Necessary GroupACTION = ADD_OR_UPDATEOBJECT_TYPE = GROUPSTATUS = ENABLEOWNER = USEREXECUTION = REQUESTABLEUNLIMIT_CLIENT_TYPE = ALLASSIGN_CLIENTS = HEGANG, HELSINKIASSIGN_CLIENT_GROUPS = BAND1, BAND2ADD_OBJECTS = Select Tabulation Scheme

To create an application work object:

TYPE = WORK_OBJECTOBJECTS = SpreadsheetACTION = ADD_OR_UPDATEOBJECT_TYPE = APPLICATIONSTATUS = DISABLEOWNER = USEREXECUTION = REQUESTABLELIMIT_CLIENT_TYPE = WINDOWSASSIGN_USER_GROUP = ACCNTG, MKTNG

To create an application group work object:

TYPE = WORK_OBJECTOBJECTS = Accounts PackageACTION = ADD_OR_UPDATEOBJECT_TYPE = APPLICATION GROUPSTATUS = ENABLEOWNER = USEREXECUTION = FORCEDLIMIT_CLIENT_TYPE = WINDOWSPRIORITY = 20ASSIGN_USERS = MISCHAL, FELINA, JACQUI, WILHELM


System ECFSystem ECFs can change global system settings and perform Server maintenance, such as turning a Scheduler on or off. System ECFs make system-wide changes; they don’t pertain to a specific Server.

The following table describes the System ECF and its structure.

Note: Only the SERVER and SCHEDULER keywords refer to a specific Server. When specifying a Server name for these keywords, ensure that the Server name is valid. An error appears in the Server Log if you supply an invalid Server name.

Table 134. System ECF format


TYPE= SYSTEM Required.

SYSTEM_NAME= System Name

SERVER_DISK_FULL_THRESHOLD=

20..99

CLIENT_DISK_FULL_THRESHOLD=

20..99

PORT_DISABLE_THRESHOLD= 0..20

CONFIG_ON= COMPRESSION, ESD, APPLICATIONS, ALL

CONFIG_OFF= COMPRESSION, ESD, APPLICATIONS, ALL

MAINTAIN_DIAL_CONNECT= ENABLE, DISABLE

DIAL_CONNECT_PRIORITY= 0..9, NONE

ADD_TO_NO_COMPRESS_TABLE=

Extension Don’t include the “.” period in the extension name.

DELETE_FROM_NO_COMPRESS_TABLE=

Extension


SESSION_HISTORY_LOGGING= ENABLE, DISABLE, ENABLE_FAILED, DISABLE_FAILED,ENABLE_ESD_NO_UPDATE, DISABLE_ESD_NO_UPDATE, ENABLE_EVENTS, DISABLE_EVENTS, ENABLE_COMMENTS, DISABLE_COMMENTS

FILE_TRANSFER_LOGGING= ENABLE, DISABLE, ENABLE_FAILED, DISABLE_FAILED, ENABLE_NO_EXECUTE, DISABLE_NO_EXECUTE

SERVER_TYPE= INBOUND, INOUT [, Server Name]

REGISTRATION_OPTIONS= ENABLE, DISABLE, CREATE_CLIENTS_ON, CREATE_CLIENTS_OFF, VERIFICATION_ON, VERIFICATION_OFF, KEY_ON, KEY_OFF

REGISTRATION_KEY= Key text

REGISTRATION_PREFIX= Prefix text

REGISTRATION_COUNTER= Numeric value

MULTICAST_FILE_TRANSFER_LOGGING=

ENABLE, ENABLE _FAILED, DISABLE

SERVER= ON, OFF, Server1, ... , Server_n, ALL

Use to suspend Server. Default is local Server.

SCHEDULER= ON,OFF,ON_AFTER_RESTART,OFF_AFTER_RESTART,[Server1, ... , Server_n], ALL

Use to suspend or resume Scheduler for a current instance, or after the next and subsequent restarts. Default Server is the local Server.


Table 134. System ECF format (Continued)



System ECF examples

To suspend server1, start server2, and suspend the schedulers on all Servers:

TYPE = SYSTEMSERVER = OFF, SERVER1SERVER = ON, SERVER2SCHEDULER = OFF, ALL

To suspend all schedulers now and resume schedulers after restarts:

TYPE = SYSTEMSCHEDULER = OFF, ALLSCHEDULER = ON_AFTER_RESTART, ALL

To fully define the characteristics for a set of clustered Servers:

TYPE = SYSTEMSYSTEM_NAME = RW_SERV1SERVER_DISK_FULL_THRESHOLD = 90CLIENT_DISK_FULL_THRESHOLD = 90PORT_DISABLE_THRESHOLD = 3CONFIG_ON = ESD, COMPRESSIONCONFIG_OFF = APPLICATIONSMAINTAIN_DIAL_CONNECT = ENABLEDIAL_CONNECT_PRIORITY = NONESESSION_HISTORY_LOGGING = ENABLE, DISABLE_FAILED,

DISABLE_ESD_NO_UPDATE,DISABLE_EVENTS

FILE_TRANSFER_LOGGING = ENABLE, DISABLE_FAILED,DISABLE_NO_EXECUTE

SERVER_TYPE = INOUT, RW_SERV1SERVER_TYPE = INBOUND, RW_SERV2SERVER_TYPE = INOUT, RW_SERV3REGISTRATION_OPTIONS = ENABLEREGISTRATION_OPTIONS = VERIFICATION_ONREGISTRATION_OPTIONS = KEY_ONREGISTRATION_OPTIONS = CREATE_CLIENTS_ONREGISTRATION_KEY = T1


Table 134. System ECF format (Continued)



REGISTRATION_PREFIX = XREGISTRATION_COUNTER = 9ADD_TO_NO_COMPRESS_TABLE = EXE, ZIP


Worklist ECFUse Worklist ECFs to copy, delete, rename, and build new worklists. You can also update worklists with new events that are appended to the end of an existing worklist. The valid keywords and options for the worklist ECF include:

Table 135. Worklist ECF format


TYPE= WORKLIST Required.

WORKLIST= Worklist file name Required. Use WORKLIST= or WORK_OBJECT=, but not both. The default worklist path \WORKLIST is assumed.

WORK_OBJECT= Work object name, WORKLIST, ESD, BEFORE, AFTER

Required. Use WORKLIST= or WORK_OBJECT=, but not both.

ACTION= COPY Worklist file name, ADD, UPDATE, DELETE, ADD_OR_UPDATE, RENAME Source Worklist file name, DELETE_IF_DEFINED

DELETE_COMMANDS=

# (line number)1 - # (line number)ALL

Line numbers are based on initial worklist and not on the modifications made during this WORKLIST transaction.


COMMAND= APPENDFILE, ASCII_APPEND, CHECK_DISK, CHECK_FILE, CHECK_SENDFILE, COMMENT, COPYFILE, CREATE_REGISTRY_KEY, DELETE_INI_FILE, DELETE_REGISTRY_KEY, DELETE_REGISTRY_VALUE, DELETEFILE, DIRECTORY, ELSE_IF, END_IF, END_QUOTA, END_REPEAT, END_SESSION, END_WORKOBJ, EXCEPTION, EXECUTE, FILESTAT, GET_REGISTRY, GET_SCRIPTVAR, GETFILE, GROUP_TEST, IF, LOAD_SCRIPT, MAKEDIR, MESSAGE_EXCHANGE, NOTIFY, QUOTA, READ_INI_FILE, REBOOT_CLIENT, RELEASE_SCRIPT, REMOVEDIR, RENAMEFILE, REPEAT_FALSE, REPEAT_TRUE, RUN_SCRIPTFUNCTION, SENDFILE, SET_ATTRIB, SET_REGISTRY, SET_SCRIPTVAR, SET_VARIABLE, SETTIME, TEST_VARIABLE, UNASSIGN, USER_ALARM, WAIT, WORKLIST, WRITE_INI_FILE

REBOOT_CLIENT command is applicable only to DOS and Windows Clients.

The LOAD_SCRIPT, RELEASE_SCRIPT, RUN_SCRIPTFUNCTION, GET_SCRIPTVAR, and SET_SCRIPTVAR options are applicable only to Windows Clients for Client-side execution.

PARAMn= Command dependent parameter For parameters, see “Table 136. Command parameters” on page 619.

WHEN= BEFORE, DURING, AFTER

WHERE= SERVER, CLIENT

Table 135. Worklist ECF format (Continued)



Some commands (such as SENDFILE and GETFILE) require additional parameters. The following table lists the required parameters for these commands.

OPTIONS= EQUAL,NOT_EQUAL,GREATER,GREATER_EQUAL, LESS,LESS_EQUAL,CONDITIONAL_FALSE,CONDITIONAL_TRUE,BYTE_LEVEL_DIFFERENCING,WORK_OBJECT_CRITICAL, CRITICAL, CRITICAL_RETRY, DELETE_AFTER, NO_MULTICAST_ACCESS_FILE, NO_OVERWRITE, NONE, SAFE_TRANSFER, UPDATES_ONLY, NOT_REQUIRED, NO_COMPRESSION, CHECK_IF_NEWER, INCLUDE_SUBDIRS, MAKEPATH

EQUAL, NOT_EQUAL, GREATER, GREATER_EQUAL, LESS, LESS_EQUAL, options are valid only with the IF command

Defaults for an event are selected when no OPTIONS keyword is in the worklist ECF.

Using NONE as an option set the command with NO options selected.

Any options keyword(s) after NONE will set only those options (i.e. OPTIONS=NONE, NO-OVERWRITE will set only Do Not Overwrite option).

POSITION= INSERT, REPLACE,1 - #commands

Numeric values must consider any modifications made to the worklist during this WORKLIST operation.


NEXT_ECF_ON_ERROR=

FileName.ecn Optional.

Table 136. Command parameters

Command Parameters Example

APPENDFILE PARAM1 = Source file path or wildcard

PARAM2 = Destination file path

PARAM1=G:\Source\*.srcPARAM2=G:\Source\All.lst

Table 135. Worklist ECF format (Continued)



ASCII_APPEND PARAM1 = Source file pathPARAM2 = Destination file

path

PARAM1=C:\*.rtf PARAM2=C:\All.rtf

CHECK_DISK PARAM1 = Drive letter PARAM1=D

CHECK_FILE PARAM1 = Server file namePARAM2 = Client file name

PARAM1=C:\FileA.datPARAM2=D:\FileA.dat

CHECK_SENDFILE

PARAM1 = Server file name PARAM2 = Client file namePARAM3 = Client Destination

Filename

PARAM1=C:\File.txtPARAM2=D:\File.txtPARAM3=D:\File.txt

COMMENT PARAM1 = Comment text (use literal commas) (250 characters maximum)

PARAM1=A short comment\, ok?

COPYFILE PARAM1 = Source file path or wildcard

PARAM2 = Destination path or directory

PARAM1=*.txt PARAM2=C:\Text\

CREATE _REGISTRY_KEY

PARAM1 = Name of key to be added

PARAM1=HKEY_CURRENT_USER\Temp

DELETE_INI_FILE

PARAM1 = File namePARAM2 = User variable name

PARAM1=C:\Variables.iniPARAM2=<%[Section].VarName>

DELETE_REGISTRY_KEY

PARAM1 = Name of key to be deleted


DELETE_REGISTRY_VALUE

PARAM1 = Name of the value to delete


DELETEFILE PARAM1 = File path or wildcard

PARAM1=F:\Archives\1999*.*

DIRECTORY PARAM1 = Output file pathPARAM2 = Directory path or

wildcard

PARAM1=C:\Dirs\Temp.dirPARAM2=D:\Storage\*.doc

ELSE_IF no parameters

END_IF no parameters

END_QUOTA no parameters

END_REPEAT no parameters

END_SESSION no parameters

Table 136. Command parameters (Continued)



END_WORKOBJ no parameters

EXCEPTION PARAM1 = Worklist file path PARAM1=C:\Worklist\Except.wrk

EXECUTE PARAM1 = Command line PARAM1=F:\Windows\Winfile.exe

FILESTAT PARAM1 = File path PARAM1=C:\Acllock.lst

GET_REGISTRY PARAM1 = User variable name PARAM2 = Name of value to be

retrieved

PARAM1=<%TempValueFromRegistry>


GETFILE PARAM1 = Server file pathPARAM2 = Client file path or

wildcard

PARAM1=D:\Files\ PARAM2=C:\*.*

GET_SCRIPTVAR PARAM1 = Server file pathPARAM2 = Variable namePARAM3 = Variable value

PARAM1=<ServerData>\ Scripts\Eval.vbsPARAM2=XPARAM3=<%X>

Note: PARAM1 value is optional, but “PARAM1=” is required.

GROUP_TEST PARAM1 = Client group name PARAM1=CLITESGP

IF_True no parameters

IF_False no parameters

IF PARAM1 = <%VariableName>, or numeric value

PARAM2 = <%VariableName>, <TextString>, or numeric value

OPTIONS = EQUAL, NOT_EQUAL, GREATER, GREATER_EQUAL, LESS, LESS_EQUAL

PARAM1=<%Number>PARAM2 = 8

LOAD_SCRIPT PARAM1 = Server file pathPARAM2 = Script type

PARAM1=<ServerData>\ Scripts\Eval.vbsPARAM2=VBScript

MAKEDIR PARAM1 = Directory path PARAM1=F:\Tmp




NOTIFY PARAM1 = Queue or named pipe

PARAM2 = Notify text

PARAM1=/Queues/Govsrvr.quePARAM2=start

QUOTA PARAM1 = Number of kilobytes

PARAM2 = Time in mm:ss

PARAM1=100PARAM2=10:05

READ_INI_FILE PARAM1 = File namePARAM2 = User variable name


REBOOT_CLIENT no parameters

RELEASE_SCRIPT PARAM1 = Server file path PARAM1=<ServerData>\ Scripts\Eval.vbs

REMOVEDIR PARAM1 = Directory path PARAM1=D:\Usr01

RENAMEFILE PARAM1 = Old file name and path

PARAM2 = New file name and path

PARAM1=D:\Tech\j00.datPARAM2=D:\Tech\j00.old

REPEAT_FALSEREPEAT_TRUE

PARAM1 = Timeout mm:ssPARAM2 = Inactivity timeout

mm:ssPARAM3 = Maximum number

of repeats

PARAM1=05:30PARAM2=10:00PARAM3=5

RUN_SCRIPTFUNCTION

PARAM1 = Server file pathPARAM2 = Variable namePARAM3 = Input listPARAM4 = Return variable

PARAM1=<ServerData>\ Scripts\Eval.vbsPARAM2=MultTestPARAM3=<%X>\,2PARAM4=<%Y>

Note: PARAM1 value is optional, but “PARAM1=” is required.

SENDFILE PARAM1 = Server file path or wildcard

PARAM2 = Client file pathPARAM3 = Multicast Client

acknowledgement time out, MM:SS

PARAM4 = Multicast channel name

PARAM1=<ServerInstall>\Data\*.datPARAM2=D:\Incoming\*.dtxPARAM3=10:00PARAM4=(Eastcoast,Midwest)




SET_ATTRIB PARAM1 = File name or pathAdd_Attribute = READ_ONLY,

HIDDEN, SYSTEM, ARCHIVE, NORMAL

or for Unix: PARAM1 = File name or pathAdd_Attribute = USER_READ,

USER_WRITE, USER_EXECUTE, GROUP_READ, GROUP_WRITE, GROUP_EXECUTE, WORLD_READ, WORLD_WRITE, WORLD_EXECUTE

PARAM1=C:\Winnt\System32\Notepad.exe

ADD_ATTRIBUTE=NORMAL

SET_REGISTRY PARAM1 = Name of value to be set

PARAM2 = Variable or valuePARAM3 = Registry value type

(“DWORD” or “String”)


PARAM2=C:\TempPARAM3=String

SET_SCRIPTVAR PARAM1 = Server file pathPARAM2 = Variable namePARAM3 = Variable value

PARAM1=<ServerData>\ Scripts\Eval.vbs

PARAM2=XPARAM3=101

SET_VARIABLE PARAM1 = Variable namePARAM2 = Value

PARAM1=WhoIsClientPARAM2=<ClientName>

SETTIME no parameters

TEST_VARIABLE PARAM1 = Variable namePARAM2 = Value

PARAM1=TheAnswer PARAM2=42

UNASSIGN PARAM1 = Item to unassign (“SESSION” or “WORKOBJECT”)

PARAM1=SESSION

USER_ALARM PARAM1 = Message text (use literal commas) (60 characters maximum)

PARAM1=End of business\, start the jobs!




Worklist ECF examplesTo delete an existing worklist:

TYPE = WORKLISTWORKLIST = WKLIST2ACTION = DELETE

To build a new Worklist with comments and conditions:

TYPE = WORKLISTWORKLIST = smallone.evfACTION = ADDCOMMAND = COMMENTPARAM1 = New worklist to get files from ClientCOMMAND = GETFILEPARAM1 = d:\Server\Test.datPARAM2 = c:\Client\Test.datOPTIONS = conditional_false

To edit a work object worklist:

TYPE = WORKLISTWORK_OBJECT = Daily Sales ReportDELETE_COMMANDS = ALLCOMMAND = GETFILEPARAM1 = D:\Server\<ClientName>.datPARAM2 = C:\Sales\Sales.dat

WAIT PARAM1 = File path PARAM2 = Time to wait (in

mm:ss)

PARAM1=C:\Sales\Endday.flgPARAM2=05:00

WORKLIST PARAM1 = Worklist file path PARAM1=F:\Worklist\Wrkng.wrk

WRITE_INI_FILE PARAM1 = File namePARAM2 = User variable name





Messaging Administration ECF For more information, see Chapter 15 - Messaging Administration.

The MSG_ADMIN ECF controls the settings in the Messaging Administration application. The following table defines the keywords and valid options for this type.

MSG_ADMIN ECF example

To configure the Messaging Administration application with default settings:

TYPE = MSG_ADMINACTION = ADD_OR_UPDATEMSG_KEEPDAY = 30MSG_OPTION = ERROR_ONLYRECEIPT_OPTION = ERROR_ONLYSYNC_INTERVAL = 3SYNC_NEXTTIME = 06/15/96 21:53:35NONDEVLY_KEEPDAY = 30

Table 137. Messaging Administration ECF format


TYPE= MSG_ADMIN Required.

ACTION= ADD, UPDATE, ADD_OR_UPDATE


MSG_KEEPDAY= 1..365 Thirty (30) days is the default.

MSG_OPTION= NONE, ERROR_ONLY, ALL ERROR_ONLY is the default.

RECEIPT_OPTION= NONE, ERROR_ONLY, ALL ERROR_ONLY is the default.

SYNC_INTERVAL= 1..30 One (1) day is the default.

SYNC_NEXTTIME= mm/dd/yy hh:mm:ss Date format conforms to settings in Control Panel. Time is in 24-hour format.

NONDEVLY_KEEPDAY= 1..60 Default time to produce a non-delivery report is thirty (30) days.

CLEAN_INTERVAL= 1..30 Default is one (1) day.

CLEAN_NEXTTIME= mm/dd/yy hh:mm:ss Date format conforms to settings in Control Panel. Time is in 24-hour format.



ECFs only support two digit dates, such as mm/dd/yy. If you use a four digit date (mm/dd/yyyy), the ECF will not be processed; instead, an error is generated in the Server Log.


CLEAN_INTERVAL = 1CLEAN_NEXTTIME = 06/13/96 21:53:24


User ECFCreate User ECFs when you want to add, update, or delete user profiles located in Directory Manager. The following table defines their keywords and valid options.

Table 138. User ECF format


TYPE= USER Required.

USERS= ADDRESSES=

User1Address [, ... , UserNAddress]ALL

Both keywords are interchangeable. Specify at least one address.

ACTION= ADD, UPDATE, ADD_OR_UPDATE, DELETE, ADD_IF_NOT_DEFINED, DELETE_IF_DEFINED, COPY ExistingUserAddress

At least one action is required.

LASTNAME= SURNAME=

User’s last name Both keywords are interchangeable. Required for new users.

FIRSTNAME= GIVENNAME=

User’s first name Both keywords are interchangeable. Required for new users.

MIDINITIAL= User’s middle initial

CLIENT= Name of user’s client

ADDRESSTYPE= AddressType RW

USERLOCATION= L-Local, R-Remote L

COPY_ASSIGNMENTS= YES, NO Assignments are not copied to the new user even if COPY_ASSIGNMENTS=YES is used. Make assignments manually.

SYNC= YES, NO

PASSWORD= User’s password First 6 characters of User’s Address. Required for new users.

ASSIGN_APPS= Application1 [ , ... , Application_n] ALL

UNASSIGN_APPS= Application1 [ , ... , Application_n] ALL


User ECF example

To define a new user:

TYPE = USERUSERS = LUCETTEACTION = ADDLASTNAME = SinatroubFIRSTNAME = LucetteADDRESSTYPE = RWPASSWORD = PGP0000CLIENT = PANAMA



Table 138. User ECF format (Continued)



User Group ECFsCreate User Group ECFs when you want to add, update, or delete user group definitions on the RemoteWare Server. The following table defines the format.

User Group ECF example

To add a user to every defined user group:

TYPE = USER_GROUPUSER_GROUPS = ALLACTION = UPDATEASSIGN_USERS = PJONES

Table 139. User Group ECF format


TYPE= USER_GROUP Required.

USER_GROUPS= GroupName1 [, ... , GroupName_n], ALL

At least one term is required.

ACTION= COPY ExistingGroupName, ADD, DELETE, UPDATE, ADD_OR_UPDATE, ADD_IF_NOT_DEFINED, DELETE_IF_DEFINED

Specify one action.

COPY_ASSIGNMENTS= YES, NO Default is YES. Only valid for COPY action.

DESCRIPTION= User group Description

DISTRIBUTION_LIST= YES, NO NO

ASSIGN_USERS= Address1 [, ... , Address_n], AddressType: Address1 [, ... , AddressType: Address_n], ALL

Default is RW: Address. Note that AddressType corresponds to the RW designation.

UNASSIGN_USERS= Address1 [, ... , Address_n], AddressType: Address1 [, ... , AddressType: Address_n], ALL

Default is RW: Address. Note that AddressType corresponds to the RW designation.




The GEN utilities For information about the ECF Server, see “ECF Server” on page 575.

The GEN utilities are a set of programs related to the ECF Server. While the ECF Server processes ECFs to modify the RemoteWare Server, the GEN utilities create ECFs based on information in the Server. You can execute GEN utilities from the Windows command line, the Interactive Session program, or as an EXECUTE event in a work object (for details, see “† EXECUTE program” on page 503.) The following table lists the available GEN utilities.

Use the GEN utilities to recreate one or more portions of a Server on another Server, or to keep a compact record of a system’s configuration.

Important: Do not use GEN utilities as a substitute for a backup. These utilities do not preserve all aspects of a Server, such as indirect and user assignments.

Note: When using GEN utilities, if you pass an argument with spaces in the name, it must be encapsulated in quotation marks.

Table 140. GEN utilities

Utility name and format Uses information from... Description

GENALL Directory Every application listed below. Creates ECFs and worklists for every resource, Client, object, and session on the Server.

GENLDC FileName Server Profile - Long Distance page. Generates an ECF for all Long Distance Services.

GENMODEM FileName [ModemName] Server Profile - Modem Types page. Creates an ECF for modem definitions. Includes all modems if ModemName is omitted.

GENNGRP FileName [ClientGroup] Client Profile - Client List and Members pages (Client groups only) .Creates the Client group ECF. Lists all Client groups if ClientGroup is not specified.

GENNODE FileName [ClientName] Client Profile - all Client related pages. Creates an ECF for Clients. Lists all Client definitions if optional parameters are omitted.Note: To save Multicast Client settings for later restoration, first use GENNODE to generate the Clients, then use GENSWO to generate the Multicast Workobjects.

T h e G E N u t i l i t i e s 631

GEN utilities reside in the \System directory on the Server’s execution drive. The utility writes output to the file name you specify. The file appears in the current directory if no path is stated.

GENPRTCL FileName Server Profile - Protocol page. Creates the ECF for all protocol items.

GENRSC FileName [ServerName] Server Profile - Resources page. Creates the Resource ECF. Omitting ServerName generates an ECF for resources on all Servers.

GENSCRPT FileName Server Profile - Dial Scripts page. Generates the Dial Script ECF for all dial scripts.

GENSESS FileName [SessionName] Session Editor - all pages. Creates a Session ECF. Includes all sessions if SessionName is omitted.

GENSWO FileName [ObjectName] Work Object Editor - all pages. Creates the work object ECF and associated work files. Omit ObjectName to create all object definitions.

GENSYS FileName Server Profile - Settings, Cluster, Alarms, Logging; Client Profile - Registration Options window. Includes Server Profile settings and the Client registration preferences.

GENMSG FileName Messaging Administration - All pages. Creates a MSG_ADMIN ECF with current Messaging settings.

GENUSER FileName [UserName] Directory Manager. Creates a User ECF for existing users. Use the UserName parameter to generate a User ECF for a single user.

GENUGRP FileName [GroupName] Directory Manager. Creates a User Group ECF listing each group and its users. Use the GroupName parameter to limit the ECF to a single group.

Note: Specifying a file name that already exists will overwrite the file without warning.

Table 140. GEN utilities (Continued)

Utility name and format Uses information from... Description


Precedence of GEN utilitiesWhen creating a Server’s configuration, there are some GEN utilities that need to run before others. For example, the GENSWO work object utility must generate the work object ECF before GENSESS session utility can assign the objects in a session ECF.

Executing GENALL automatically accomplishes this for you, but manually creating and running your ECFs may require existing information for a successful ECF completion. The following table shows the ordering of GEN utilities as they are created by the GENALL utility.

Table 141. GEN utility precedence

Utility name Comments

GENSYS No dependencies.

GENSCRPT No dependencies.

GENMODEM No dependencies.

GENLDC May require dial script from GENSCRPT.

GENRSC Requires modems from GENMODEM and long distance services from GENLDC.

GENPRTCL No dependencies.

GENNODE Requires modems from GENMODEM, long distance services from GENLDC, resources from GENRSC, and protocols from GENPRTCL.

GENNGRP Requires Clients from GENNODE.

GENSWO No dependencies.

GENSESS Requires Clients from GENNODE, groups from GENNGRP, and objects from GENSWO.

GENMSG No dependencies.

GENUSER Requires Clients from GENNODE, may require application work objects from GENSWO.

GENUGRP Requires users from GENUSER.

A P P E N D I X

D

Kernel Command Line Switches

The RemoteWare Client consists of three processes:

• A communications program

• A user interface program

• A process which places the Client status icon in the system tray on Windows systems

The communications process controls the Client’s ability to communicate with the

RemoteWare Server and can be used outside of the Client user interface to control the

RemoteWare Client.


• “RWKernel.exe Command Line Switches” on page 634


RWKernel.exe Command Line Switches The RemoteWare Client software uses three processes:

• A communications program called RWKERNEL.EXE

• A user interface program called RWCLIENT.EXE

• A process called RWCTRAY.EXE which places the Client status icon in the system tray on Windows systems.

Typically the Client is called into memory when the Client user opens the RemoteWare Client user interface. This starts the RWCLIENT process. It calls RWKERNEL which then calls RWCTRAY.

You may need to start the communications program without opening the Client user interface. Use the RWKERNEL program, calling it as part of your custom applications.

The following switches are available for use with the RWKERNEL program.

Table 142. Command Line Switches for RWKernel.exe

Parameter Description

-c Cancels the connection.

-d Performs a connection, kernel needs to be loaded.

-h Loads the kernel suppress the Loading Kernel message.

-i Re-initializes the connection.

-nodtr Disables use of DTR.

-r Unloads the kernel.

-u Loads the kernel, connects, and then unloads the kernel.

-x Executes a specified program or application on a Windows Client.

A P P E N D I X

E

RemoteWare Database Maintenance


• “Log maintenance process” on page 636

• “Maintaining SQL Server databases” on page 637


Log maintenance processLog Maintenance is a separate process that allows flexible schedule and transaction sizes. Log maintenance is performed through a system work object called RW Log Maintenance that is assigned by default to a new Client called System running a process-only session called RW Log Maintenance that is scheduled and executed once an hour.

The Log Maintenance System Work Object sets the segment size to 1000 as follows:

• 1000 entries from the Session History, Session History Details, Session Index, Server Message, and File Transfer tables are deleted at a time. Log maintenance is currently not performed on any Multicast tables.

• Syntax : LogMaint.exe –S 1000If a particular Log Maintenance process runs for more than one hour, the next scheduled instance of Log Maintenance is ignored until the next scheduled process can run. This scheduling prohibits two log maintenance processes from running at the same time.

The recommended segment size is 1000 records and the recommended schedule is hourly. However, the schedule can be changed, and this process can be run on any custom schedule based on your needs. Every segment deleted is logged in to the Server Message logs. Setting up segments sizes of less than 1000 records will cause the Log Maintenance process to run longer and create additional entries in the Server message logs. Creating a very large segment size can also cause the Log Maintenance process to run slower than expected.

If there are no client licenses available, the System client and the RW Log Maintenance session is not created. When no licenses are available, the RW Log Maintenance Work object can be assigned to any client normally assigned to execute all Server process only sessions.

If you set a threshold value for logs at 100,000 records and subsequently create 120,000 records, the Log Maintenance process executes and the 20,000 records over the threshold are deleted.

M a i n t a i n i n g S Q L S e r v e r d a t a b a s e s 637

Maintaining SQL Server databasesMaintenance on a SQL Server database must be performed on a regular basis. At a minimum, you should perform the maintenance weekly during a time when there is minimal database activity.

Over time, the indexes become inefficient, which slows processing time. When performance becomes unacceptably slow, you should perform maintenance on the databases. The examples below are specific to the inventory database.

When database services are stopped, data is not processed.

Complete the following steps to set up a maintenance task for SQL 2000:

1 Expand the Management folder for the database for which to create the maintenance task.

2 Right-click Database Maintenance Plan and select New Maintenance Plan to open the Database Maintenance Plan Wizard.

3 Follow the steps in the wizard to include the following:

• Select Databases page — Select RWIMData

• Update Data Optimization Information page — Select Reorganize data and index pages

Change free space per page percentage to 10

Select Change (located beside the Schedule window)

• Edit Recurring Job Schedule page — Select a schedule for this maintenance task

• Database Integrity Check page — Select the Check database integrity, Include indexes, and Attempt to repair any minor problems check boxes

• Specify the Database Backup Plan page — Choose a backup schedule

• Specify the Transaction Log Backup Plan page — Select a backup schedule for the transaction log

Note: Stop the RemoteWare database services, before you perform maintenance on a database. Open Control Panel and double-click Services. Select the RemoteWare Server Service and click Stop. Next, select the RemoteWare DB Server Service and click Stop. Click Close, and then perform the database maintenance. When finished, restart both Services select them in Control Panel Services and click Start.


• Reports to Generate page — Select Write report to a text file in directory

• Maintanance History page — Select Write history to the MSDB.dbo.sysdbmaintplain_history table on this server

Enter 1000 in the rows for this plan field

• Completing the Database Maintanance Plan Wizard page — Select Finish

4 Click OK to close the wizard.

Complete the following steps to set up a maintenance task for SQL 2005:

1 Expand the Management folder for the database for which to create the maintenance task.

2 Right-click Database Maintenance Plan and select Database Maintenance Plan Wizard.

3 Follow the steps in the wizard to include the following:

• Select a Target Server page — Complete the required information

• Select Maintenance Tasks page — Select Pick Up Database (Transaction Log) and one or more maintenance tasks from the list

• Define Back Up Database (Transaction Log) Task page — Select a back up schedule for the transaction log

• Select Maintenance Task Order page — Choose the order in which each task is performed

• Define Database Check Integrity Task page — Select the RWIMData database, and include indexes

• Define Cleanup History Task page — Accept the default settings

• Select Plan Properties page — Define a schedule to define maintenance frequency

• Select Report Options page — Select Write history to the MSDB.dbo.sysdbmaintplain_history table on this server

• Complete the Wizard page — Select Finish.

I N D E X

SYMBOLS

& (ampersand)

Client Profile 147, 148Members page 154Objects page 157Sessions 159

& flag 218* (asterisk)

Client Profile 147, 148Members page 154Objects page 157Sessions page 159

flag in Schedule Manager 252* flag 218+ flag 218- flag 218.ecb file extension 575.ece file extension 575.ecf file extension 575.ecp file extension 575.rtf file extension 383.txt file extension 383<ClientBin> variable 447<ClientESD> variable 448<ClientHome> variable 448<ClientInstall> variable 448, 453<ClientName> variable 448<d> variable 448<Date> variable 448<dw> variable 448<dy> variable 448<hh> variable 448<m> variable 448

<mm> variable 449<SendFilesAttempted> variable 448, 449<SendFilesFailed> variable 448, 449<SendFilesSuccessful> variable 448, 449<Serial#> variable 449<Server> variable 449<ServerData> variable 449, 453<ServerExecution> variable 449<Session_Origin> variable 449<ss> variable 449<Time> variable 449<WindowsDir> variable 450<WindowsESD> variable 450<WindowsSysDir> variable 450<WindowsSysESD> variable 450<y> variable 450<y1> variable 450<y4> variable 450| flag 218– (dash) 252

NUMERICS

3COM 418

A

A flag 218Abort Active Session command 248About RemoteWare Menu command 39ACTION= keywords (ECFs) 577Activation 194

window 259Active sessions 270active sessions 253Active Sessions item (Network Status) 268, 271


Add Application dialog box 48Add command 45Add Events menu 185, 198

Worklist Editor 216address types, messaging 418Administration report 330, 343

command line 343Administrator 40

application rights 51icon 31main window 46menu commands and toolbar buttons 45overview 31reasons for user access 48

After event 458Alarms 270Alarms item (Network Status) 268, 272Alarms property page 67, 113All Active Sessions on All Servers 248All Active Sessions on Current Server 248All Utilities

command 38group 40

Allow Registration to Create New Clients 175Alternate resource (Server page) 142Answer on Ring

Command Strings page 106Modem Types page 102

App objects 187APPEND file(s) to another event 443, 466AppGrp objects 187Application Attributes property page 180, 195Application Group Object 184Application Group objects 181, 187Application objects 181, 187Application Work Objects 136Applications check box (Settings page) 74Applications page

user group’s Profile window 439user’s Profile window 434

Apps disabled (Client) 258Apps disabled (Global) 258Apps disabled (Session) 258ASCII APPEND file(s) to another event 443, 469

Assign Application Objects window 201Assignments property page 124, 144ASYNC

Network Status 274resource 82

ASYNC item (Network Status) 268Async Resource Detail dialog box 84ATT 418Attributes page 435Auto Answer 105

B

B flag 218Before event 458begin QUOTA block event 444, 471blocked sessions 253Both session type 231Busy error type 376buttons 29by Client command 248by Session command 247, 248Byte level differencing, event attribute 454Bytes Received 277Bytes Sent 277Bytes Sent / Rcvd 281

C

C flag 218Cancel Changes command 127CCMAIL 418Change Group Description command 127Change Password dialog box 419check boxes 29CHECK DISK event 443, 475CHECK file event 443, 477Check if newer, event attribute 455CHECK SEND file(s) to Client 443, 479Check updates only, event attribute 454Choose User dialog box 168, 176Clear Alarm command 266Clear command 45Client

Address 143Configuration 137

I n d e x - C 641

Counter 176Counts 129ECF 574, 586group, defined 124makekit 161Phone Number 143Prefix 175Resources Property page 82

Client Commands menu 387Client Communications report 330, 339, 343

command line 344filters 338

Client Detail report 330, 339, 345command line 346filters 338

Client Group ECF 574, 593Client Groups report 330, 339, 348


Client List property page 124, 129Client Profile 41

application rights 51Assignments page 124, 144Client List page 124, 129Client page 124, 137Comments page 125, 152Filter menu 130General page 124, 135icon 31Information page 125, 151Members page 125, 153menu commands and toolbar buttons 126Objects page 125, 157overview 31Parents page 125, 155property pages in 124reasons for user access 48Registration menu 174Server page 124, 142Sessions page 125, 159

Client property page

Client Profile 124, 137Details for ResourceName window 279

Client Registration Options window 175

Client Security error type 376Clients property page

Session Editor 223, 240Work Object Editor 180, 206

Clients report 330, 339, 350command line 350filters 338

Cluster property page 66, 75column headings 30Command Confirmation message box 386Command Line

Application Attributes page 195Command Options page 56

Command Line Switches

RWKernel.exe 634Command menu 126

Interactive Session 385Network Status 266Report Manager 337Schedule Manager 247Server Profile 69Work Object Editor 184

Command Options property page 56Command Strings property page 104, 105Commands menu

Session Editor 224COMMENT event 444, 481Comments property page 125, 152Compression

Protocol Property page 110Settings page 74

COMPUSERVE 418Concurrent

sessions 71Conditional - False (|), event attribute 455Conditional - True (&), event attribute 455controls 29Copy command 25

Client Profile 126Server Profile 68Session Editor 224Work Object Editor 184, 198Worklist Editor 215

COPY file(s) event 443, 482


Copy Modem Type dialog box 103Copy Report File dialog box 336Count Failed sessions 235Count Out of Range sessions 235Count Successful/Completed sessions 234Create 32-bit Upgrade 161CREATE REGISTRY KEY event 444, 484Critical error type 376Critical event (*), event attribute 455CSV (Comma Separated Value) file

Client Communications report 344Client Detail report 345Client Groups report 348Clients report 350File Transfer Log report 351Long Distance Service Usage report 352Network Group report 355Port Communications report 356Ports report 357Protocols report 359Server Log report 361Session Event Log report 362Session Log report 364Session Recovery report 366Sessions report 367System report 369User Group Listing report 371Work Objects report 374

Cumulative Client Statistics 280Current counts 261Current retry 255Current Size 59Cut command 197

Worklist Editor 215

D

D flag 218Data Rate 276Database maintenance 637Database Subsystems page 408Datasource dialog box 63Deactivation 194Default template user 176Defined

Clients 71sessions 71

Delete after (-) 465Delete after (-), event attribute 455Delete command 25

Client Profile 126Server Profile 68Session Editor 224Work Object Editor 184, 198Worklist Editor 216

DELETE file(s) event 443, 486DELETE INI FILE event 445, 488DELETE REGISTRY KEY event 444, 491DELETE REGISTRY VALUE event 444, 493Deleted 258Deny command 45Dependent Session Details property page 260Depends on session (aka

monitored session) 262Depends on Session window 234Description

Administrator 59Client Profile 135

Detail command 249Network Status 266

Detailed History For Session window

event flags 307Expand Objects option 307fields defined 305

Details for ResourceName window

Client page 279Resource page 276Session page 278

Details for Session window 254Dependent Session Details page 260General page 254Objects page 256Options page 259

Device 84, 273Resources Property page 81

dial script

commands 99compiled 101editing 98

I n d e x - D 643

Long Distance Service Detail dialog box 79special characters 100uncompiled 101

Dial Script ECF 574, 580, 595Dial Script Editor 79, 98Dial Script Name 98Dial Scripts property page 67, 97dial string 78

special characters 79Dial String/@Dial Script 78dialog boxes 140

Add Application 48Async Resource Detail 84Change Password 419Choose User 168, 176Copy Modem Type 103Copy Report File 336datasource setup 63ECF Server Options 57Edit Attribute 436Edit Modem 104Enter Date 233Enter Date and Time

Server Profile 73Session Editor 233, 236

Enter Server Address 141Enter Server Phone Number 140Enter Time 232Execution Server Options 58Find

Work Object Editor 198Worklist Editor 218

in RemoteWare 26Limit Object Execution 194Log File Setup 60Long Distance Service Detail 78NetBIOS Detail 88New Modem Type 103PROCESS ONLY Detail 91Protocol Service Detail 111Rename Modem Type 103Rename Protocol 110Report Definition 337Select Client’s Universal Time Coordinate 136

Select Filter File

Client Profile 134Session Editor 229

Server Address 141Server Name 141Session Timeout 387Set Colors 384Set Page Size For Printing 337SPX Detail 92TCP/IP Detail 94Update Licensing 119

Direct Connect Client 85DIRectory listing event 443, 495Directory Manager 41

application rights 51icon 34, 428left pane 428main window 428menu commands and toolbar buttons 427overview 34, 424Profile window

for a user group 436for an individual user 429

reasons for user access 48right pane 428starting 428

Directory Synchronization page 412Disable all file transfer logging 116Disable all session logging 115Disable Client command 126Disable command 69, 184Disable comment logging 115Disable event 198Disable multicast logging 116Disable no execute logging 116Disable Right command 45Disable Session command 224Disable session event logging 115Disabled 258Do not overwrite, event attribute 454Do this session early if 237drop-down list boxes 30During event 458


E

ECF Server 575command line options 575GEN utilities 630polling immediately 576

ECF Server Options dialog box 57ECFs

ACTION= keywords 577Client 574, 586Client Group 574, 593creating 578creating with GEN utilities 630Dial Script 574, 580, 595guidelines for using 577linking 577list of 574Long Distance Service 574, 582Messaging Administration 574, 625Modem 574, 583MSG_ADMIN 574, 625Protocol 574, 596Resource 574, 598Scheduler 574, 602Session 574, 604Subscriber 574System 574, 613types of 574User 575, 627User Group 575, 629Work Object 574, 609Worklist 574, 617

Edit Attribute dialog box 436Edit menu

Interactive Session 383Work Object Editor 184, 197Worklist Editor 215

Edit Modem dialog box 104Command Strings page 105Result Codes page 107Settings page 108

Electronic Software Distribution

Client Profile 136ELSE IF event 444, 497Enable answer on ring 106

Enable Client command 126Enable Client Registration 175Enable command 69, 184Enable Compression 112Enable event 198Enable modem flow control 106Enable Options 136Enable resource

NetBIOS Detail 89PROCESS ONLY Detail 91SPX Detail 92TCP/IP Detail 94

Enable retries 237Enable Right command 45Enable Session command 224Enable this Service 79Enabled

Clients 71General Attributes page 192sessions 71

Encrypt this session when possible 243Encryption 393Encryption required for this session. 243END IF event 444, 497End of window time 262END QUOTA block event 444, 498END REPEAT event 444, 498END SESSION event 444, 499END WORK OBJect event 444, 500Enter Date and Time dialog box

Server Profile 73Session Editor 233, 236

Enter Date dialog box 233Enter Server Address dialog box 141Enter Server Phone Number dialog boxes 140Enter Time dialog box 232Enter Update Code 119ESD

check box (Settings page) 74events 196objects 181, 187

ESD disabled (Client) 258ESD disabled (Global) 258ESD disabled (Session) 258

I n d e x - E 645

ESD Failure error type 376Event attribute

Byte level differencing 454Check if newer 455Check updates only 454Conditional - False (|) 455Conditional - True (&) 455Critical event (*) 455Delete after (-) 455Do not overwrite 454Make Destination Path 455Not required for successful session 455Recursive 455Retry 455Safe transfer 454Turn compression off 455Work Object Critical event (+) 455Xpress Transfer 454

Event Details command 198Worklist Editor 216

Event Details window 446APPEND file(s) to another 466ASCII APPEND file(s) to another 469begin QUOTA block 472CHECK DISK event 475CHECK file 477CHECK SEND file(s) to Client 479COMMENT 481COPY file(s) 482CREATE REGISTRY KEY 484DELETE file(s) 486DELETE INI FILE 488DELETE REGISTRY KEY 491DELETE REGISTRY VALUE 493DIRectory listing 495END SESSION 499END WORK OBJect 501EXCEPTION worklist 502EXECUTE program 503get FILE STATUS 509GET file(s) from Client 506GET REGISTRY value 511GET VARiable from SCRIPT 513IF 515

insert WORKLIST 518LOAD SCRIPT file 520MAKE DIRectory 522MESSAGE EXCHANGE 524NOTIFY nt server 525READ INI FILE 529REBOOT 531RELEASE SCRIPT 532REMOVE DIRectory 534RENAME file(s) 536REPeat IF previous event FALSE 538REPeat IF previous event TRUE 538RUN SCRIPT FUNCTION 541SEND file(s) to Client 543SET file ATTRIButes 548SET REGISTRY VALUE 550SET VARiable 552SET VARiable in SCRIPT 554TEST if Client is in GROUP 556TEST VARiable 558UNASSIGN from Client 560USER defined ALARM 562WAIT for file to exist 564WRITE INI FILE 566

event flags 307events

After 458APPEND file(s) to another 443, 466ASCII APPEND file(s) to another 443, 469Before 458begin QUOTA block 444, 471CHECK DISK 443, 475CHECK file 443, 477CHECK SEND file(s) to Client 443, 479COMMENT 444, 481COPY file(s) 443, 482CREATE REGISTRY KEY 444, 484DELETE file(s) 443, 486DELETE INI FILE 445, 488DELETE REGISTRY KEY 444, 491DELETE REGISTRY VALUE 444, 493directory and file names in 453DIRectory listing 443, 495During 458


ELSE IF 444, 497END IF 444, 497END QUOTA block 444, 498END REPEAT 444, 498END SESSION 444, 499END WORK OBJect 444, 500ESD 196EXCEPTION worklist 445, 502EXECUTE program 443, 503File Transfer 442get FILE STATUS 443, 509GET file(s) from Client 442, 506GET REGISTRY VALUE 444, 511GET VARiable from SCRIPT 445, 513IF 444, 515insert WORKLIST 445, 518LOAD SCRIPT file 445, 520MAKE DIRectory 443, 522MESSAGE EXCHANGE 445, 524NOTIFY nt server 445, 525On Client 458On Server 458Operating System 442, 443optimizing execution 459preprocessing 459READ INI FILE 444, 529REBOOT 443, 531RELEASE SCRIPT 445, 532REMOVE DIRectory 443, 534RENAME file(s) 443, 536REPeat IF previous event FALSE 444, 538REPeat IF previous event TRUE 444, 538RUN SCRIPT FUNCTION 445, 541Scripting 442, 445SEND file(s) to Client 443, 543Server 442, 445Session Control 442, 444SET Client TIME 443, 547SET file ATTRIButes 443, 548SET REGISTRY VALUE 444, 550SET VARiable 444, 552SET VARiable in SCRIPT 445, 554TEST if Client is in GROUP 445, 556TEST VARiable 445, 558

UNASSIGN from client 445, 560USER defined ALARM 445, 562using literal strings 451using wildcard characters 451WAIT for file to exist 443, 564Worklist Editor 217WRITE INI FILE 445, 566

Events property page 180, 196EX 418EXCEPTION worklist event 445, 502Executable file 195Execute dependent session at end of window 234Execute Now and Skip command 247Execute Now command 247EXECUTE program event 443, 503Execution (General Attributes page) 192Execution Server

start additional 527Execution Server Options dialog box 58Execution window 193, 258Exit command 25

RemoteWare Menu 38Export command 184, 197

Worklist Editor 215Extensions Not To Compress 74

F

FAX 418File menu 25

Administrator 45Client Profile 126Interactive Session 383RemoteWare Menu 38Report Manager 336Server Profile 68Session Editor 224Work Object Editor 184Worklist Editor 215

File Transfer

events 442File Transfer Log report 330, 339, 351


File Transfer Logs 291

I n d e x - G 647

File Transfer submenu (Add Events menu) 199Files Sent / Rcvd 280Filter

by Active 250by Application Group Objects 188by Application Objects 188by Blocked 250by Client 250by Clients Requiring Manual Verification 131by Disabled Clients 131by Disabled Objects 188by Disabled Sessions 227, 229by Enabled Clients 130by Enabled Objects 188by Enabled Sessions 227, 229by ESD Objects 188by Group Objects 188by Members of Selected Groups 130by Multicast Objects 188by Object Owner 188, 190by Pending 250by Registered Clients 131by Selected Clients and Groups 130by Selected Objects 188, 189by Server 250by Session 227, 228, 250by Suspended 250by Unregistered Clients 131by Worklist Objects 188Remove All Filters 131, 227

Filter by All 322Filter by ECF 321Filter by session status 322Filter by Status 321Filter dialog box

Category 300Field 300

Filter menu

Client Profile 128Schedule Manager 249Session Editor 224, 227Work Object Editor 185

Find command 198Worklist Editor 216

Find dialog box

Work Object Editor 198Worklist Editor 218

Find next command 198Worklist Editor 216

Find option

search and replace 218flags

& (Conditional true) 218* (Session critical) 218+ (Work object critical) 218- (Delete after) 218| (Conditional false) 218A (After event) 218B (Before event) 218C (On Client) 218D (During event) 218S (On Server) 218Schedule Manager 252Worklist Editor 218

Flags command 216Flow Control 102For all Clients 242For all Clients, enable 74For this Session 242

G

Gateway Manager page 416GEN utilities 630

precedence of 632GENALL 630General Attributes property page 180, 192General property page

Client Profile 124, 135Details for Session window 254

GENLDC 630dependencies 632

GENMODEM 630GENMSG 631GENNGRP 630

dependencies 632GENNODE 630

dependencies 632GENPRTCL 631


GENRSC 631dependencies 632

GENSCRPT 631GENSESS 631

dependencies 632GENSWO 631GENSYS 631GENUGRP 631

dependencies 632GENUSER 631

dependencies 632get FILE STATUS event 443, 509GET file(s) from Client event 442, 506GET REGISTRY VALUE event 444, 511GET VARiable from SCRIPT event 445, 513Grant command 45Group Counts 129Group menu 38Group objects 181, 187Groups page 433Grp objects 187

H

header controls 30Help

menu 39Help Topics command 25, 39

I

icon

Administrator 31Client Profile 31Directory Manager 34Interactive Session 33Inventory Manager 35Log Viewer 33Messaging Administration 33Network Status 33RemoteWare Menu 22Report Manager 33Schedule Manager 32Server Profile 31Session Editor 32Session Recovery 33

Software Manager 35Subscriber Editor 34Work Object Editor 32Worklist Editor 32Workshop Editor 34

Icon View command 38IF event 444, 515Import command 184, 197

Worklist Editor 215In/Out session type 253Inbound # 276Inbound Data Rate 85Inbound Only command 69Inbound Range 255Inbound Schedule 139Inbound session type 231, 253Inbound Work Object Selection 136Inbound/Outbound command 69Information Management Utilities

command 38group 41

Information property page

Client Profile 125, 151Server Profile 66, 70

Insert After command 216Insert Before command 216insert WORKLIST event 445, 518Install Drive and Path 136Install Notes command 39Interactive Session 41

application rights 51Client Commands menu 387Command menu 385Edit menu 383File menu 383icon 33main window 393menu commands and toolbar buttons 381miscellaneous commands 390Options menu 386overview 33, 380reasons for user access 48Remote Control 395Server Commands menu 390

I n d e x - L 649

starting 393using literal strings 391using long file names 392View menu 384

Invalid Disk Drive error type 376Invalid Password error type 376Invalid Serial Number error type 376Inventory Manager 35, 41

application rights 51icon 35reasons for user access 49

Inventory Manager Logs 292

L

Last Compiled 97Last Modified 97LD Service 278License Log window 119Licensing property page 67, 118Limit execution to assigned Session Objects 242Limit Object Execution dialog box 194Limit Object Execution to Client Type(s) 194Limit Outbound property page 67, 96Limited by Client type 258Limits

Schedule Manager 572Session Editor 571Work Object Editor 570

Line Status 278list boxes 30List View command 39Listener for multitransport (Client page) 137literal strings (events) 451LOAD SCRIPT file event 445, 520Local Server Name 71Log ESD Objects not requiring updates 116Log File Setup dialog box 60Log Files property page 59log maintenance 636Log only failed file transfers 116Log only failed multicast file transfers 116Log only failed sessions 115Log Viewer 41

application rights 51

fields

All 295File Transfers 295

icon 33overview 33reasons for user access 49

Log wildcard transfers not requiring updates 116Logging property page 67, 115Long Distance property page 66, 77Long Distance Service 86, 143Long Distance Service Detail dialog box 78Long Distance Service ECF 574, 582Long Distance Service Usage report 330, 339, 352


Long Distance Services report 330, 353command line 353

Lost Carrier error type 376

M

Maintain Dial Connection 73Maintenance

RemoteWare database 637RemoteWare log maintenance 636

Make Destination Path, event attribute 455MAKE DIRectory event 443, 522Make Installation Kit command 126Make-Kit Installation wizard 161makekit 161making an installation kit for a Client 161Manual Verification command 128, 174MAPI (Messaging API) 402

and RemoteWare messaging 404Master Worklist 462Matching ASYNC ports 256Matching Client Configuration 143Matching resource counts 256Max bps 273

Resources Property page 82Max Data Rate 85, 102Max Size 59Maximum

Clients 71Maximum (Log File Setup) 60


Maximum Data Rate 108MCI 418Members page 438Members property page

Client Profile 125, 153Work Object Editor 180, 200

menu bar 24menu commands

Client Profile 126Directory Manager 427Interactive Session 381Messaging Administration 406Network Status 266Report Manager 335Schedule Manager 247Server Profile 68Session Editor 224Work Object Editor 184Worklist Editor 215

menus

general commands in RemoteWare 25overview 23RemoteWare 23shortcut 24

message boxes 28MESSAGE EXCHANGE event 445, 524Messages Sent / Rcvd 281messaging 403

gateway address types 418RemoteWare service providers 404

Messaging Administration 41application rights 51Database Subsystems page 408Directory Synchronization page 412Gateway Manager page 416icon 33, 402main window 402menu commands and toolbar buttons 406Messaging Log page 410Non-Delivery Receipt page 414overview 33, 402Personal Folders 419reasons for user access 49starting 402

Messaging Administration ECF 574, 625Messaging Listing report 330, 339, 354

command line 354Messaging Log page 410Messaging Logs 292Messaging Operations command 38Messaging Operations group 41Messaging Services 403MHS 418Minimum (Log File Setup) 60Modem 276Modem Delay 108Modem Dial 106Modem ECF 574, 583Modem Error (error type) 376Modem Escape 106Modem Hangup 106Modem Init 105Modem Port (Client page) 139Modem Timeout 108Modem Type

Async Resource Detail 85Client page 138General page 256Resources Property page 82

Modem Types property page 67, 102Modems report 330, 354

command line 354Modify button 59MS 418MSA 418MSG_ADMIN ECF 574, 625MSN 418MSPEER 418MTA (Message Transfer Agent) 354, 402, 403Multicast


Multicast item (Network Status) 268Multicast Logs 292Multicast Object 184Multicast objects 187Multicast session type 231, 253Multicast Work Object 181

I n d e x - N 651

Multitransport listener (Client page) 137

N

Name

Cluster page 75Dial Scripts page 97Long Distance page 77Modem Types page 102Registry Settings page 61Settings page 72System Control page 55

NetBIOS


NetBIOS Detail dialog box 88NetBIOS item (Network Status) 268Network Group report 331, 339, 355


Network Groups property page 66, 80Network Status 41

Active Sessions item 271Alarms item 272application rights 51icon 33, 265items in the left pane 267main window 265menu commands 266overview 33reasons for user access 49RemoteWare Servers item 269Resources item 273Server Name item 270Server states 270tree control 267

New Application Group Object command 184New Application Multicast Object command 184New Application Object command 184New Client command 126New command 25, 68

Session Editor 224Worklist Editor 215

New ESD Object command 184New Group command 126

New Group Object command 184New Modem Type dialog box 103New Result Code 107New Worklist Object command 184No Answer 105

error type 376No Applications during Session 242No Connect error type 377No Dial Tone error type 377No encryption for this session 243No ESD during Session 243No Resources error type 377Non-Delivery Receipt page 414Not required for successful session, event attribute 455NOTIFY nt server event 445, 525Number of Records 60Number of Resources

NetBIOS Detail 89PROCESS ONLY Detail 91SPX Detail 92TCP/IP Detail 94

O

objects

reasons for not executing 258that will be executed 257that will NOT be executed 257

Objects property page

Client Profile 125, 157Details for Session window 256Session Editor 223, 238Work Object Editor 180, 186

On Client event 458On Server event 458Open command 215Operating System

events 442, 443Operating System submenu (Add Event menu) 199option buttons 29Options

command 128, 174menu 386property page

Details for Session window 259


Session Editor 223, 242Other Server Serial Numbers 136Out of Range error type 377Outbound session type 231, 253Overwrite Existing 60Owner 192

P

Packet

Protocol Property page 110Rejects 277Rexmits 277Rexmits / Rejects 281Size 110, 111Statistics 276

Packets

Rcvd 277Sent 277Sent / Rcvd 281

Parents property page

Client Profile 125, 155Work Object Editor 181, 210

Password (Client Profile) 135Paste command 198

Worklist Editor 216pending sessions 253Personal Address Book window 421Personal Folders window 419Port

Number 84Phone Number 85Priority 86

Port # 273Resources Property page 81

Port Communications report 331, 339, 356command line 356filters 338

Portable Security 67Portable Security page 120Portable Security property page 67Portable Security Users report 331, 339, 358

command line 358Ports report 331, 339, 357

command line 357

Post-ESD events 197Pre-ESD events 196Primary resource (Server page) 142Primary Rsc 280Primary Server 139Priority

General Attributes page 193Objects page 257

Process Only

Network Status 274resource 82session type 253

PROCESS ONLY Detail dialog box 91Process Only item (Network Status) 268Process Only session type 231Profile page


Profile window


PROFS 418Program 56programs, list of in RemoteWare 31Prompt for

Client Name 168Serial Number 168User Information 168

property pages

Alarms 113Application Attributes 195Applications

user group’s Profile window 439user’s Profile window 434

Assignments 144Attributes 435Client

Client Profile 137Details for ResourceName window 279

Client List 129Clients

Session Editor 240Work Object Editor 206

Cluster 75

I n d e x - Q 653

Command Strings 104, 105Comments 152Database Subsystems 408Dependent Session Details 260Dial Scripts 97Directory Synchronization 412Events 196Gateway Manager 416General

Client Profile 135Details for Session window 254

General Attributes 192Groups 433Information

Client Profile 151Server Profile 70

Licensing 118Limit Outbound 96Logging 115Long Distance 77Members

Client Profile 153user group’s Profile window 438Work Object Editor 200

Messaging Log 410Modem Types 102Network Groups 80Non-Delivery Receipt 414Objects

Client Profile 157Details for Session window 256Session Editor 238Work Object Editor 186

Options

Details for Session window 259Session Editor 242

Parents

Client Profile 155Work Object Editor 210

Personal Address Book 421Portable Security 120Profile


Protocol 109RemoteWare 23Resource 276Resources 81Result Codes 104, 107Schedule 230Server 142Session 278Sessions

Client Profile 159Session Editor 225Work Object Editor 204

Settings

Edit Modem dialog box 104, 108Server Profile 72

tabs 29Users 208

Protocol

Client page 138property page 67, 109

Protocol ECF 574, 596Protocol Service Detail dialog box 111Protocols report 331, 339, 359

command line 359

Q

Quick 284Quick Filter Views 284Quick filters

multicast 292Quiet Mode 57, 575

R

Range 255Read Filters command 131, 188

Schedule Manager 250Session Editor 227, 229

READ INI FILE event 444, 529Read Update Code(s) from UPD File 119REBOOT event 443, 531Recursive option 507Recursive, event attribute 455Refresh Automatically command 249Refresh command 216, 249


Registration Disabled error type 377Registration menu 128, 174Registry Settings property page 61RELEASE SCRIPT event 445, 532Remote Control 380, 395RemoteWare 636

buttons 29check boxes 29common menu commands 25controls 29dialog boxes 26fields 29menu bars 24menus in 23message boxes 28messaging service providers 404opening or saving files 27program overview 31property pages 23resource types 82setting options in 27shortcut menus 24status bars 25text boxes 29toolbars 25windows 22

RemoteWare database

maintenance 637services 637

RemoteWare Gateway detail window 417RemoteWare Menu

All Utilities group 40commands and toolbar buttons 38exiting 42icon 22Information Management Utilities group 41main window 40Messaging Operations group 41programs in 40Server Logs group 41Server Operations group 41Server Setup group 40

RemoteWare Servers (Network Status) 269Remove All Filters command 188

Schedule Manager 250Session Editor 229

Remove command 45REMOVE DIRectory event 443, 534Rename command 25, 68, 184

Session Editor 224RENAME file(s) event 443, 536Rename Modem Type dialog box 103Rename Protocol dialog box 110REPeat IF previous event FALSE event 444, 538REPeat IF previous event TRUE event 444, 538Replace command 198Replace option 219report definition 333Report Definition dialog box 337Report Manager 41

application rights 51Command menu 337File menu 336filters available in 338icon 33, 342list of available reports 330main window 342menu commands and toolbar buttons 335overview 33reasons for user access 49report execution files 332starting 342

Report View command 39reports

Administration 330, 343Client Communications 330, 339, 343Client Detail 330, 339, 345Client Groups 330, 339, 348Clients 330, 339, 350definition of 330executable files 332File Transfer Log 330, 339, 351filters for 338in Report Manager, list of 330Long Distance Service Usage 330, 339, 352Long Distance Services 330, 353Messaging Listing 330, 339, 354methods of generating 332, 333

I n d e x - R 655

Modems 330, 354Network Group 331, 339, 355Port Communications 331, 339, 356Portable Security Users 331, 339, 358Ports 331, 339, 357Protocols 331, 339, 359Server Log 331, 339, 360Session Event Log 331, 339, 361Session Log 331, 339, 364Session Recovery 331, 339, 365Sessions 331, 339, 366System 331, 339, 369User Group Listing 331, 339, 371User Listing 332, 372Work Objects 332, 339, 373

Requestable 258Require Administrator Verification 176Require Registration Key 176Reset All Security command 126Reset Security command 126Resource

General page 256Protocol Property page 109Server page 142

Resource ECF 574, 598Resource property page 276Resources item (Network Status) 268, 273Resources property page 67, 81Result Code/String 107Result Codes property page 104, 107Resume on All Servers command 251Resume on Current Server command 250Resume on Restart on All Servers command 64, 251Resume on Restart on Current Server command 64,


251Resume Scheduler command 266Resume Session command 249Retries Left 255, 278Retry

frequency 255Retry, event attribute 455ReXmit

Protocol Property page 110Timeout 112

RUN SCRIPT FUNCTION event 445, 541RW 418RWKernel.exe

Command Line Switches 634RWS 187RWSUB 187RWWORKSHOP 187

S

S flag 218Safe transfer, event attribute 454Save As command 215Save command 215Schedule Manager 41

application rights 52Command menu 247Filter menu 249flags 252icon 32main window 252menu commands and toolbar buttons 247overview 32reasons for user access 49Scheduler menu 250View menu 249

Schedule property page 223, 230Schedule Registration Session command 128, 174Scheduler 246Scheduler ECF 574, 602Scheduler menu 250Scripting

events 442, 445Scripting submenu (Add Events menu) 199scroll bars 30

Secondary Server 139Select all command 198

Worklist Editor 216Select Application Objects window 434Select Client Groups window

Client group assignments 148Filter by Members of Selected Groups 133parent group assignments 156

Select Client window

Directory Manager 432Interactive Session 393Server Profile 87

Select Client’s Universal Time Coordinate dialog 136Select Clients and Client Groups window

Client Profile

Filter by Selected Clients and Groups 132member assignments 154

Session Editor 241Work Object Editor 207

Select Clients for Registration Session window 177Select Clients to Verify window 177Select Current Server 249Select ESD Objects window 158Select Filter File dialog box

Client Profile 134Session Editor 229

Select Groups window 158Select Modem window 87Select Object Owner Types window 190Select Objects window

Client Profile 149, 158Session Editor 239Work Object Editor 189, 201, 211

Select Sessions window

Client Profile 149, 160Session Editor 228Work Object Editor 205

Select System 61Select User Groups window 433Select Users and User Groups window 209Select Users window 438Select Worklist Objects window 158Selected Session command 247, 248SEND file(s) to Client event 443, 543

I n d e x - S 657

Serial Number 119Serialize Between Clustered Servers 57, 58, 575Server

events 442, 445Network Status 269property page 124, 142Serial Number 70

Server Address

SPX Detail 93TCP/IP Detail 95

Server Address dialog box 141Server Commands menu 390Server Control and Options

command 45window 54

Command Options page 56Log Files page 59Registry Settings page 61System Control page 55

Server Log report 331, 339, 360command line 361filters 338

Server Logs

command 38group 41

Server Message Logs 293Server Name dialog box 141Server Name item (Network Status) 268, 270Server Operations

command 38group 41

Server Phone Number dialog box 140Server Profile 40

Alarms page 67, 113application rights 52Cluster page 66, 75Dial Scripts page 67, 97icon 31Information page 66, 70Licensing page 67, 118Limit Outbound page 67, 96Logging page 67, 115Long Distance page 66, 77menu commands and toolbar buttons 68

Modem Types page 67, 102Network Groups page 66, 80overview 31Portable Security page 67, 120property pages in 66Protocol page 67, 109reasons for user access 49Resources page 67, 81Settings page 66, 72

Server Reboot error type 377Server Setup

command 38group 40

Server submenu (Add Events menu) 199Service Name 55Service Status 55services

RemoteWare database 637Session

Protocol Property page 110session

defined 222events 196execution order 462Master Worklist 462maximizing efficiency 462priority 236, 255tasks completed during 222types of 226, 253

Session Control

events 442, 444submenu (Add Events menu) 199

Session ECF 574, 604Session Editor 41

application rights 52Clients page 223, 240Filter menu 227icon 32menu commands and toolbar buttons 224Objects page 223, 238Options page 223, 242overview 32property pages in 223reasons for user access 49


Schedule page 223, 230Sessions page 223, 225

Session Event Log report 331, 339, 361command line 362filters 338

Session History Logs 293Session Log report 331, 339, 364


Session objects only 259Session property page 278Session Recovery

application rights 52icon 33overview 33reasons for user access 49

Session Recovery report 331, 339, 365command line 366filters 338

Session started for the current window 262Session Timeout 112Session Timeout dialog box 387Session type (General page) 255Sessions

event flags 307sessions

active 253blocked 253encrypted 393pending 253suspended 253

Sessions property page

Client Profile 125, 159Session Editor 223, 225Work Object Editor 180, 204

Sessions report 331, 339, 366command line 367filter 338

SET Client TIME event 443, 547Set Colors dialog box 384SET file ATTRIButes event 443, 548Set Page Size For Printing dialog box 337Set Refresh Time command 249SET REGISTRY VALUE event 444, 550

SET VARiable event 444, 552SET VARiable in SCRIPT event 445, 554Settings property page

Edit Modem dialog box 104, 108Server Profile 66, 72

shortcut menus 24Skip command 248Small Icon View command 39SMTP 418SNADS 418Software Manager 35, 41

application rights 52icon 35reasons for user access 49

spin boxes 29split bar control 30Split command 266SPX


SPX Detail dialog box 92SPX item (Network Status) 268SQL Server 637SSL encryption 393Start Session 236Start time 255State

Cluster page 76Network Status 269

Status

Async Resource Detail dialog box 86Cluster page 75General page 255Long Distance page 77Network Status 269, 273Objects page 257Resources Property page 82

status bar 25Status Bar command 25, 39Stop trying outbound calls after n hours 236Subscriber ECFs 574Subscriber Editor 34, 41

application rights 52reasons for user access 49

I n d e x - S 659

Suspend on All Servers command 251Suspend on Current Server command 250Suspend on Restart on All Servers command 64, 251Suspend on Restart on Current Server command 64,


250Suspend Scheduler command 266Suspend Session command 248suspended sessions 253SYSTEM 187System 61System Control property page 55System Data Path 70System ECF 574, 613System report 331, 339, 369

command line 369

T

tabs 29TCP/IP


TCP/IP Detail dialog box 94TCP/IP item (Network Status) 268TCP/IP Type (Client page) 138TELEX 418Template Makekit 161TEST if Client is in GROUP event 445, 556TEST VARiable event 445, 558text boxes 29Time Up

Cluster page 76Network Status 269

Timeout error type 377Timezone 136toolbar 25Toolbar command 25, 39Total Time 277Transaction Pipe Logs 293tree control 30Turn compression off, event attribute 455Type

Client Profile 135Cluster page 76Network Status 269Objects page 257System Control page 55

U

UNASSIGN from client event 445, 560Undefined error type 377Undo command 197, 215Unscheduled error type 377Unselect all command 198

Worklist Editor 216Update Code 119Update command 25, 68, 126Update Licensing dialog box 119Usage 86, 273

NetBIOS Detail 89, 93, 95Resources Property page 82

Use a Custom ECF Data File Directory 57, 576Use a Custom Update Time 57, 576Use alternate resource on retry 255Use as template user 168Use Client system defined modem (TAPI) 138USER 187user 424

local 425Profile window 429remote 425types 426

User Abort error type 377User Access menu 45USER defined ALARM event 445, 562User Directory database 424User ECF 575, 627user group 424

Profile window 436User Group ECF 575, 629User Group Listing report 331, 339, 371

command line 372User Listing report 332, 372

command line 373Users property page 180, 208Using Help command 39

V

Value

Registry Settings page 61variables

<ClientBin> 447<ClientESD> 448

I n d e x - W 661

<ClientHome> 448<ClientInstall> 448, 453<ClientName> 448<d> 448<Date> 448<dw> 448<dy> 448<hh> 448<m> 448<mm> 449<SendFilesAttempted> 448, 449<SendFilesFailed> 448, 449<SendFilesSuccessful> 448, 449<Serial#> 449<Server> 449<ServerData> 449, 453<ServerExecution> 449<Session_Origin> 449<ss> 449<Time> 449<WindowsDir> 450<WindowsESD> 450<WindowsSysDir> 450<WindowsSysESD> 450<y> 450<y1> 450<y4> 450in events 447

Version Number 71View Alarm command 266View License Log command 69View menu 25

Interactive Session 384Network Status 266RemoteWare Menu 38Schedule Manager 249Worklist Editor 216

View Other Server Resources command 69View Properties dialog box

fields 294opening 294

W

WAIT for file to exist event 443, 564

wildcards

Client Profile 147, 148in events 451

Window Size 111Protocol Property page 110

windows

Assign Application Objects 201Client Registration Options window 175Depends on Session 234Details for ResourceName 276, 278, 279Details for Session 254Dial Script Editor 98Event Details 446License Log 119Personal Address Book 421Personal Folders 419Profile


RemoteWare Gateway detail 417Select Application Objects 434Select Client

Directory Manager 432Interactive Session 393Server Profile 87

Select Client Groups

Client group assignments 148Filter by Members of Selected Groups 133parent group assignments 156

Select Clients and Client Groups


Select Clients for Registration Session 177Select Clients to Verify 177Select ESD Objects 158Select Group Objects 158Select Modem 87Select Object Owner Types 190Select Objects

Client Profile 149, 158Session Editor 239Work Object Editor 189, 201, 211

Select Sessions



Select User Groups 433Select Users 438Select Users and User Groups 209Select Worklist Objects 158Server Control and Options 54

windows in RemoteWare 22Work Object Critical event (+), event attribute 455Work Object ECF 574, 609Work Object Editor 41, 184

Add Events menu 198Application Attributes page 180, 195application rights 53Clients page 180, 206Edit menu 197Events page 180, 196File menu 197Filter menu 188General Attributes page 180, 192icon 32Members page 180, 200menu commands and toolbar buttons 184Objects page 180, 186overview 32overview of property pages 180Parents page 181, 210reasons for user access 49Sessions page 180, 204Users page 180, 208

work objects

owner types 187reasons for not executing 182types of 181, 187

Work Objects report 332, 339, 373command line 374filters 338

Working dir/path 195Worklist

search and replace 219worklist

objects 181, 187optimizing 464

Worklist ECF 574, 617Worklist Editor 41

flags 218icon 32main window 217menu commands and toolbar buttons 215overview 32reasons for user access 49

Workshop Editor 41icon 34overview 34reasons for user access 49

Write Filters command

Client Profile 131Schedule Manager 250Session Editor 227, 229Work Object Editor 189

WRITE INI FILE event 445, 566Wrk objects 187Wrong Client error type 377

X

X400 418X500 418Xpress Transfer, event attribute 454

remoteware server reference manual - help.sap.com · iv remoteware server reference guide chapter...

Documents