17 Oracle WebCenter: Imaging Custom WLST Commands

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:

Overview of Imaging WLST Command Categories

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

Table 17-1 Imaging WLST Command Categories

Command category Description

Diagnostic Commands

Return workflow agent and other processing information.

Imaging Configuration Commands

Configure settings specific to Imaging and Process Management.

Diagnostic Commands

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...

clearIPMWorkflowFaults

Clear processing failures that occurred during workflow agent processing.

Online

listIPMWorkflowFaults

Provide details of processing failures that occurred during workflow agent processing.

Online

repairIPMWorkflowFaults

Repair processing failures that occurred during workflow agent processing.

Online

sumIPMWorkflowFaults

Count processing failures during workflow agent processing, grouped by choice of date, application ID, or batch ID.

Online

resetIpmDMSMetrics

Reset DMS metrics to zero.

Online

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)

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 lists 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)

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 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)

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:

  • 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 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")

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()

Imaging Configuration Commands

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...

createIPMConnection

Creates a new Imaging connection from a connection definition file.

Online

getIPMConfig

Get an Imaging configuration setting value, similar to navigating to the custom Imaging config mbean and using the standard WLST set command.

Online

grantIPMCredAccess

Grants CredentialAccessPermissions to Imaging when Imaging Managed Servers are in a separate domain home from the Administration Server.

Online

importIPMApplication

Imports an application definition from a previously exported definition file.

Online

importIPMInput

Imports an input definition from a previously exported definition file.

Online

importIPMSearch

Imports a search definition from a previously exported definition file.

Online

listIPMConfig

Lists Imaging configuration mbeans.

Online

listIPMExportFile

Lists the contents of an exported Imaging definitions file.

Online

refreshIPMSecurity

Refresh security items currently stored in the Imaging database.

Online

setIPMConfig

Sets an Imaging configuration value.

Online

submitIPMToWorkflow

Submits a document to the workflow agent.

Online

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 the Oracle Fusion Middleware 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")

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')

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()

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:

  • Add: Creates a new input. Fails if an application with the same name already exists.

  • Update: Modifies and existing input. Fails if an application with the same name does not exist.

  • AddOrUpdate: Creates a new application if it does not already exist or updates one that does.

 
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:

  • Existing: Uses application security as defined in the existing definition. Valid only for an update action.

  • Imported: Attempts to use application security as defined in the import file. Fails if any members defined in the import file are invalid.

  • ValidOnly: Uses application security as defined in the import file and filters out any invalid members.

  • CurrentUser: Sets full permissions to the user used to connect to the server.

  • User: Sets full permissions to the user name provided in the securityMember parameter.

  • Group: Sets full permissions to the group name provided in the securityMember parameter.

 
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.

  • Existing: Uses document security as defined in the existing application. Valid only for an update action.

  • Imported: Attempts to use document security as defined in the import file. Fails if any members defined in the import file are invalid.

  • ValidOnly: Uses document security as defined in the import file and filters out any invalid members.

  • Group: Sets full permissions to the group name provided in the docSecurityGroup parameter.

 
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.

  • Existing: Uses the document storage policy as defined in the existing application. Valid only for an update action.

  • Imported: Attempts to use storage policy as defined in the import file.

  • Volume: Uses the specific volume named in the storageVolume parameter.

  • Default: Sets up the storage policy to use the system default volume.

 
storageVolume

Required. Volume for setting storage policy. Valid only when a storageOption of Volume is used. Ignored otherwise.

Example

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

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")

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:

  • Add: Creates a new input. Fails if an input with the same name already exists.

  • Update: Modifies an existing input. Fails if an input with the same name does not exist.

  • AddOrUpdate: Creates a new application if it does not already exist or updates one that does.

 
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:

  • Existing: Uses input security as defined in the existing definition. Valid only for an update action.

  • Imported: Attempts to use input security as defined in the import file. Fails if any members defined in the import file are invalid.

  • ValidOnly: Uses input security as defined in the import file and filters out any invalid members.

  • CurrentUser: Sets full permissions to the user used to connect to the server.

  • User: Sets full permissions to the user name provided in the securityMember parameter.

  • Group: Sets full permissions to the group name provided in the securityMember parameter.

 
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

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

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")

importIPMSearch

Command Category: Imaging Configuration Commands

Use with WLST: Online

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:

  • Add: Creates a new search. Fails if a search with the same name already exists.

  • Update: Modifies an existing search. Fails if a search with the same name does not exist.

  • AddOrUpdate: Creates a new search if it does not already exist or updates one that does.

 
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:

  • Existing: Uses search security as defined in the existing definition. Valid only for an update action.

  • Imported: Attempts to use search security as defined in the import file. Fails if any members defined in the import file are invalid.

  • ValidOnly: Uses search security as defined in the import file and filters out any invalid members.

  • CurrentUser: Sets full permissions to the user used to connect to the server.

  • User: Sets full permissions to the user name provided in the securityMember parameter.

  • Group: Sets full permissions to the group name provided in the securityMember parameter.

 
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

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

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")

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()

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")

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()

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)

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")