Advanced Workflow Engine User Guide (v6.2)

Advanced Workflow Engine

User Guide Module for EFT Server v6.2

GlobalSCAPE, Inc. (GSB)

Address: 4500 Lockhill-Selma Road, Suite 150 San Antonio, TX (USA) 78249

Sales: (210) 308-8267

Sales (Toll Free): (800) 290-5054

Technical Support: (210) 366-3993

Web Support: http://www.globalscape.com/support/

2008-2010 GlobalSCAPE, Inc. All Rights Reserved

Advance Workflow Designer Powered by AutoMate, 1996 Network Automation, Inc.

May 5, 2010

http://www.globalscape.com/support/

iii

Table of Contents

The Advanced Workflow Engine .......................................................................................................... 33

The AWE Interface .................................................................................................................................. 34

Resetting the AWE Interface Display .................................................................................................... 40

Creating and Managing Workflows ..................................................................................................... 49

Using Advanced Workflows in Event Rules .......................................................................................... 51

Editing Workflows ................................................................................................................................ 52

Adding Steps ......................................................................................................................................... 54

Commenting Steps in a Workflow ........................................................................................................ 55

Copying Workflows............................................................................................................................... 56

Printing Workflow Steps ....................................................................................................................... 57

Searching Workflows ............................................................................................................................ 58

Testing Workflows ................................................................................................................................ 59

Workflow Test Options ......................................................................................................................... 60

Deleting Workflows .............................................................................................................................. 61

Creating Variables ................................................................................................................................ 61

Backing Up Workflows.......................................................................................................................... 66

Importing Workflows............................................................................................................................ 66

Importing Multiple Workflows ...................................................................................................... 67

Auditing Workflows .............................................................................................................................. 67

Debugging Workflows .......................................................................................................................... 67

Step Error Handling ........................................................................................................................ 68

Comments Debug View.................................................................................................................. 71

Labels Debug View ......................................................................................................................... 71

Output Debug View ....................................................................................................................... 71

About Breakpoints ......................................................................................................................... 72

Using Breakpoints .......................................................................................................................... 72

Breakpoints Debug View ................................................................................................................ 73

About Watches .............................................................................................................................. 73

Using Watches ............................................................................................................................... 74

Variables Debug View .................................................................................................................... 75

Watches Debug View ..................................................................................................................... 76

Advanced Workflow Engine User Guide

iv

About the Debug Window ............................................................................................................. 76

Debugger Options in the AWE Interface ........................................................................................ 76

Workflow Error Handling ............................................................................................................... 77

Sending E-Mails with Workflows ......................................................................................................... 78

Examples .................................................................................................................................................. 79

Downloading Files from a Remote Server ............................................................................................ 79

Archiving Files ....................................................................................................................................... 83

Technical Reference ............................................................................................................................... 89

AML (AWE Markup Language) ............................................................................................................. 89

Using Regular Expressions .................................................................................................................... 91

Percent Signs in AWE ............................................................................................................................ 95

AWE Actions ......................................................................................................................................... 98

Available Actions ............................................................................................................................ 98

Finding Actions ............................................................................................................................. 104

How to Use the Actions ............................................................................................................... 105

Customizing the Available Actions pane ...................................................................................... 105

Setting Action Properties ............................................................................................................. 107

Setting Custom Step Description Options.................................................................................... 108

Data Link Properties ..................................................................................................................... 110

Running Command-Line Applications .......................................................................................... 116

Optimizing Task Execution Speed ................................................................................................ 117

Expression Builder ........................................................................................................................ 118

Using Expression Builder ....................................................................................................... 118

Defining Expressions ............................................................................................................. 119

About Expressions ................................................................................................................. 120

About Constants .................................................................................................................... 121

About Variables ..................................................................................................................... 122

Variables vs. Constants .......................................................................................................... 123

Creating Variables and Constants ................................................................................... 123

How Variables and Constants are Used .......................................................................... 124

EFT Server Variables ..................................................................................................................... 125

Connection Variables............................................................................................................. 125

Event Variables ...................................................................................................................... 126

Table of Contents

v

File System Variables ............................................................................................................. 126

Server Variables ................................................................................................................... 127

Site Variables ........................................................................................................................ 127

User Variables ...................................................................................................................... 127

AS2 Variables ........................................................................................................................ 129

Active Directory Actions............................................................................................................... 130

Active Directory Object to Dataset Action ............................................................................ 130

