This chapter provides detailed descriptions of custom WLST commands for Oracle WebCenter: Imaging, including command syntax, arguments and command examples.
The following sections describe the WLST commands that are specific to Oracle WebCenter: Imaging. Topics include:
WLST commands specific to Imaging are divided into the following categories.
Use the Imaging WLST diagnostic commands, listed in table Table 17-2, to list and organize processing failures during workflow processes.
Table 17-2 Diagnostic Commands for Imaging
Use this command... | To... | Use with WLST... |
---|---|---|
Clear processing failures that occurred during workflow agent processing. |
Online |
|
Provide details of processing failures that occurred during workflow agent processing. |
Online |
|
Repair processing failures that occurred during workflow agent processing. |
Online |
|
Count processing failures during workflow agent processing, grouped by choice of date, application ID, or batch ID. |
Online |
|
Reset DMS metrics to zero. |
Online |
Command Category: Diagnostic Commands
Use with WLST: Online
clearIPMWorkflowFaults([startDate], [endDate], [appId], [batchId])
Argument | Definition |
---|---|
startDate
|
Optional. The start of the date range for which error details should be repaired, in yyyy-MM-dd format. |
endDate
|
Optional. The end of the date range for which error details should be repaired, in yyyy-MM-dd format. |
appId
|
Optional. The application ID for which error details should be repaired, in yyyy-MM-dd format. |
batchId
|
Optional. The batch ID for which error details should be repaired. |
The following example clears the faults within the specified parameters.
clearIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02") clearIPMWorkflowFaults(appId=3) clearIPMWorkflowFaults(batchId=15) clearIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02", appid=3)
Command Category: Diagnostic Commands
Use with WLST: Online
List details on processing failures that have occurred during workflow agent processing.
listIPMWorkflowFaults([startDate], [endDate], [appId], [batchId])
Argument | Definition |
---|---|
startDate
|
Optional. The start of the date range for which error details should be repaired, in yyyy-MM-dd format. |
endDate
|
Optional. The end of the date range for which error details should be repaired, in yyyy-MM-dd format. |
appId
|
Optional. The application ID for which error details should be repaired. |
batchId
|
Optional. The batch ID for which error details should be repaired. |
Command Category: Diagnostic Commands
Use with WLST: Online
Repair processing failures that have occurred during workflow agent processing.
repairIPMWorkflowFaults([startDate], [endDate], [appId], [batchId])
Argument | Definition |
---|---|
startDate
|
Optional. The start of the date range for which error details should be repaired, in yyyy-MM-dd format. |
endDate
|
Optional. The end of the date range for which error details should be repaired, in yyyy-MM-dd format. |
appId
|
Optional. The application ID for which error details should be repaired. |
batchId
|
Optional. The batch ID for which error details should be repaired. |
The following example repairs the faults within the specified parameters.
repairIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02") repairIPMWorkflowFaults(appId=3) repairIPMWorkflowFaults(batchId=15) repairIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02", appid=3)
Command Category: Diagnostic Commands
Use with WLST: Online
Provides a count of processing failures that have occurred during workflow agent processing. The results are grouped by date, application ID, or batch ID.
Command Category: Diagnostic Commands
Use with WLST: Online
Use the Imaging configuration commands, listed in Table 17-3, to list and set configuration values specific to Imaging.
Table 17-3 Configuration Commands for Imaging
Use this command... | To... | Use with WLST... |
---|---|---|
Creates a new Imaging connection from a connection definition file. |
Online |
|
Get an Imaging configuration setting value, similar to navigating to the custom Imaging config mbean and using the standard WLST set command. |
Online |
|
Grants CredentialAccessPermissions to Imaging when Imaging Managed Servers are in a separate domain home from the Administration Server. |
Online |
|
Imports an application definition from a previously exported definition file. |
Online |
|
Imports an input definition from a previously exported definition file. |
Online |
|
Imports a search definition from a previously exported definition file. |
Online |
|
Lists Imaging configuration mbeans. |
Online |
|
Lists the contents of an exported Imaging definitions file. |
Online |
|
Refresh security items currently stored in the Imaging database. |
Online |
|
Sets an Imaging configuration value. |
Online |
|
Submits a document to the workflow agent. |
Online |
Command Category: Imaging Configuration Commands
Use with WLST: Online
Creates a new Imaging connection from a connection definition file. The connection definition file is an XML file that describes a single Imaging connection definition using the Connection element type from the Imaging ConnectionService web services API schema definition. This schema is available from a running Imaging server using at the following URL:
http://ipm_server_machine:ipm_server_port/imaging/ws/ConnectionService?xsd=1
For more information about the connection definition file format, see the Oracle Fusion Middleware Administering Oracle WebCenter Content: Imaging.
Command Category: Imaging Configuration Commands
Use with WLST: Online
Gets an Imaging configuration setting value. The command is equivalent to browsing the custom mbean hierarchy to the Imaging config mbean and using the standard WLST set command to set an mbean attribute.
Command Category: Imaging Configuration Commands
Use with WLST: Online
Grants CredentialAccessPermissions to Imaging so that it can read credentials from the credential store. This command is required in configurations where Imaging managed servers are in a separate domain home from the Administration Server. When at least one Imaging managed server is in the same domain home as the Administration Server, this command is not required, as CredentialAccessPermissions are granted during Imaging startup.
When the Imaging Managed Server is not in the same domain home as the Administration Server, however, the Imaging startup grant only affects the local settings. Local settings get overwritten when the Administration Server synchronizes its copy as the domain wide configuration, so this command updates the Administration Server configuration such that permissions are distributed correctly to all domain nodes.
Command Category: Imaging Configuration Commands
Use with WLST: Online
importIPMApplication(exportFile, action, name, repository, securityOption, securityMember, docSecurityOption, docSecurityGroup, storageOption, storageVolume)
Argument | Definition |
---|---|
exportFile
|
Required. A full path to the export definition file's location on the Imaging server node. Must be enclosed in single or double quotes. |
action
|
Required. The action to be performed. Available actions are:
|
name
|
Required. The name of the application being imported from the exported definitions file. |
repository
|
The name of the repository in which to create the application. Required when adding an application, ignored when updating or modifying an application. |
securityOption
|
Optional. Specifies how to define security for the imported application as follows:
|
securityMember
|
Name of the user or group given full permissions to the application. Valid only when securityOption is set to either User or Group, otherwise it is ignored. |
docSecurityOption
|
Optional. Specifies how to define document security for the imported application.
|
docSecurityGroup
|
Name of group given full permissions to document security. Valid only when docSecurityOption is set to Group, otherwise it is ignored. |
storageOption
|
Optional. Specifies how to define the storage policy for the imported application.
|
storageVolume
|
Required. Volume for setting storage policy. Valid only when a storageOption of Volume is used. Ignored otherwise. |
The following example updates an existing application named Invoices. Note that the repository is listed as None because the update action uses the repository specified in the original application.
importIPMApplication(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", repository=None, securityOption="Existing")
The following example creates a new application named Receipts. Note that the repository is explicitly named because the add action requires a valid repository be named.
importIPMApplication(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", repository="LocalCS", securityOption="ValidOnly")
Command Category: Imaging Configuration Commands
Use with WLST: Online
importIPMInput(exportFile, action, name, securityOption, securityMember) )
Argument | Definition |
---|---|
exportFile
|
Required. A full path to the export definition file's location on the Imaging server node. Must be enclosed in single or double quotes. |
action
|
Required. The action to be performed. Available actions are:
|
name
|
Required. The name of the input being imported from the exported definitions file. |
repository
|
The name of the repository in which to create the application. Required when adding an application, ignored when updating or modifying an application. |
securityOption
|
Optional. Specifies how to define security for the imported application as follows:
|
securityMember
|
Name of the user or group given full permissions to the input. Valid only when securityOption is set to either User or Group, otherwise it is ignored. |
The following example updates an existing input named Invoices. Note that the repository is listed as None because the update action uses the repository specified in the original application.
importIPMInput(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", securityOption="Existing")
The following example creates a new input named Receipts. Note that the repository is explicitly named because the add action requires a valid repository be named.
importIPMInput(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", securityOption="ValidOnly")
Command Category: Imaging Configuration Commands
Use with WLST: Online
importIPMSearch(exportFile, action, name, securityOption, securityMember)
Argument | Definition |
---|---|
exportFile
|
Required. A full path to the export definition file's location on the Imaging server node. Must be enclosed in single or double quotes. |
action
|
Required. The action to be performed. Available actions are:
|
name
|
Required. The name of the search being imported from the exported definitions file. |
repository
|
The name of the repository in which to create the application. Required when adding an application, ignored when updating or modifying an application. |
securityOption
|
Optional. Specifies how to define security for the imported application as follows:
|
securityMember
|
Name of the user or group given full permissions to the search. Valid only when securityOption is set to either User or Group, otherwise it is ignored. |
The following example updates an existing search named Invoices. Note that the repository is listed as None because the update action uses the repository specified in the original application.
importIPMSearch(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", securityOption="Existing")
The following example creates a new search named Receipts. Note that the repository is explicitly named because the add action requires a valid repository be named.
importIPMSearch(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", securityOption="ValidOnly")
Command Category: Imaging Configuration Commands
Use with WLST: Online
Command Category: Imaging Configuration Commands
Use with WLST: Online
Command Category: Imaging Configuration Commands
Use with WLST: Online
Command Category: Imaging Configuration Commands
Use with WLST: Online
Sets an Imaging configuration setting value. The command is equivalent to browsing the custom mbean hierarchy to the Imaging config mbean and using the standard WLST 'set' command to set an mbean attribute.
Command Category: Imaging Configuration Commands
Use with WLST: Online
Submits a document to the workflow agent. Note that a confirmation message is displayed stating that the document has been submitted, however if the document is stored in an application that is not configured with a workflow, no action is taken.