Because it provides many output options, the dump command is a versatile
tool. For example, you can determine what classes have been transferred
by using dump to create a CDL file from the workflow database.
The syntax varies depending on the data you choose to display.
The parameters required depend on the data you choose to output. Following
is an alphabetical listing of all valid parameters for the dump command.
CDL_or_XML
|
The output format. Enter "c" to output in CDL format,
and "x" to output in XML format.
NOTE Some
information originally contained in the object definition is not
output in the XML format (for example, submaps).
|
contentoption
|
The content to be dumped. Enter "c" for configuration
information for all rosters, queues, and event logs, or "a"
for all information (configuration and workflow definitions).
|
classname
|
Name of work class or work performer class. For output of instruction
sheet, name of the work class in which the instruction sheet is
defined.
NOTE If
the name has trailing spaces, you must enclose the name in quotes.
|
columnname
|
Name of field (column) in the database table where the BLOb resides.
|
filename
|
Name (and path) of CDL file. By default, the file is created in
the directory from which you are running vwtool.
|
forcedump
|
Force dump of object, even if the object is corrupted.
Enter "y" to force the dump or "n" to cancel
the operation if the object is corrupted.
|
form
|
The form of the work class, work performer class, workspace, or
instruction sheet to dump.
Enter "a" to dump the authored form or "r"
to dump the runtime form. The authored form matches the original
CDL file. The runtime form is the compiled and optimized version
of the same CDL file.
|
format
|
The format in which to output work class, work performer class,
workspace, or instruction sheet data.
Enter "r" for raw format, "s" for summary format,
"f" for fields, or "c" for CDL format.
- Raw: the internal structures used to store the data and the
values in these structures display in hexadecimal format. This
option is used by FileNet engineering staff to analyze any BLOb
corruption problems.If the BLOb of a work item is dumped in raw
format, the exposed fields in the queue are not included in the
work item dump output.
- Summary: the work class data fields, work performer class data fields, queue
fields, and instructions display in a tabular form, which
is more compact than CDL output. This option also lists the the
IDs assigned to the objects in the runtime form, which is not
done in the CDL output.
- CDL: the requested data displays in the Class Definition Language
(CDL) format used by Visual WorkFlo/Composer. CDL output cannot
be generated on the runtime form of a class or instruction sheet
(see description of "form" parameter above). Therefore,
if you choose the CDL format option, the authored form of the
class or instruction sheet is automatically read.
- Fields: the requested information displays only the system
and data fields associated with the selected class. This option
applies to work classes and work performer classes only.
|
hexformat
|
Display the work
object ID, work item, or BLOb data in hex format.
Enter "y" to display the data in hex format or "n"
to display the data in ASCII format.
|
instructionsheetname
|
Name of the instruction sheet.
|
objectid
|
Object ID of the data to dump. You must enter this value if you
are dumping an object ID and you specified "n" for the
searchbyname parameter. Use the listobjects
command to find the objectid.
This command option is only available if you are running vwtool
on the primary Process Engine.
|
objectname
|
Object name of data to dump. You must enter this value if you are
dumping an object ID and you specified "y" for the searchbyname
parameter. Use the listobjects command
to find the objectname.
In a multi-server system, this command option is only available
if you are running vwtool on the primary Process Engine.
|
queuename
|
Name of the queue the work item is in.
If you specify a system or user queue, you must also .
|
searchbyname
|
Indicates whether to search for a work object by work object ID
or work
object name.
Enter "y" to search by object name or "n" to
search by object ID. Based on your entry here, you must also enter
either an objectid (if searchbyname = n) or an objectname (if searchbyname
= y).
|
tablename
|
Name of the database table where the BLOb resides.
|
whereclause
|
SQL WHERE clause to use for query. For details on the syntax for
your query, see the documentation for the SQL database server to
which you're sending the query.
|
workclassname
|
The name of the workflow.
|
workobjectnumber
|
Work object number of the work item to dump.
|
workspaceid
|
Workspace ID of workspace from which to retrieve the class or instruction
sheet.
Press Enter select the current workspace or a enter valid workspace
ID to select another specific workspace.
|