AD Object to Dataset ActionSetting Properties ................................................................. 131

Create Active Directory Group Action ................................................................................... 132

Create AD Group Action - Setting Properties ........................................................................ 135

Create Active Directory Object Action .................................................................................. 136

Create AD Object ActionSetting Properties ....................................................................... 137

Create Active Directory User Action ...................................................................................... 138

Create AD User Action - Setting Properties ........................................................................... 140

Delete Active Directory Object Action .................................................................................. 141

Delete AD Object Action - Setting Properties........................................................................ 142

Get AD Group Members Action ............................................................................................ 143

Get Active Directory Object Path Action ............................................................................... 145

Get AD Object Path Action - Setting Properties .................................................................... 146

Get Active Directory Object Property Action ........................................................................ 147

Get AD Object Property Action - Setting Properties ............................................................. 149

If Active Directory Object Exists Action ................................................................................. 150

If AD Object Exists Action - Setting Properties ...................................................................... 151

List Active Directory Object Paths Action .............................................................................. 152

List AD Object Paths Action - Setting Properties ................................................................... 155

Modify Active Directory Group Action .................................................................................. 156

Modify AD Group Action - Setting Properties ....................................................................... 158

Move Active Directory Object Action .................................................................................... 159

Move AD Object Action - Setting Properties ......................................................................... 161

Modify Active Directory User Action ..................................................................................... 162

Modify AD User Action - Setting Properties .......................................................................... 163

Rename Active Directory Object Action ................................................................................ 164

Rename AD Object Action - Setting Properties ..................................................................... 165

Advanced Workflow Engine User Guide

vi

Set Active Directory Object Property Action ......................................................................... 166

Set AD Object Property ActionSetting Properties ............................................................. 168

Advanced Actions......................................................................................................................... 169

BASIC Script Action ................................................................................................................ 169

Basic Script Action - Setting Properties ................................................................................. 169

DDE Action ............................................................................................................................. 171

DDE Action Setting Properties ............................................................................................ 172

Execute DLL Function Action ................................................................................................. 174

Execute DLL Function Action-Setting Properties ................................................................... 176

AutoMate ..................................................................................................................................... 177

Backup AWE Action ............................................................................................................... 178

Backup AWE ActionSetting Properties .............................................................................. 179

Start Task Action .................................................................................................................... 179

Start Task Action - Setting Properties ................................................................................... 180

Stop Task Action .................................................................................................................... 181

Stop Task ActionSetting Properties ................................................................................... 182

Compression Actions ................................................................................................................... 183

Compress Files Action ........................................................................................................... 183

Compress Files Action - Setting Properties ........................................................................... 187

Decompress Files Action ....................................................................................................... 189

Decompress Files ActionSetting Properties ....................................................................... 191

Cryptography Actions .................................................................................................................. 193

Create Key Container Action ................................................................................................. 193

Create Key ContainerSetting Properties ............................................................................ 194

Decrypt Action ....................................................................................................................... 195

Decrypt ActionSetting Properties ...................................................................................... 203

Delete Key Container Action ................................................................................................. 205

Delete Key ContainerSetting Properties ............................................................................ 206

Encrypt Action ....................................................................................................................... 206

Encrypt ActionSetting Properties....................................................................................... 214

Generate Key Files Action ..................................................................................................... 215

Generate Key File Action - Setting Properties ....................................................................... 217

Sign Action ............................................................................................................................. 217

Table of Contents

vii

Verify Action .......................................................................................................................... 222

Database Actions ......................................................................................................................... 227

About Datasets ...................................................................................................................... 227

Close SQL Connection Action ................................................................................................ 229

Close SQL ConnectionSetting Properties ........................................................................... 230

Open SQL ConnectionSetting Properties ........................................................................... 232

SQL Query Action .................................................................................................................. 233

SQL Query ActionSetting Properties .................................................................................. 236

Stored Procedure Action ....................................................................................................... 237

Stored Procedure ActionSetting Properties ...................................................................... 240

Dialogs Actions ............................................................................................................................. 241

Choice Action ......................................................................................................................... 241

Choice ActionSetting Properties ........................................................................................ 244

Common Dialogs Action ........................................................................................................ 246

Common Dialogs ActionSetting Properties ....................................................................... 248

Input Box Action .................................................................................................................... 249

Input Box ActionSetting Properties ................................................................................... 252

Message Box Action .............................................................................................................. 254

