This chapter includes the following sections:
Table 11-1 provides a subset of Capture WLST commands, and includes those commonly used by Capture workspace managers. See Configuration Commands in WebCenter WLST Command Reference.
To run Capture WLST commands:
Table 11-1 Capture WLST Commands Typically Used by Workspace Managers
| Capture WLST Command | Description | Syntax | Example |
|---|---|---|---|
|
|
Lists all workspaces (preceded by their IDs) to which you have access. |
|
Command: Output:
|
|
|
Lists all batches for the workspace specified by its ID. |
|
Command:
Output:
|
|
|
Displays a list of all locked batches for the workspace specified by its ID. |
|
Command:
Output:
|
|
|
Exports an entire workspace's configuration, including scripts, profiles, and jobs, to a specified xml file at the specified location. |
|
Command:
Output: Workspace successfully exported |
|
|
Imports a workspace from an xml file generated with the |
|
Command:
Output: Workspace successfully imported |
|
|
Exports a specified batch, including images, documents, attachments, and metadata, to a specified XML file at a specified location. |
|
Command: Output:
|
|
|
Deletes the batch lock record for the specified batch, and changes the batch to a Ready state so users can open it in the client. Use the |
|
Command: Output: Batch successfully unlocked |
|
|
Deletes the specified batches. |
|
Command:
Output: Batches successfully deleted |
|
|
Exports the IMAP email message with specified message ID to the specified file. |
|
Command:
Output: Email message successfully exported |
|
|
Exports the EWS email message with specified message ID to the specified file. |
|
Command:
Output: Email message successfully exported |
|
|
Set the value of a property defined in a Capture object which could be a client profile, a processor job, or a commit profile. |
|
Command: Output: Property successfully updated. |
|
|
Print the specific value of a property of a Capture object which could be a client profile, a processor job, or a commit profile. |
|
Command: Output: Property successfully retrieved as: |
|
|
Set the user name and password associated with a Capture object (client profile, processor job, or commit profile). |
|
Command: Output: Credentials successfully updated. |
|
|
Update a script within a workspace. |
|
Command: Output: Script successfully updated. |
|
|
Copies an existing workspace and creates a new workspace. |
|
Command: Output: Workspace successfully copied. |
|
|
Reads an output file created by the |
|
Command: Output: Workspace successfully copied. |
|
|
Displays all the Import Processor tokens for a specific workspace. |
|
Command: Output:
|
|
|
Deletes a specific Import Processor HA Token from the |
|
Command: Output: Import Processor HA Token deleted successfully. |
The exportWorkspace command allows you to output an entire workspace's configuration, including its definition, profiles, jobs, and scripts, to an XML file. When used with the importWorkspace command, the exportWorkspace command can be useful for transferring workspace configurations between environments, such as for testing purposes.
Note:
Workspace security settings will not be exported into the resulting XML file.To export a workspace to an XML file:
listWorkspaces command to identify the ID of the workspace to export.exportWorkspace command, specifying the workspace ID to export and the file and location of the XML file to be written. See Table 11-1 for command details and an example.Note:
The security settings are not imported when you import a workspace.The importWorkspace command allows you to import an entire workspace, including its configuration (profiles, jobs, and scripts) and data (images, documents, and metadata) from an XML file created using the exportWorkspace WLST command. This can be useful for transferring workspace configurations between environments, such as for testing purposes.
To import a workspace from an XML file:
You may occasionally need to free a batch that is locked to another user, so that it can be worked on.
To release a batch:
listLockedBatches command to verify the ID of the batch to release.unlockBatch command, specifying the ID of the batch to unlock. See Table 11-1 for command details and an example.You may find it useful to export a batch, including its images, documents, attachments, and metadata, particularly for troubleshooting purposes.
To export a batch:
listBatches command to verify the ID of the batch to export.exportBatch command, specifying the ID of the batch to export. See Table 11-1 for command details and an example.The administrator may occasionally want to delete some batches that are no longer needed, especially certain batches (created by other users) which are erroneous or stuck in the processing stage endlessly. The deleteBatches command allows the administrator to perform bulk deletion of the specified batches.
listLockedBatches command or the listBatches command to verify the IDs of the batches to delete.deleteBatches command, specifying the IDs of the batches to delete. See Table 11-1 for command details and an example.The exportIMAPEmailMessage command allows you to export an IMAP email message with specified message ID to the specified file. Use with WLST: Online.
All parameters must be in string format except parameters for email connection security and port.
exportIMAPEmailMessage command by specifying the following:
0 for no security, 1 for SSL/TLS security type, and 2 for STARTTLS security type..eml extension.See Table 11-1 for command details and an example.
The exportEWSEmailMessage command allows you to export an EWS email message with specified message ID to the specified file. Use with WLST: Online.
This command is specific to Microsoft Email Exchange Service, if you have selected Exchange Service Type as Exchange On-premises. See Configuring Email Message and Email Attachment Importing.
exportEWSEmailMessage command by specifying the following:
.eml extension.See Table 11-1 for command details and an example.
The setObjectProperty command allows you to set the value of a property defined in a Capture Object. The Capture Object could be a client profile, a processor job, or a commit profile.
After connecting to the managed server or navigating to the domainRuntime, execute the setObjectProperty command by specifying the following:
Workspace name that contains the object to modify
Class name that defines the object
Object identifier which is a key/value pair consisting of the property name of the object to modify and the expected value
Name and value of the property to update separated by an equal sign
See Table 11-1 for command details and an example. See Capture Object Properties and setObjectProperty in WebCenter WLST Command Reference.
The getObjectProperty command allows you to display the value of a property defined in a Capture Object. The Capture Object could be a client profile, a processor job, or a commit profile.
After connecting to the managed server or navigating to the domainRuntime, execute the getObjectProperty command by specifying the following:
Workspace name that contains the object
Class name that defines the object
Object identifier which is a key/value pair consisting of the property name of the object to print and the expected value
Name of the property to access
See Table 11-1 for command details and an example. See getObjectProperty in WebCenter WLST Command Reference.
The setObjectCredentials command allows you to set the user name and password associated with a Capture object (client profile, processor job, or commit profile).
After connecting to the managed server or navigating to the domainRuntime, execute the setObjectCredentials command by specifying the following:
Workspace name that contains the credentials to modify
Class name that defines the object
Object identifier which is a key/value pair consisting of the property name of the object to modify and the expected value
User name to assign to the object's credential
Password to assign to the object's credential
See Table 11-1 for command details and an example.
The updateScript command allows you to update a script within a workspace.
After connecting to the managed server or navigating to the domainRuntime, execute the updateScript command by specifying the following:
Workspace name that contains the script to update
Name of the script to update
Absolute path to the new script file. The script will be updated with the contents of this file.
See Table 11-1 for command details and an example.
The cloneWorkspaceFromID command allows you to make a copy of an existing workspace.
After connecting to the managed server or navigating to the domainRuntime, execute the cloneWorkspaceFromID command by specifying the following:
Workspace ID of the workspace to copy
Workspace name for the new workspace that will be created
Description describing the new workspace
See Table 11-1 for command details and an example.
The cloneWorkspaceFromFile command allows you to read an output file created by the exportWorkspace command and creates a unique copy of the workspace.
After connecting to the managed server or navigating to the domainRuntime, execute the cloneWorkspaceFromFile command by specifying the following:
File name that contains the full path to the source XML file that will be used to create the new workspace
Workspace name for the new workspace that will be created
Description that describes the new workspace
See Table 11-1 for command details and an example.
The listImportHATokens command allows you to display all the Import Processor tokens for a specific workspace.
After connecting to the managed server or navigating to the domainRuntime, execute the listImportHATokens command by specifying the following:
Workspace ID
See Table 11-1 for command details and an example.
The deleteImportHAToken command allows you to delete a specific Import Processor HA token from the ECIMPORTHATOKEN and ECIMPORTHATOKENITEMS tables.
After connecting to the managed server or navigating to the domainRuntime, execute the deleteImportHAToken command by specifying the following:
Token ID that contains the unique identifier of the Import Processor HA Token to be deleted
See Table 11-1 for command details and an example.