This chapter lists and describes the custom WLST commands for Oracle Business Process Management.
Table 3-1 lists and describes the BPMLifecycleAdmin commands for project lifecycle administration.
Table 3-1 BPMLifecycleAdmin Commands for Project Lifecycle Administration
Use this command... | To... | Use with WLST... |
---|---|---|
Create a public share |
Offline |
|
Unlock a public share |
Offline |
|
Export a public share to the file system |
Offline |
|
Delete a public share |
Offline |
|
Publish a template to MDS |
Offline |
|
Export a template to the file system |
Offline |
|
Delete a template from MDS |
Offline |
Command Category: BPMLifecycleAdmin Commands
Use with WLST: Offline
Use this command to create a public share from a template. The template must exist in MDS.
create_public_share(composerUser, composerPassword, connectionURL, templateName, publicshareId, mdsconfigLocation, [Override], [oracleHome] )
Argument | Definition |
---|---|
|
The Business Process Composer user who performs the current operation. |
composerPassword
|
BPM Composer user's password |
connectionURL
|
JNDI connection URL to the security server service in format |
templateName
|
Name of the template in MDS |
publicshareId
|
Name of the public share to be created |
mdsconfigLocation
|
Location of the |
|
The path where the public share will be created. If the path does not exists it will be created. The root is '/'. |
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. |
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('user_name', 'password', 'host:port','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('user_name', 'password', 'host:port','Sample_Template', 'Sample_PublicShare','/tmp/mds-config.xml','true')"
Command Category: BPMLifecycleAdmin Commands
Use with WLST: Offline
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.
unlock_public_share(composerUser, composerPassword, connectionURL, publicshareId, mdsconfigLocation, [oracleHome] )
Argument | Definition |
---|---|
|
The Business Process Composer user who performs the current operation. |
composerPassword
|
BPM Composer user's password |
connectionURL
|
JNDI connection URL to the security server service in format |
publicshareId
|
Name of the public share to be unlocked |
mdsconfigLocation
|
Location of the |
oracleHome
|
Optional. The Oracle home to be used |
Command Category: BPMLifecycleAdmin Commands
Use with WLST: Offline
export_public_share(composerUser, composerPassword, connectionURL, publicshareId,fsLocation, mdsconfigLocation, [oracleHome] )
Argument | Definition |
---|---|
|
The Business Process Composer user who performs the current operation. |
composerPassword
|
BPM Composer user's password |
connectionURL
|
JNDI connection URL to the security server service in format |
publicshareId
|
Name of the public share to be exported |
fsLocation
|
File system location where the project is to be downloaded |
mdsconfigLocation
|
Location of the |
oracleHome
|
Optional. The Oracle home to be used |
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('user_name', 'password', 'host:port','Sample_PublicShare','/tmp', '/tmp/mds-config.xml')
Command Category: BPMLifecycleAdmin Commands
Use with WLST: Offline
Use this command to delete a public share from MDS. Executing this command requires that the public share is not locked.
delete_public_share(composerUser, composerPassword, connectionURL, publicshareId, mdsconfigLocation, [releaseLock], [oracleHome] )
Argument | Definition |
---|---|
|
The Business Process Composer user who performs the current operation. |
composerPassword
|
BPM Composer user's password |
connectionURL
|
JNDI connection URL to the security server service in format |
publicshareId
|
Name of the public share to be deleted |
mdsconfigLocation
|
Location of the |
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 |
oracleHome
|
Optional. The Oracle home to be used |
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('user_name', 'password', 'host:port','Sample_PublicShare','/tmp/mds-config.xml','true')
Command Category: BPMLifecycleAdmin Commands
Use with WLST: Offline
publish_template(composerUser, composerPassword, connectionURL, templateName,fsLocation, mdsconfigLocation, [Override], [oracleHome] )
Argument | Definition |
---|---|
|
The Business Process Composer user who performs the current operation. |
composerPassword
|
BPM Composer user's password |
connectionURL
|
JNDI connection URL to the security server service in format |
templateName
|
Name of the template to be published |
fsLocation
|
File system location of the template project |
mdsconfigLocation
|
Location of the |
|
The path where the public share will be created. If the path does not exists it will be created. The root is '/' . |
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 |
The following example publishes a template named Sample_Template_Name_MDS
. to the root folder.
f('user_name', 'password', 'host:port','Sample_Template','/tmp/MyTemplate','/', '/tmp/mds-config.xml')
The following example publishes a template named Sample_Template_Name_MDS
.to the '/WorkingOn/'
folder.
publish_template('user_name', 'password', 'host:port','Sample_Template','/tmp/MyTemplate','/WorkingOn', '/tmp/mds-config.xml')
Command Category: BPMLifecycleAdmin Commands
Use with WLST: Offline
export_template(composerUser, composerPassword, connectionURL, templateName, fsLocation, mdsconfigLocation, [oracleHome] )
Argument | Definition |
---|---|
|
The Business Process Composer user who performs the current operation. |
composerPassword
|
BPM Composer user's password |
connectionURL
|
JNDI connection URL to the security server service in format |
templateName
|
Name of the template to be exported |
fsLocation
|
File system location where the project is to be downloaded |
mdsconfigLocation
|
Location of the |
oracleHome
|
Optional. The Oracle home to be used |
Command Category: BPMLifecycleAdmin Commands
Use with WLST: Offline
delete_template(composerUser, composerPassword, connectionURL, templateName,mdsconfigLocation, [oracleHome] )
Argument | Definition |
---|---|
|
The Business Process Composer user who performs the current operation. |
composerPassword
|
BPM Composer user's password |
connectionURL
|
JNDI connection URL to the security server service in format |
templateName
|
Name of the template to be deleted |
fsLocation
|
File system location of the template project |
mdsconfigLocation
|
Location of the |
|
The path where the public share will be created. If the path does not exists it will be created. The root is '/' . |
oracleHome
|
Optional. The Oracle home to be used |