Message Box ActionSetting Properties .............................................................................. 258

Environment Variables Actions .................................................................................................... 260

Append Environment Variable .............................................................................................. 260

Append Environment Variable ActionSetting Properties .................................................. 261

Delete Environment Variable ................................................................................................ 261

Delete Environment Variable Action - Setting Properties ..................................................... 262

Get Environment Variable ..................................................................................................... 262

Get Environment Variable ActionSetting Properties ......................................................... 263

List Environment Variables .................................................................................................... 263

List Environment Variables ActionSetting Properties ........................................................ 264

Set Environment Variable ...................................................................................................... 264

Set Environment Variable ActionSetting Properties .......................................................... 265

Excel Actions ................................................................................................................................ 266

Activate Cell Action ............................................................................................................... 266

Activate Cell ActionSetting Properties ............................................................................... 268

Advanced Workflow Engine User Guide

viii

Activate Worksheet Action .................................................................................................... 269

Activate Worksheet ActionSetting Properties ................................................................... 270

Add Worksheet Action .......................................................................................................... 270

Add Worksheet ActionSetting Properties .......................................................................... 272

Cells to Dataset Action .......................................................................................................... 272

Cells to Dataset ActionSetting Properties .......................................................................... 275

Close Workbook Action ......................................................................................................... 276

Close Workbook ActionSetting Properties ........................................................................ 276

Create Workbook Action ....................................................................................................... 277

Create Workbook ActionSetting Properties ...................................................................... 278

Dataset to Cells Action .......................................................................................................... 279

Dataset to Cells ActionSetting Properties .......................................................................... 280

Get Active Cell ....................................................................................................................... 281

Get Active Cell ActionSetting Properties ........................................................................... 283

Get Active Worksheet ........................................................................................................... 284

Get Active Worksheet ActionSetting Properties ............................................................... 285

Get Cell Action ....................................................................................................................... 285

Get Cell ActionSetting Properties ...................................................................................... 287

Open Workbook Action ......................................................................................................... 287

Open Workbook ActionSetting Properties ........................................................................ 288

Set Cell Action........................................................................................................................ 289

Set Cell ActionSetting Properties ....................................................................................... 290

File Actions ................................................................................................................................... 291

Calculate File Checksum Action ............................................................................................. 291

Calculate File Checksum ActionSetting Properties ............................................................ 292

Change Folder Action ............................................................................................................ 292

Change Folder ActionSetting Properties ............................................................................ 293

Concatenate Files Action ....................................................................................................... 294

Concatenate Files ActionSetting Properties ...................................................................... 295

Copy File Action ..................................................................................................................... 296

Copy File ActionSetting Properties .................................................................................... 300

Create Folder Action .............................................................................................................. 302

Create Folder ActionSetting Properties ............................................................................. 303

Table of Contents

ix

Delete File Action .................................................................................................................. 304

Delete File ActionSetting Properties .................................................................................. 306

Get File Information Action ................................................................................................... 308

Join File Action ....................................................................................................................... 311

Join File ActionSetting Properties ...................................................................................... 311

Move File Action .................................................................................................................... 313

Move File ActionSetting Properties ................................................................................... 317

Read From File Action ........................................................................................................... 318

Read From File ActionSetting Properties ........................................................................... 319

Remove Folder Action ........................................................................................................... 321

Remove Folder ActionSetting Properties .......................................................................... 322

Rename File Action ................................................................................................................ 323

Rename File ActionSetting Properties ............................................................................... 327

Rename Folder Action ........................................................................................................... 328

Rename Folder ActionSetting Properties .......................................................................... 329

Set Attributes Action ............................................................................................................. 330

Set Attributes ActionSetting Properties ............................................................................ 333

Split File Action ...................................................................................................................... 335

Split File Action - Setting Properties ...................................................................................... 336

Synchronize Folders Action ................................................................................................... 337

Synchronize Folders ActionSetting Properties .................................................................. 338

Touch File Action ................................................................................................................... 339

Write To File Action ............................................................................................................... 342

Write to File ActionSetting Properties ............................................................................... 343

Flow Actions ................................................................................................................................. 344

Else Action ............................................................................................................................. 344

Else ActionProperties ......................................................................................................... 344

Goto Action ........................................................................................................................... 345

Goto ActionSetting Properties ........................................................................................... 345

If Action ................................................................................................................................. 346

End If Action .......................................................................................................................... 347

End If ActionProperties ...................................................................................................... 347

