18 Oracle Business Process Management Custom WLST Commands

This chapter lists and describes the custom WLST commands for Oracle Business Process Management.

BPMLifecycleAdmin Command Group

Table 18-1 lists and describes the BPMLifecycleAdmin commands for project lifecycle administration.

Table 18-1 BPMLifecycleAdmin Commands for Project Lifecycle Administration

Use this command...	To...	Use with WLST...
create_public_share	Create a public share	Offline
delete_public_share	Delete a public share	Offline
export_public_share	Export a public share to the file system	Offline
export_template	Export a template to the file system	Offline
publish_template	Publish a template to MDS	Offline
unlock_public_share	Unlock a public share	Offline

create_public_share

Command Category: BPMLifecycleAdmin Commands

Use with WLST: Offline

Description

Use this command to create a public share from a template. The template must exist in MDS.

Syntax

create_public_share(templateName, publicshareName, mdsconfigLocation, [Override], [oracleHome] )

Argument	Definition
templateName	Name of the template in MDS
publicshareName	Name of the public share to be created
mdsconfigLocation	Location of the `mds-config.xml` to be used to connect to MDS
Override	Enables you to override the public share if a public share exists in MDS with the same name. The template is not overwritten when you execute this command.
oracleHome	Optional. The Oracle home to be used.

Examples

The following example creates a public share named Sample_PublicShare. It is based on the template with name Sample_Template. The name of the public share is Sample_PublicShare, and the location of the mds-config.xml file is /tmp/mds-config.xml.

create_public_share('Sample_Template', 'Sample_PublicShare','/tmp/mds-config.xml')

The following example creates a public share named Sample_PublicShare. It is based on the template named Sample_Template that exists in MDS. The public share, not the template, is overridden. The location of the mds-config.xml file is /tmp/mds-config.xml.

create_public_share('Sample_Template', 'Sample_PublicShare','/tmp/mds-config.xml','true')"

delete_public_share

Command Category: BPMLifecycleAdmin Commands

Use with WLST: Offline

Description

Use this command to delete a public share from MDS. Executing this command requires that the public share is not locked.

Syntax

delete_public_share(publicshareName, mdsconfigLocation, [releaseLock], [oracleHome] )

Argument	Definition
publicshareName	Name of the public share to be deleted
mdsconfigLocation	Location of the `mds-config.xml` to be used to connect to MDS
releaseLock	Optional. If the public share is locked, this lock can be released and the delete operation completed. You can set this attribute to either `true` or `false`. If not specified, default value is `false`.
oracleHome	Optional. The Oracle home to be used

Examples

The following example specifies the name and location of a public share to be deleted.

delete_public_share('Sample_PublicShare','/tmp/mds-config.xml')

The following example specifies the name and location of a public share to be deleted, and that the public share should be deleted even if locked.

delete_public_share('Sample_PublicShare','/tmp/mds-config.xml','true')

export_public_share

Command Category: BPMLifecycleAdmin Commands

Use with WLST: Offline

Description

Use this command to export the public share from MDS to the file system.

Syntax

export_public_share(publicshareName,fsLocation, mdsconfigLocation, [oracleHome] )

Argument	Definition
publicshareName	Name of the public share to be exported
fsLocation	File system location where the project is to be downloaded
mdsconfigLocation	Location of the `mds-config.xml` to be used to connect to MDS
oracleHome	Optional. The Oracle home to be used

Example

The following example specifies the public share name as Sample_PublicShare, the file system location as /tmp, and the location of the mds-config.xml file as /tmp/mds-config.xml.

export_public_share('Sample_PublicShare','/tmp', '/tmp/mds-config.xml')

export_template

Command Category: BPMLifecycleAdmin Commands

Use with WLST: Offline

Description

Use this command to export the template from MDS to the file system.

Syntax

export_template(templateName, fsLocation, mdsconfigLocation, [oracleHome] )

Argument	Definition
templateName	Name of the template to be exported
fsLocation	File system location where the project is to be downloaded
mdsconfigLocation	Location of the `mds-config.xml` to be used to connect to MDS
oracleHome	Optional. The Oracle home to be used

Example

The following example specifies the template name as Sample_Template, the file system location as /tmp, and the location of the mds-config.xml file as /tmp/mds-config.xml.

export_template('Sample_Template','/tmp','/tmp/mds-config.xml')

publish_template

Command Category: BPMLifecycleAdmin Commands

Use with WLST: Offline

Description

Use this command to publish the template from the file system to MDS.

Syntax

publish_template(templateName, fsLocation, mdsconfigLocation, [Override], [oracleHome] )

Argument	Definition
templateName	Name of the template to be published
fsLocation	File system location of the template project
mdsconfigLocation	Location of the `mds-config.xml` to be used to connect to MDS
Override	When you publish a template in MDS, this attribute enables you to override an existing template with the same name. Can either be 'true' or 'false'. If not specified, default value is 'false'.
oracleHome	Optional. The Oracle home to be used

Example

The following example publishes a template named Sample_Template_Name_MDS. The template project is located in the directory /tmp/Sample_Template_name_FS. The file mds-config.xml that is used to connect to MDS is located at /tmp/mds-config.xml.

publish_template('Sample_Template_Name_MDS','/tmp/Sample_Template_name_FS','/tmp/mds-config.xml')

unlock_public_share

Command Category: BPMLifecycleAdmin Commands

Use with WLST: Offline

Description

Use this command to unlock a public share. For example, when you create project by using the Ant task create_public_share command, the project is created as locked. You can then unlock it by using the unlock_public_share command.

A lock is also set by enabling or disabling the check box enable sharing in the project creation page in Oracle Business Process Composer.

It is also released when the user publishes a project from Business Process Composer.

The public share must exist in MDS.

Syntax

unlock_public_share(publicshareName, mdsconfigLocation, [oracleHome] )

Argument	Definition
publicshareName	Name of the public share to be unlocked
mdsconfigLocation	Location of the `mds-config.xml` to be used to connect to MDS
oracleHome	Optional. The Oracle home to be used

Example

The following example unlocks a public share named Sample_PublicShare. The location of the mds-config.xml file is /tmp/mds-config.xml.

unlock_public_share('Sample_PublicShare', '/tmp/mds-config.xml')