Skip navigation FileNet logo
Glossary  |  Help Directory  
  Help for vwtool
  Search
Process Reference  
vwtool
Getting Started
Commands
  !<shell_cmd>
  =
  assertbehavior
  attachtran
  config
  convert
  count
  createDBviews
  dbconfig
  deletewob
  dispatchwob
  dump
  echo
  emptyqueue
  environment
  hardcopy
  help
  listdbconfig
  listobjects
  listobjects
  loadstatus
  lockwob
  logconfig
  logquery
  memory
  pagebreak
  queueconfig
  readcdl
  recover
  region
  regions
  resetloadstatus
  rosterconfig
  schemastatus
  statistics
  stepprocessors
  storedquery
  terminatewob
  trace
  unlockwob
  version
  views
  wobquery
  workstation
  writetrace

 

   

Command quick reference

Following are the names and brief descriptions of the commands available in vwtool.

Command Use to...

=

Display the last command entered in a command-line format.

!<shellcmd>

Execute a shell command without leaving vwtool.

assertbehavior

Display and define the behavior used on assertion errors.

attachtran

Attach to and display messages from an executing transfer process.

config

View configuration information for the isolated region.

convert

Convert a value from or to a time, error, or log event value.

count

Count the number of work items in a specific queue or roster.

createDBviews

Recreate database views for all local queues, rosters, and event logs.

dbconfig Configure an external database prior to executing a database stored procedure call.

deletewob

Delete a specific work item.

dispatchwob

Dispatch a specified work item to the next instruction.

dump

Display class definitions, instruction sheets, CDL files, workspaces, work items, object IDs, and binary large objects (BLObs) saved in the workflow database.

echo

Echo a text message to the screen and log it in the system log.

emptyqueue

Delete all work items from a specified queue.

environment

Display user or system environment field values.

hardcopy

Save your vwtool session output to a specified text file.

help

List all of the commands available in vwtool.

listdbconfig

Display the properties of a configured database connection..

listobjects

List the object ID, name and size of objects in the Object Service.

loadstatus

View statistics on the load being placed on the server where vwtool is running.

lockwob

Lock a work item.

logconfig

View the physical table name, field names/types, and indexes for a specific event log.

logquery

View event log records.

memory

View shared memory usage information for the server where vwtool is running.

pagebreak

Toggle on/off pausing between pages when displaying vwtool output.

queueconfig

View configuration information for a specific queue.

readcdl

Read, display, and do minimal validation to a CDL file.

recover

Initiate recovery for all work items locked by the specified machine and user in the isolated region.

region

Change the isolated region that vwtool accesses in the current session.

regions

List all isolated regions in the VWService that are loaded in memory, or all isolated regions defined in the VWService.

resetloadstatus

Reset the loadstatus counts to zero, and toggles the counting method used.

rosterconfig

View configuration information for a specific roster.

schemastatus

Determine whether any activity that modifies the workflow database (such as initialization or transfer) is in progress.

statistics

View queue and roster statistics for a specified time interval.

stepprocessors

Display step processor configurations.

storedquery

List a specific stored query or all stored queries, in CDL format.

terminatewob

Terminate a work item.

trace

Trace server activity including RPCs, DBI timings, DBI database access, Object Service usage, network connections, application functions, vwisi processes, and log manager processes.

unlockwob

Unlock a work item.

version

Display version information about the Process Engine software.

views

List a summary of system-maintained views for queues, rosters, and event logs.

wobquery

List the attributes of work items in a specified queue or roster. Also use to find a work item number or queue name for use in subsequent vwtool commands.

workstation

Display information for a selected PC workstation or server process, or for all PC workstations and server processes in the isolated region.

writetrace

Write trace data accumulated in memory by the trace command to a specified text file.