If ActionSetting Properties ................................................................................................. 347

Advanced Workflow Engine User Guide

x

If Compare Files Action.......................................................................................................... 348

If File Exists Action ................................................................................................................. 349

If File Exists ActionSetting Properties ................................................................................ 352

If Folder Exists Action ............................................................................................................ 353

If Folder Exists ActionSetting Properties ........................................................................... 355

If Last Step Action .................................................................................................................. 355

If Last Step ActionSetting Properties ................................................................................. 356

If Pixel Exists Action ............................................................................................................... 357

If Pixel Exists ActionSetting Properties .............................................................................. 358

If Process Running Action ...................................................................................................... 359

If Process RunningSetting Properties................................................................................. 360

If Text Contains Action .......................................................................................................... 361

If Text Contains ActionSetting Properties .......................................................................... 362

If Window Exists Action ......................................................................................................... 363

If Window Exists ActionSetting Properties ........................................................................ 365

Label Action ........................................................................................................................... 367

Label ActionSetting Properties .......................................................................................... 367

Select/Case Action ................................................................................................................. 368

Select ActionSetting Properties ......................................................................................... 370

Case ActionSetting Properties ........................................................................................... 371

End Case Action-Properties ................................................................................................... 372

End Select/Case Action .......................................................................................................... 373

End Select Action-Properties ................................................................................................. 373

Internet Actions ........................................................................................................................... 374

Exchange Action .................................................................................................................... 374

MicroSoft Exchange Automation .......................................................................................... 392

Execute Web Service Action .................................................................................................. 398

Automating Web Service Execution ...................................................................................... 399

FTP Actions ............................................................................................................................ 404

FTP Advanced Action ...................................................................................................... 404

FTP Advanced ActionSetting Properties ...................................................................... 407

FTP Change Folder Action ............................................................................................... 408

FTP Change Folder ActionSetting Properties .............................................................. 409

Table of Contents

xi

FTP Create Folder Action ................................................................................................ 409

FTP Create Folder ActionSetting Properties ................................................................ 410

FTP Delete Action ............................................................................................................ 410

FTP Delete ActionSetting Properties ........................................................................... 411

FTP Download Action ...................................................................................................... 412

FTP Download ActionSetting Properties ..................................................................... 415

FTP Log On Action ........................................................................................................... 416

FTP Log On ActionSetting Properties .......................................................................... 422

FTP Log Off Action ........................................................................................................... 423

FTP Log Off ActionSetting Properties .......................................................................... 423

FTP Rename Action ......................................................................................................... 424

FTP Rename ActionSetting Properties ........................................................................ 425

FTP Remove Folder Action .............................................................................................. 426

FTP Remove Folder ActionSetting Properties ............................................................. 426

FTP Upload Action ........................................................................................................... 427

FTP Upload ActionSetting Properties .......................................................................... 430

Get E-mail Action ................................................................................................................... 432

Get E-mail ActionSetting Properties .................................................................................. 438

HTTP Download Action .......................................................................................................... 439

HTTP Download ActionSetting Properties ......................................................................... 444

HTTP Post/Put Action ............................................................................................................ 445

HTTP Post/Put ActionSetting Properties ........................................................................... 449

Open Web Page Action ......................................................................................................... 450

Open Web Page ActionSetting Properties ......................................................................... 451

Ping Machine Action .............................................................................................................. 452

Ping Machine ActionSetting Properties ............................................................................. 453

Send E-mail Action................................................................................................................. 453

Send E-mail Action-Setting Properties .................................................................................. 460

Send IM Action ...................................................................................................................... 461

Twitter Action ........................................................................................................................ 462

Loop Actions................................................................................................................................. 469

Break Action .......................................................................................................................... 469

Break ActionProperties ...................................................................................................... 469

Advanced Workflow Engine User Guide

xii

End Loop Action..................................................................................................................... 469

End Loop ActionProperties ................................................................................................ 470

Loop Action ............................................................................................................................ 470

Loop ActionSetting Properties ........................................................................................... 471

About Arrays .......................................................................................................................... 472

Loop Array Action .................................................................................................................. 474

Loop Array ActionSetting Properties ................................................................................. 475

About Datasets ...................................................................................................................... 475

Loop Dataset Action .............................................................................................................. 478

Loop Dataset ActionSetting Properties ............................................................................. 480

Loop Expression Action ......................................................................................................... 480

Loop Expression ActionSetting Properties ......................................................................... 481

