17 Imaging and Process Management Custom WLST Commands

The following sections describe the WLST commands that are specific to Oracle Imaging and Process Management. Topics include:

Overview of I/PM WLST Command Categories
BPEL Diagnostic Commands
I/PM Configuration Commands

Overview of I/PM WLST Command Categories

WLST commands specific to Imaging and Process Management are divided into the following categories.

Table 17-1 I/PM WLST Command Categories

Command category	Description
BPEL Diagnostic Commands	Return BPEL agent processing failures.
I/PM Configuration Commands	Configure settings specific to Imaging and Process Management.

BPEL Diagnostic Commands

Use the I/PM WLST BPEL diagnostic commands, listed in table Table 17-2, to list and organize processing failures during BPEL processes.

Table 17-2 Diagnostic Commands for I/PM BPEL Processing

Use this command...	To...	Use with WLST...
sumIPMBpelFaults	Count processing failures during BPEL agent processing, grouped by choice of date, application ID, or batch ID.	Online
clearIPMBpelFaults	Clear processing failures that occurred during BPEL agent processing.	Online
listIPMBpelFaults	Provide details of processing failures that occurred during BPEL agent processing.	Online
repairIPMBpelFaults	Repair processing failures that occurred during BPEL agent processing.	Online

sumIPMBpelFaults

Command Category: BPEL Diagnostic Commands

Use with WLST: Online

Description

Provides a count of processing failures that have occurred during BPEL agent processing. The results are grouped by date, application ID, or batch ID.

Syntax

sumIPMBpelFaults(group)

Argument	Definition
groupOption	Required. One of the following: DATE: Returns fault counts grouped by date. APPID: Returns fault counts grouped by application ID. BATCHID: Returns fault counts grouped by batch ID.

Example

The following example returns all BPEL faults grouped first by date, then by applications ID, then again grouped by batch ID.

sumIPMBpelFaults(group="DATE")
sumIPMBpelFaults(group="APPID")
sumIPMBpelFaults(group="BATCHID")

clearIPMBpelFaults

Command Category: BPEL Diagnostic Commands

Use with WLST: Online

Description

Clear processing failures that have occurred during BPEL agent processing.

Syntax

clearIPMBpelFaults([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.

clearIPMBpelFaults(startDate="2009-06-01", endDate="2009-06-02")
clearIPMBpelFaults(appId=3)
clearIPMBpelFaults(batchId=15)
clearIPMBpelFaults(startDate="2009-06-01", endDate="2009-06-02", appid=3)

listIPMBpelFaults

Command Category: BPEL Diagnostic Commands

Use with WLST: Online

Description

List details on processing failures that have occurred during BPEL agent processing.

Syntax

listIPMBpelFaults([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 lists the faults within the specified parameters.

listIPMBpelFaults(startDate="2009-06-01", endDate="2009-06-02")
listIPMBpelFaults(appId=3)
listIPMBpelFaults(batchId=15)
listIPMBpelFaults(startDate="2009-06-01", endDate="2009-06-02", appId=3)

repairIPMBpelFaults

Command Category: BPEL Diagnostic Commands

Use with WLST: Online

Description

Repair processing failures that have occurred during BPEL agent processing.

Syntax

repairIPMBpelFaults([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 repairs the faults within the specified parameters.

repairIPMBpelFaults(startDate="2009-06-01", endDate="2009-06-02")
repairIPMBpelFaults(appId=3)
repairIPMBpelFaults(batchId=15)
repairIPMBpelFaults(startDate="2009-06-01", endDate="2009-06-02", appid=3)

I/PM Configuration Commands

Use the I/PM configuration commands, listed in Table 17-3, to list and set configuration values specific to I/PM.

Table 17-3 Configuration Commands for I/PM

Use this command...	To...	Use with WLST...
getIPMConfig	Get an I/PM configuration setting value, similar to navigating to the custom I/PM config mbean and using the standard WLST set command.	Online
grantIPMCredAccess	Grants CredentialAccessPermissions to I/PM when I/PM managed servers are in a separate domain home from the admin server.	Online
listIPMConfig	List I/PM configuration mbeans.	Online
refreshIPMSecurity	Refresh security items currently stored in the I/PM database.	Online
setIPMConfig	Set an I/PM configuration value.	Online

getIPMConfig

Command Category: I/PM Configuration Commands

Use with WLST: Online

Description

Gets an I/PM configuration setting value. The command is equivalent to browsing the custom mbean hierarchy to the I/PM 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')

grantIPMCredAccess

Grants CredentialAccessPermissions to I/PM so that it can read credentials from the credential store. This command is required in configurations where I/PM managed servers are in a separate domain home from the admin server. When at least one I/PM managed server is in the same domain home as the admin server, this command is not required, as CredentialAccessPermissions are granted during I/PM startup.

When the I/PM managed server is not in the same domain home as the admin server, however, the 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.

Syntax

grantIPMCredAccess()

Example

The following example returns a list of all I/PM configuration mbeans.

grantIPMCredAccess()

listIPMConfig

Command Category: I/PM Configuration Commands

Use with WLST: Online

Description

Provides a listing of I/PM configuration mbeans. The command is equivalent to browsing the custom mbean hierarchy and listing the I/PM mbean attributes.

Syntax

listIPMConfig()

Example

The following example returns a list of all I/PM configuration mbeans.

listIPMConfig()

refreshIPMSecurity

Command Category: I/PM Configuration Commands

Use with WLST: Online

Description

Refreshes security items currently stored in the 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.

Syntax

refreshIPMSecurity()

Example

The following example refreshes the security items stored in the I/PM database.

refreshIPMSecurity()

setIPMConfig

Command Category: I/PM Configuration Commands

Use with WLST: Online

Description

Sets an I/PM configuration setting value. The command is equivalent to browsing the custom mbean hierarchy to the I/PM 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)