4 Oracle WebCenter Content: Imaging Custom WLST Commands
The following sections describe the WLST commands that are specific to Oracle WebCenter Content: Imaging. Topics include:
4.1 Overview of Imaging WLST Command Categories
WLST commands specific to Imaging are divided into the following categories.
Table 4-1 Imaging WLST Command Categories
Command category | Description |
---|---|
Return workflow agent and other processing information. |
|
Configure settings specific to Imaging and Process Management. |
4.2 Diagnostic Commands
Use the Imaging WLST diagnostic commands, listed in table Table 4-2, to list and organize processing failures during workflow processes.
Table 4-2 Diagnostic Commands for Imaging
Use this command... | To... | Use with WLST... |
---|---|---|
Clear processing failures that occurred during workflow agent processing. |
Online |
|
Clear processing failures that have occurred during workflow agent processing for documents entered. |
Online |
|
Provide details of processing failures that occurred during workflow agent processing. |
Online |
|
Repair processing failures that occurred during workflow agent processing. |
Online |
|
Repair processing failures that have occurred during workflow agent processing for documents entered. |
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 |
4.2.1 clearIPMWorkflowFaults
Command Category: Diagnostic Commands
Use with WLST: Online
Description
Clear processing failures that have occurred during workflow agent processing.
Syntax
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. |
Example
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)
4.2.2 clearIPMWorkflowFaultsByDocId
Command Category: Diagnostic Commands
Use with WLST: Online
Description
Clear processing failures that have occurred during workflow agent processing for documents entered.
Syntax
clearIPMWorkflowFaultsByDocId(docIds=<list of docIds>)
Argument | Definition |
---|---|
docIds |
Required. The list of document ids for which the processing failures should be cleared. |
Example
The following example clears the faults within the specified parameters.
clearIPMWorkflowFaultsByDocId(docIds=<list of docIds>)
4.2.3 listIPMWorkflowFaults
Command Category: Diagnostic Commands
Use with WLST: Online
Description
List details on processing failures that have occurred during workflow agent processing.
Syntax
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. |
Example
The following example clears the faults within the specified parameters.
listIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02") listIPMWorkflowFaults(appId=3) listIPMWorkflowFaults(batchId=15) listIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02", appId=3)
4.2.4 repairIPMWorkflowFaults
Command Category: Diagnostic Commands
Use with WLST: Online
Description
Repair processing failures that have occurred during workflow agent processing.
Syntax
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. |
Example
The following example clears 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)
4.2.5 repairIPMWorkflowFaultsByDocId
Command Category: Diagnostic Commands
Use with WLST: Online
Description
Repair processing failures that have occurred during workflow agent processing for documents entered. This operation may take a long time depending on the number of documents being repaired.
Syntax
repairIPMWorkflowFaultsByDocId(docIds=<list of docIds>)
Argument | Definition |
---|---|
docIds |
Required. The list of document ids for which processing failures should be repaired. |
Example
The following example repairs the faults within the specified parameters.
repairIPMWorkflowFaultsByDocId(docIds=<list document ids>)
4.2.6 sumIPMWorkflowFaults
Command Category: Diagnostic Commands
Use with WLST: Online
Description
Provides a count of processing failures that have occurred during workflow agent processing. The results are grouped by date, application ID, or batch ID.
Syntax
sumIPMWorkflowFaults(group)
Argument | Definition |
---|---|
groupOption |
Required. One of the following:
|
Example
The following example returns all workflow faults grouped first by date, then by applications ID, then again grouped by batch ID.
sumIPMWorkflowFaults(group="DATE") sumIPMWorkflowFaults(group="APPID") sumIPMWorkflowFaults(group="BATCHID")
4.2.7 resetIPMDMSMetrics
Command Category: Diagnostic Commands
Use with WLST: Online
Description
Resets all Dynamic Monitoring Server (DMS) metrics associated with I/PM to zero. This is generally done if the administrator finds that historical performance data is skewing the current results.
Syntax
resetIPMDMSMetrics()
Example
The following example resets all DMS metrics to zero.
resetIPMDMSMetrics()
4.3 Imaging Configuration Commands
Use the Imaging configuration commands, listed in Table 4-3, to list and set configuration values specific to Imaging.
Table 4-3 Configuration Commands for Imaging
Use this command... | To... | Use with WLST... |
---|---|---|
Creates a new Imaging connection from a connection definition file. |
Online |
|
Modifies the Oracle WebCenter Content: 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 |
|
Lists parameter limits for Oracle WebCenter Content: Imaging MBean parameters. |
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 |
|
List the definitions that are on the system for one of the following types; APPLICATIONS, SEARCHES, INPUTS. |
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 |
4.3.1 createIPMConnection
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
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 Managing Connections in Administering Oracle WebCenter Content: Imaging.
Syntax
createIPMConnection(connectionFile)
Argument | Definition |
---|---|
connectionFile |
Required. A full path to the connection definition file's location on the Imaging server Node. Must be enclosed in single or double quotes. |
Example
The following example creates a connection based on the specified attribute.
createIPMConnection(connectionFile="/home/ipmuser/localCSConnection.xml")
4.3.2 modifyIPMConnection
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
Modifies the Oracle WebCenter Content: Imaging connection from a connection definition file.
The connection definition file is an XML file that describes a single Oracle WebCenter Content: Imaging connection definition using the Connection element type from the Oracle WebCenter Content: Imaging ConnectionService web services API schema definition. This schema is available from a running Oracle WebCenter Content: Imaging server using 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 Managing Connections in Administering Oracle WebCenter Content: Imaging.
Syntax
modifyIPMConnection(connectionFile)
Argument | Definition |
---|---|
connectionFile |
Required. A full path to the connection definition file's location on the Imaging server node. Must be enclosed in single or double quotes |
Example
The following example modifies a connection based on the specified attribute.
modifyIPMConnection(connectionFile="/home/ipmuser/localCSConnection.xml")
4.3.3 getIPMConfig
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
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.
Syntax
getIPMConfig(attrName)
Argument | Definition |
---|---|
attrName |
Required. Name of the attribute to be read. Must be enclosed in single or double quotes. |
Example
The following example returns the value for the specified attribute names.
getIPMConfig('AgentUser')getIPMConfig('CheckInterval')
4.3.4 getIPMParamLimits
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
Lists parameter limits for Oracle WebCenter Content: Imaging MBean parameters. Returns an array with the limits applicable for an Imaging Mbean parameter.
Syntax
getIPMParamLimits(paramName="<MBean parameter name>")
Argument | Definition |
---|---|
paramName |
Optional. The MBean parameter name to return the limits for. If not set, will return all valid parameter names. |
Example
The following examples return the limits for the specified attribute names.
getIPMParamLimits("UIMaxSearchResults") getIPMParamLimits("InputAgentCheckInterval") getIPMParamLimits()
4.3.5 grantIPMCredAccess
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
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.
Syntax
grantIPMCredAccess()
Example
The following example returns a list of all Imaging configuration mbeans.
grantIPMCredAccess()
4.3.6 importIPMApplication
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
Imports an application definition from a previously exported definition file.
Syntax
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. |
Example 1
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")
Example 2
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")
4.3.7 importIPMInput
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
Imports an input definition from a previously exported definition file.
Syntax
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. |
Example 1
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")
Example 2
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")
4.3.8 importIPMSearch
Command Category: Imaging Configuration Commands
Description
Import a search definition from a previously exported definition file.
Syntax
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. |
Example 1
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")
Example 2
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")
4.3.9 listIPMConfig
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
Provides a listing of Imaging configuration mbeans. The command is equivalent to browsing the custom mbean hierarchy and listing the Imaging mbean attributes.
Syntax
listIPMConfig()
Example
The following example returns a list of all Imaging configuration mbeans.
listIPMConfig()
4.3.10 listIPMDefinitions
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
Lists the definitions that are on the system for one of the following types: APPLICATIONS, SEARCHES, INPUTS.
Syntax
listIPMDefinitions(defType="<definition type>")
Argument | Definition |
---|---|
defType |
Required. One of APPLICATIONS, SEARCHES, INPUTS. This argument is case insensitive.
|
Example
The following examples return the list of inputs and applications residing on the system.
listIPMDefinitions(defType="INPUTS") listIPMDefinitions(defType="APPLICATIONS")
4.3.11 listIPMExportFile
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
Lists the contents of an exported Imaging definitions file.
Syntax
listIPMExportFile(exportFile="<path to file>")
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. |
Example
The following example returns the contents of an Imaging definitions file.
listIPMExportFile(exportFile="/home/ipmuser/exportdefinitions.xml")
4.3.12 refreshIPMSecurity
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
Refreshes security items currently stored in the Imaging database. This is typically done when migrating security to a different policy store and only updates security items found in the new policy store.
Syntax
refreshIPMSecurity()
Example
The following example refreshes the security items stored in the Imaging database.
refreshIPMSecurity()
4.3.13 setIPMConfig
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
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.
Syntax
setIPMConfig(attrName, value)
Argument | Definition |
---|---|
attrName |
Required. Name of the attribute to be set. Must be enclosed in single or double quotes. |
value |
Required. Value of the attribute to be set. Only enclosed in single or double quotes if value is a string literal. |
Example
The following example sets the specified values for the specified attribute names.
setIPMConfig('AgentUser', 'agentadmin')setIPMConfig('CheckInterval', 30)
4.3.14 submitIPMToWorkflow
Command Category: Imaging Configuration Commands
Use with WLST: Online
Description
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.
Syntax
submitIPMToWorkflow(documentId)
Argument | Definition |
---|---|
documentId |
Required. The unique document ID of the submitted document. |
Example
The following example submits a document to a workflow.
submitIPMToWorkflow(documentId="2.IPM_12345")