Loop Files Action ................................................................................................................... 482

Loop Files ActionSetting Properties ................................................................................... 485

Loop File Contents Action ..................................................................................................... 486

Loop File Contents ActionSetting Properties ..................................................................... 487

Loop List Action ..................................................................................................................... 488

Loop List ActionSetting Properties .................................................................................... 490

Loop List Control Action ........................................................................................................ 490

Loop List Control ActionSetting Properties........................................................................ 494

Loop Processes Action ........................................................................................................... 495

Loop Processes ActionSetting Properties .......................................................................... 497

Loop Tree Control Action ...................................................................................................... 498

Loop Tree Control ActionSetting Properties ...................................................................... 502

Loop Windows Action ........................................................................................................... 503

Loop Windows ActionSetting Properties ........................................................................... 505

Network Actions .......................................................................................................................... 506

Connect to Network Action ................................................................................................... 506

Connect to Network ActionSetting Properties .................................................................. 508

Map Drive Action ................................................................................................................... 509

Map Drive ActionSetting Properties .................................................................................. 510

MSMQ Overview and Installation ......................................................................................... 511

MSMQ Action ........................................................................................................................ 512

Table of Contents

xiii

MSMQ Action-Setting Properties .......................................................................................... 521

Send Message Action ............................................................................................................ 523

Send Network Message Action ............................................................................................. 523

Send Network Message ActionSetting Properties ............................................................. 523

SNMP Actions ........................................................................................................................ 524

SNMP Get Action - Setting Properties ................................................................................... 526

SNMP Get Bulk Action ........................................................................................................... 526

SNMP Get Bulk Action-Setting Properties ............................................................................. 529

SNMP Get Next Action .......................................................................................................... 530

SNMP Get Next ActionSetting Properties .......................................................................... 531

SNMP Send Trap Action......................................................................................................... 532

SNMP Send Trap ActionSetting Properties ........................................................................ 535

SNMP Set Action .................................................................................................................... 536

SNMP Set Action - Setting Properties ................................................................................... 538

SNMP Walk Action ................................................................................................................. 538

SNMP Walk ActionSetting Properties ................................................................................ 540

Security Actions ........................................................................................................................... 541

Authenticate Action .............................................................................................................. 541

Authenticate ActionSetting Properties .............................................................................. 542

Generate Password Action .................................................................................................... 542

Generate Password Action-Setting Properties ...................................................................... 543

Services Actions ........................................................................................................................... 543

Get Service State Action ........................................................................................................ 543

Get Service State ActionSetting Properties ....................................................................... 544

Install Service Action ............................................................................................................. 544

Install Service ActionSetting Properties ............................................................................. 546

List Services Action ................................................................................................................ 547

List Services ActionSetting Properties ............................................................................... 548

Pause Service Action ............................................................................................................. 548

Pause Service ActionSetting Properties ............................................................................. 549

Remove Service Action .......................................................................................................... 549

Remove Service ActionSetting Properties ......................................................................... 549

Resume Service Action .......................................................................................................... 550

Advanced Workflow Engine User Guide

xiv

Resume Service ActionSetting Properties ......................................................................... 550

Start Service Action ............................................................................................................... 551

Start Service ActionSetting Properties............................................................................... 551

Stop Service Action ................................................................................................................ 552

Stop Service ActionSetting Properties ............................................................................... 552

Session Actions ............................................................................................................................ 553

Lock Workstation Action ....................................................................................................... 553

Lock Workstation ActionSetting Properties ....................................................................... 553

Log Off Action ........................................................................................................................ 553

Log Off ActionSetting Properties ....................................................................................... 554

Restart Action ........................................................................................................................ 554

Restart ActionSetting Properties ....................................................................................... 556

Shut Down Action .................................................................................................................. 556

Shut Down ActionSetting Properties ................................................................................. 557

Suspend/Hibernate Action .................................................................................................... 558

Suspend/Hibernate ActionSetting Properties ................................................................... 560

System Actions ............................................................................................................................. 560

Change Printer Action ........................................................................................................... 560

Change Printer ActionSetting Properties ........................................................................... 561

Empty Recycle Bin Action ...................................................................................................... 561

End Process Action ................................................................................................................ 562

End Process ActionSetting Properties ............................................................................... 563

Get Process Information Action ............................................................................................ 563

Get Volume Information Action ............................................................................................ 570

Get Volume Information ActionSetting Properties ........................................................... 571

