This command outputs definitions for objects stored in the database for the current isolated region:
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.
Syntax
The syntax varies depending on the data you choose to display.
Data to output | Syntax |
---|---|
dump c <workspaceid> <form> <classname> <format> |
|
dump i <workspaceid> <form> <classname> <instructionsheetname> <format> |
|
dump f <CDL_or_XML> <workspaceid> <filename> <contentoption> |
|
XML files |
dump f <CDL_or_XML> <workclassname> <workspaceid> <form> <include_inherited> <filename> |
dump s <workspaceid> <form> <format> |
|
dump w <queuename> <workobjectnumber> <hexformat> |
|
dump o <searchbyname> {<objectname> | <objectid>} <hexformat> <forcedump> |
|
dump b <tablename> <columnname> <whereclause> <hexformat> |
Parameters
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, "x" for XML, "c" for CDL format, or "z" for size.
|
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. |
include_inherited | Include inherited fields and maps. Enter "y" to include inherited fields and maps or "n" to ignore them. |
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. |
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. |
queuename |
Name of the queue the work item is in. If you specify a system or user queue, you must enter the queue name followed by "(0)". For example, to view information about the Delay system queue, enter Delay(0). |
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. Enter an asterisk (*) to dump all workclasses. |
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. |