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

 

   

wobquery

This command outputs the attributes of work items in a specified queue or roster. Via the selective query option, you can use an index name to control the query and return the work items in ascending index order for the range of the index specified.

The wobquery command is useful for obtaining the work object number or queue name for use in subsequent vwtool commands. To easily use a work object number or queue name returned by wobquery in a subsequent command, use a terminal emulator program with cut and paste functionality.

You can optionally specify verbose output to output all of the fields of the selected record. If you don't select verbose output, wobquery prints out all data fields and a subset of the system fields for each record selected.

Syntax

The syntax varies depending on what you query.

To query Syntax

a roster, without selective query

wobquery <rostername> n <verbose>

a roster, with selective query

wobquery <rostername> {y <indexname> <minfieldval> <getvaluesequalmin> <maxfieldval> <getvaluesequalmin> <filter> <display> } <verbose>

a queue, without selective query

wobquery <queuename> n <verbose>

a queue, with selective query

wobquery <queuename> {y <indexname> <minfieldval> <maxfieldval> <filter> <display>} <verbose>

Parameters

The parameters required depend on what you choose to query. Following is an alphabetical listing of all valid parameters for the wobquery command.

display

Display work items, invocations, or queue or roster records. Enter "w" to display work items, "i" to display invocations, "r" to display roster records, or "q" to display queue records.

filter

This is a standard SQL WHERE clause using fields of the queue or roster. Either logical (user-defined) names or physical field names are allowed; pseudo field names are not allowed. (A pseudo field is a computed field held in memory, rather than an actual column in the database.)

For details on the syntax for your query, see the documentation for the SQL database server to which you're sending the query.

getvaluesequalmax

Whether output should include records with values equal to maxfieldval. Enter "y" to include these records or "n" to exclude them.

getvaluesequalmin

Whether output should include records with values equal to minfieldval. Enter "y" to include these records or "n" to exclude them.

indexname

Index key name.

In prompt mode, enter "?" to view a list of the available indices.

maxfieldval

The maximum value of the database field indicated by fieldname. The data type displays in datatype to help you determine the proper input. Depending on your answer, you may receive additional prompts for other minimum or maximum field values.

minfieldval

The minimum value of the database field indicated by fieldname. The data type displays in datatype to help you determine the proper input. Depending on your answer, you may receive additional prompts for other minimum or maximum field values.

n

No selective query specified.

queuename

Name of queue.

If you specify a system or user queue, you must also indicate the server to view.

rostername

Name of roster.

verbose

Output the selected records in verbose mode.

Enter "y" to display all fields or "n" to display all data fields and a subset of the system fields.

y

Selective query specified.

When using a selective query, you must specify an index key name to control the query. The work items display in ascending index order for the range of the index specified.

   

TIP In vwtool, you can enter parameters on the command line (following the command name) or let vwtool prompt you for the information by entering just the command name. Generally, we recommend prompt mode for all but the simplest commands. Entering the parameters on the command line is intended primarily for script-driven input.

NOTE If necessary, change to the desired isolated region prior to executing this command.