Log Event Action .................................................................................................................... 572

Log Event Action - Setting Properties .................................................................................... 573

Print Action ............................................................................................................................ 574

Print ActionSetting Properties ........................................................................................... 574

Registry Action....................................................................................................................... 574

Registry Action - Setting Properties ...................................................................................... 576

Run Action ............................................................................................................................. 578

Run Action - Setting Properties ............................................................................................. 582

Table of Contents

xv

Set Date and Time Action ...................................................................................................... 584

Set Date and Time Action - Setting Properties ...................................................................... 586

Terminal Actions .......................................................................................................................... 587

Connect Terminal .................................................................................................................. 587

Connect Terminal ActionSetting Properties ...................................................................... 589

Control Terminal .................................................................................................................... 590

Control Terminal ActionSetting Properties........................................................................ 592

Disconnect Terminal .............................................................................................................. 592

Disconnect Terminal ActionSetting Properties .................................................................. 593

Get Terminal Text .................................................................................................................. 593

Get Terminal Text ActionSetting Properties ...................................................................... 595

Send Terminal Text ................................................................................................................ 595

Send Terminal Text ActionSetting Properties .................................................................... 596

Wait Terminal Action ............................................................................................................. 596

Wait Terminal ActionSetting Properties ............................................................................ 598

Text Actions.................................................................................................................................. 599

Convert Case Action .............................................................................................................. 599

Convert Case ActionSetting Properties.............................................................................. 600

Find Text Action ..................................................................................................................... 600

Find Text ActionSetting Properties .................................................................................... 602

Format Date Time Action ...................................................................................................... 603

Format Date Time ActionSetting Properties ...................................................................... 606

Get Subtext Action ................................................................................................................ 606

Get Subtext ActionSetting Properties ................................................................................ 607

Insert Text Action .................................................................................................................. 608

Insert Text ActionSetting Properties .................................................................................. 609

Pad Text Action ...................................................................................................................... 609

Pad Text ActionSetting Properties ..................................................................................... 611

Replace Text Action ............................................................................................................... 611

Replace Text ActionSetting Properties .............................................................................. 613

Trim Text Action .................................................................................................................... 614

Trim Text ActionSetting Properties.................................................................................... 615

Timer Actions ............................................................................................................................... 616

Advanced Workflow Engine User Guide

xvi

Read Timer Action ................................................................................................................. 616

Read Timer Action - Setting Properties ................................................................................. 617

Start Timer Action ................................................................................................................. 618

Start Timer Action - Setting Properties ................................................................................. 618

Stop Timer Action .................................................................................................................. 619

Stop Timer Action - Setting Properties .................................................................................. 620

Variables Actions .......................................................................................................................... 621

Create Array Action ............................................................................................................... 621

Create Array ActionSetting Properties .............................................................................. 624

Create Object Action ............................................................................................................. 625

Create Variable Action........................................................................................................... 626

Create Variable ActionSetting Properties .......................................................................... 628

Decrement Variable Action ................................................................................................... 628

Decrement Variable ActionSetting Properties .................................................................. 629

Define Type Action ................................................................................................................ 630

Increment Variable Action..................................................................................................... 631

Increment Variable ActionSetting Properties .................................................................... 631

ReDim Array Action ............................................................................................................... 632

ReDim Array Action - Setting Properties ............................................................................... 632

Set Variable Action ................................................................................................................ 633

Set Variable ActionSetting Properties ............................................................................... 634

Wait Actions ................................................................................................................................. 634

Pause Task Action .................................................................................................................. 634

Pause Task ActionSetting Properties ................................................................................. 636

Wait for Process Action ......................................................................................................... 636

Wait for Process ActionSetting Properties ........................................................................ 637

Wait for File Action ................................................................................................................ 638

Wait for File ActionSetting Properties ............................................................................... 641

XML Actions ................................................................................................................................. 642

Create XML Node Action ....................................................................................................... 642

Create XML Node ActionSetting Properties ...................................................................... 644

Dataset to XML Action ........................................................................................................... 644

Dataset to XML Action - Setting Properties ........................................................................... 645

Table of Contents

xvii

Delete XML Node or Attribute Action ................................................................................... 645

Delete XML Node ActionSetting Properties ...................................................................... 646

Edit XML Node Action............................................................................................................ 646

Edit XML Node Action - Setting Properties ........................................................................... 647

End XML Session Action ........................................................................................................ 647

