This chapter provides detailed descriptions of custom WLST commands for Oracle WebCenter Capture, including command syntax, arguments and command examples.
The following sections describe the custom WLST commands for Oracle WebCenter Capture. These commands enable you to access and modify various configuration parameters for Oracle WebCenter Capture from the command line. Topics include:
For information about Capture workspace console use, see Oracle Fusion Middleware Managing Oracle WebCenter Capture.
Note:
To use the Oracle WebCenter Capture custom commands, you must invoke the WLST script from the Oracle Common home in which the component has been installed. Either connect to the Oracle WebLogic Server managed server (default port 16400) on which the Oracle WebCenter Capture application is deployed, or connect to the Oracle WebLogic Server administration server and change your location to domainRuntime by executing the command: domainRuntime()
See "Using Custom WLST Commands" in Oracle Fusion Middleware Administrator's Guide.
WLST Oracle WebCenter Capture commands are covered in the following category:
Use the commands in Table 20-2 to configure Oracle WebCenter Capture.
Table 20-2 WLST Server Oracle WebCenter Capture Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
List all of the workspaces to which the administrator or workspace manager has access. |
Online |
|
|
List all of the batches within a specified workspace. |
Online |
|
|
Export a batch including images and metadata to a specified file. |
Online |
|
|
Export an entire workspace including documents, metadata, scripts, profiles and jobs to an XML file. |
Online |
|
|
Import a workspace from a XML file generated with the exportWorkspace command. |
Online |
|
|
Delete the batch lock record for the specified batch. |
Online |
|
|
Display the list of locked batches. |
Online |
|
|
Display the list of all Capture configuration attributes with their values. |
Online |
|
|
Fetch the value of the attribute specified as an argument. |
Online |
|
|
Set the value of the Capture attribute to the provided value. |
Online |
|
|
Scan the client bundle directory for bundles. |
Online |
|
|
Delete an existing bundle. |
Online |
Use with WLST: Online.
Lists all batches for the workspace specified by its ID. Each batch listed has five columns (displayed in this order): Batch ID, Batch Name, Created By (user), Last Updated By (user), and Last Modified (date).
listBatches (WORKSPACE_ID)
| Argument | Definition |
|---|---|
|
|
ID number for a workspace. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a workspace with ID 3. |
Use with WLST: Online.
exportBatch(BATCH_ID,'FILE_NAME')
| Argument | Definition |
|---|---|
|
|
ID number for a batch. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a batch with ID 3. |
|
|
Name of the file to which the batch will be exported. The file name must be specified along with its complete path. |
Use with WLST: Online.
Exports an entire workspace including documents, metadata, scripts, profiles and jobs to an XML file.
exportWorkspace(WORKSPACE_ID,'FILE_NAME')
| Argument | Definition |
|---|---|
|
|
ID number for a workspace. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a workspace with ID 3. |
|
|
Name of the file to which the workspace will be exported. The file name must be specified along with its complete path. |
Use with WLST: Online.
Imports a workspace from a XML file generated with the exportWorkspace command. The workspace being imported must not exist in the Oracle WebCenter Capture database.
importWorkspace('FILE_NAME')
| Argument | Definition |
|---|---|
|
|
Name of the XML file from which a workspace is imported. The file name must be specified along with its complete path. |
Use with WLST: Online.
Deletes the batch lock record for the specified batch. The batch will be put into a READY state so that it can be opened by the client.
unlockBatch('BATCH_ID')
| Argument | Definition |
|---|---|
|
|
ID number for a batch. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a batch with ID 3. |
Use with WLST: Online.
Displays the list of locked batches. Each batch listed has six columns (displayed in this order): Workspace ID, Batch ID, Batch Name, Created By (user), Workstation (name/IP address), Last Modified (date).
listLockedBatches('WORKSPACE_ID')
| Argument | Definition |
|---|---|
|
|
ID number for a workspace. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a workspace with ID 3. |
Use with WLST: Online.
Displays the list of all Capture configuration attributes with their values. If a value cannot be fetched, it will be shown as "VALUE CANNOT BE DISPLAYED". The most likely cause of an unfetched value is insufficient privilege.
Use with WLST: Online.
Fetches the value of the attribute specified as an argument. The attribute name must be a string.
getCaptureConfig(['NAME_OF_ATTRIBUTE'])
| Argument | Definition |
|---|---|
|
|
Name of attribute (as a string) for Capture configuration. |
Use with WLST: Online.
setCaptureConfig(['NAME_OF_ATTRIBUTE'],['VALUE_OF_ATTRIBUTE'])
| Argument | Definition |
|---|---|
|
|
Name of Capture configuration attribute to configure. |
|
|
Value to set for the Capture configuration attribute. |
Use with WLST: Online.
Scans the client bundle directory for bundles. Data for existing bundles will be updated and information for new bundles will be loaded and cached in the database.