Oracle® Fusion Middleware WebLogic Scripting Tool Command Reference 11g Release 1 (10.3.5) Part Number E13813-09 |
|
|
View PDF |
The following sections describe the WLST commands that are specific to Oracle Imaging and Process Management. Topics include:
WLST commands specific to Imaging and Process Management are divided into the following categories.
Use the Oracle I/PM WLST diagnostic commands, listed in table Table 17-2, to list and organize processing failures during workflow processes.
Table 17-2 Diagnostic Commands for Oracle I/PM
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. |
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
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. |
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.
sumIPMWorkflowFaults(group)
Argument | Definition |
---|---|
groupOption
|
Required. One of the following:
|
Use the Oracle I/PM configuration commands, listed in Table 17-3, to list and set configuration values specific to Oracle I/PM.
Table 17-3 Configuration Commands for Oracle I/PM
Use this command... | To... | Use with WLST... |
---|---|---|
Creates a new Oracle I/PM connection from a connection definition file. |
Online |
|
Get an Oracle I/PM configuration setting value, similar to navigating to the custom Oracle I/PM config mbean and using the standard WLST set command. |
Online |
|
Grants CredentialAccessPermissions to Oracle I/PM when Oracle I/PM managed servers are in a separate domain home from the admin 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 Oracle I/PM configuration mbeans. |
Online |
|
Lists the contents of an exported Oracle I/PM definitions file. |
Online |
|
Refresh security items currently stored in the Oracle I/PM database. |
Online |
|
Sets an Oracle I/PM configuration value. |
Online |
|
Submits a document to the workflow agent. |
Online |
Command Category: Oracle I/PM Configuration Commands
Use with WLST: Online
Creates a new Oracle I/PM connection from a connection definition file. The connection definition file is an XML file that describes a single Oracle I/PM connection definition using the Connection element type from the Oracle I/PM ConnectionService web services API schema definition. This schema is available from a running Oracle I/PM 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 Administrator's Guide for Imaging and Process Management.
createIPMConnection(connectionFile)
Argument | Definition |
---|---|
connectionFile
|
Required. A full path to the connection definition file's location on the Oracle I/PM server Node. Must be enclosed in single or double quotes. |
Command Category: Oracle I/PM Configuration Commands
Use with WLST: Online
Gets an Oracle I/PM configuration setting value. The command is equivalent to browsing the custom mbean hierarchy to the Oracle I/PM config mbean and using the standard WLST set command to set an mbean attribute.
getIPMConfig(attrName)
Argument | Definition |
---|---|
attrName
|
Required. Name of the attribute to be read. Must be enclosed in single or double quotes. |
Grants CredentialAccessPermissions to Oracle I/PM so that it can read credentials from the credential store. This command is required in configurations where Oracle I/PM managed servers are in a separate domain home from the admin server. When at least one Oracle I/PM managed server is in the same domain home as the admin server, this command is not required, as CredentialAccessPermissions are granted during Oracle I/PM startup.
When the Oracle I/PM managed server is not in the same domain home as the admin server, however, the Oracle I/PM startup grant only affects the local settings. Local settings get overwritten when the admin server synchronizes its copy as the domain wide configuration, so this command updates the admin server configuration such that permissions are distributed correctly to all domain nodes.
Imports an application definition from a previously exported definition file.
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 Oracle I/PM 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")
Imports an input definition from a previously exported definition file.
importIPMInput(exportFile, action, name, securityOption, securityMember) )
Argument | Definition |
---|---|
exportFile
|
Required. A full path to the export definition file's location on the Oracle I/PM 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")
Import a search definition from a previously exported definition file.
importIPMSearch(exportFile, action, name, securityOption, securityMember)
Argument | Definition |
---|---|
exportFile
|
Required. A full path to the export definition file's location on the Oracle I/PM 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")
Command Category: Oracle I/PM Configuration Commands
Use with WLST: Online
Provides a listing of Oracle I/PM configuration mbeans. The command is equivalent to browsing the custom mbean hierarchy and listing the Oracle I/PM mbean attributes.
Lists the contents of an exported Oracle I/PM definitions file.
listIPMExportFile(exportFile="<path to file>")
Argument | Definition |
---|---|
exportFile
|
Required. A full path to the export definition file's location on the Oracle I/PM server node. Must be enclosed in single or double quotes. |
Command Category: Oracle I/PM Configuration Commands
Use with WLST: Online
Refreshes security items currently stored in the Oracle I/PM database. This is typically done when migrating security to a different policy store and only updates security items found in the new policy store.
Command Category: Oracle I/PM Configuration Commands
Use with WLST: Online
Sets an Oracle I/PM configuration setting value. The command is equivalent to browsing the custom mbean hierarchy to the Oracle I/PM config mbean and using the standard WLST 'set' command to set an mbean attribute.
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. |
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.
submitIPMToWorkflow(documentId)
Argument | Definition |
---|---|
documentId
|
Required. The unique document ID of the submitted document. |