End XML Session ActionSetting Properties ........................................................................ 648

Evaluate Xpath Expression Action ......................................................................................... 649

Evaluate Xpath Expression ActionSetting Properties ........................................................ 649

Extract XML Fragment Action ................................................................................................ 650

Extract XML Fragment ActionSetting Properties ............................................................... 651

Merge XML Files Action ......................................................................................................... 651

Merge XML Files ActionSetting Properties ........................................................................ 652

Output XML Action ................................................................................................................ 653

Output XML ActionSetting Properties ............................................................................... 655

Read XML Node Action .......................................................................................................... 656

Read XML Node ActionSetting Properties ......................................................................... 657

Sign XML File Action .............................................................................................................. 657

Sign XML Document ActionSetting Properties .................................................................. 659

Start XML Session Action ....................................................................................................... 660

Overwrite if File Exists ........................................................................................................... 660

Start XML Session ActionSetting Properties ...................................................................... 662

Transform XML Action ........................................................................................................... 663

Transform XML ActionSetting Properties .......................................................................... 664

Validate XML File Action ........................................................................................................ 665

Validate XML File ActionSetting Properties ....................................................................... 666

Verify XML Document Action ................................................................................................ 667

Verify XML Document ActionSetting Properties ............................................................... 668

XML Node to Dataset Action ................................................................................................. 669

XML Node to Dataset Action - Setting Properties ................................................................. 670

BASIC Scripting ................................................................................................................................... 671

BASIC Scripts and Custom Functions ........................................................................................... 672

BASIC Script IDE............................................................................................................................ 673

Like Operator ............................................................................................................................... 679

Advanced Workflow Engine User Guide

xviii

Operators ..................................................................................................................................... 680

References Dialog ........................................................................................................................ 681

Reference Comment .................................................................................................................... 682

References Overview ................................................................................................................... 683

The BASIC Language, All Groups .................................................................................................. 683

Uses Comment ............................................................................................................................. 685

Object Browser ............................................................................................................................ 686

UserDialog Editor ......................................................................................................................... 686

Constants ..................................................................................................................................... 687

Empty Keyword ..................................................................................................................... 687

False Keyword ....................................................................................................................... 687

Nothing Keyword ................................................................................................................... 687

Null Keyword ......................................................................................................................... 688

True Keyword ........................................................................................................................ 688

Datatypes ..................................................................................................................................... 688

Any Data Type ....................................................................................................................... 688

Boolean Data Type ................................................................................................................ 688

Byte Data Type ...................................................................................................................... 688

Currency Data Type ............................................................................................................... 689

Date Data Type ...................................................................................................................... 689

Decimal Data Type ................................................................................................................. 689

Double Data Type .................................................................................................................. 689

Integer Data Type .................................................................................................................. 689

Long Data Type ...................................................................................................................... 689

Object Data Type ................................................................................................................... 690

PortInt Data Type .................................................................................................................. 690

Single Data Type .................................................................................................................... 690

String Data Type .................................................................................................................... 690

String*n Data Type ................................................................................................................ 690

UserDialog Data Type ............................................................................................................ 691

Variant Data Type .................................................................................................................. 691

Definitions .................................................................................................................................... 691

arglist definition .................................................................................................................... 691

Table of Contents

xix

array variable definition ........................................................................................................ 691

As [New] type definition ........................................................................................................ 691

As type definition .................................................................................................................. 691

Attribute Definintion/Statement........................................................................................... 691

Attribute definition................................................................................................................ 693

Begin Dialog Definition .......................................................................................................... 693

big-endian definition ............................................................................................................. 694

CancelButton Dialog Item Definition ..................................................................................... 694

charlist definition................................................................................................................... 695

check box Dialog Item Definition .......................................................................................... 695

ComboBox Dialog Item Definition ......................................................................................... 696

condexpr definition ............................................................................................................... 697

Const Definition ..................................................................................................................... 697

dateexpr definition ................................................................................................................ 697

Declare Definition .................................................................................................................. 698

Def Definition ........................................................................................................................ 699

dialogfunc definition ............................................................................................................. 700

dim definition ........................................................................................................................ 700

Dim Definition ....................................................................................................................... 700

dlgvar definition .................................................................................................................... 701

DropListBox Dialog Item Definition ....................................................................................... 701

Enum Definition ..................................................................................................................... 702

expr definition ....................................................................................................................... 703

field definition ....................................................................................................................... 703

Function Definition ................................................................................................................ 703

GroupBox Dialog Item Definition .......................................................................................... 703

instruction definition ............................................................................................................. 704

label definition ...................................................................................................................... 704

ListBox Dialog Item Definition ............................................................................................... 704

little-endian definition ........................................................................................................... 705

method definition.................................................................................................................. 706

module definition .................................................................................................................. 706

name definition ..................................................................................................................... 706

Advanced Workflow Engine User Guide

xx

num definition ....................................................................................................................... 706

numvar definition .................................................................................................................. 706

objexpr definition .................................................................................................................. 706

objtype definition .................................................................................................................. 706

objvar definition .................................................................................................................... 706

OKButton Dialog Item Definition ........................................................................................... 707

Option Definition ................................................................................................................... 707

OptionButton Dialog Item Definition .................................................................................... 708

OptionGroup Dialog Item Definition ..................................................................................... 709

param definition .................................................................................................................... 710

Picture Dialog Item Definition ............................................................................................... 710

Order of Precedence ............................................................................................................. 711

Private Definition ................................................................................................................... 712

procedure definition ............................................................................................................. 712

Property Definition ................................................................................................................ 712

Public Definition .................................................................................................................... 713

PushButton Dialog Item Definition ........................................................................................ 714

statement definition .............................................................................................................. 714

Static Definition ..................................................................................................................... 714

str definition .......................................................................................................................... 715

strarray definition .................................................................................................................. 715

StreamNum Definition .......................................................................................................... 715

strvar definition ..................................................................................................................... 715

Sub Definition ........................................................................................................................ 715

Text Dialog Item Definition ................................................................................................... 716

TextBox Dialog Item Definition ............................................................................................. 717

Type Definition ...................................................................................................................... 718

Type Symbols ......................................................................................................................... 719

userenum definition .............................................................................................................. 719

usertype definition ................................................................................................................ 719

usertypevar definition ........................................................................................................... 719

var definition ......................................................................................................................... 719

variantvar definition .............................................................................................................. 719

Table of Contents

xxi

WithEvents Definition ........................................................................................................... 719

Extended Functions...................................................................................................................... 720

ArrayAvg ................................................................................................................................ 721

ArrayLen ................................................................................................................................ 721

ArrayMin ................................................................................................................................ 721

ArraySum ............................................................................................................................... 722

ArrayToList............................................................................................................................. 722

CreateGUID ............................................................................................................................ 722

CreateODBCDate ................................................................................................................... 723

CreateODBCDateTime ........................................................................................................... 723

CreateODBCTime ................................................................................................................... 724

DaysInMonth ......................................................................................................................... 724

DaysInYear ............................................................................................................................. 725

DriveAvailableSpace .............................................................................................................. 725

DriveExists ............................................................................................................................. 726

ExtractFileName .................................................................................................................... 726

ExtractFilePath....................................................................................................................... 726

FileCount ............................................................................................................................... 727

FileExists ................................................................................................................................ 727

FirstDateOfDayInMonth ........................................................................................................ 728

FirstDateOfDayInQuarter ...................................................................................................... 728

FirstDateOfDayInYear ............................................................................................................ 729

FolderCount ........................................................................................................................... 730

FolderExists............................................................................................................................ 730

GetAWEirectory ..................................................................................................................... 731

GetAWELogfile ....................................................................................................................... 731

GetAWEVersion ..................................................................................................................... 732

GetComputerName ............................................................................................................... 732

GetCurrentLineNumber ......................................................................................................... 732

GetCurrentTagText ................................................................................................................ 733

GetDesktopDirectory ............................................................................................................. 733

GetEnvironmentVariable ....................................................................................................... 733

GetErrorText .......................................................................................................................... 734

Advanced Workflow Engine User Guide

xxii

GetFileAttr ............................................................................................................................. 734

GetFocusedWindowHandle ................................................................................................... 735

GetFontDirectory ................................................................................................................... 735

GetIPAddress ......................................................................................................................... 736

GetLastError .......................................................................................................................... 736

GetLastErrorText ................................................................................................................... 736

GetLastStepExecutionTimeMin ............................................................................................. 737

GetLastStepExecutionTimeMS .............................................................................................. 737

GetLastStepExecutionTimeSec .............................................................................................. 738

GetParentTaskName ............................................................................................................. 738

GetProgramsDirectory........................................................................................................... 738

GetStartupDirectory ............................................................................................