18 Oracle Business Process ManagementカスタムWLSTコマンド

この章では、Business Process Management (BPM)用のカスタムWLSTコマンド、およびそのコマンド構文、引数、コマンド例を詳細に説明します。

この章では、Oracle Business Process ManagementカスタムWLSTコマンドのリストを示し、説明します。

BPMLifecycleAdminコマンド・グループ

表18-1は、プロジェクトのライフサイクル管理のためのBPMLifecycleAdminコマンドのリストを示し、説明しています。

表18-1 プロジェクトのライフサイクル管理のためのBPMLifecycleAdminコマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
create_public_share	公開共有を作成します。	オフライン
unlock_public_share	公開共有をロック解除します。	オフライン
export_public_share	公開共有をファイル・システムにエクスポートします。	オフライン
delete_public_share	公開共有を削除します。	オフライン
publish_template	テンプレートをMDSに公開します。	オフライン
export_template	テンプレートをファイル・システムにエクスポートします。	オフライン
delete_template	テンプレートをMDSから削除します。	オフライン
connectProjectRepository	MDSプロジェクト・リポジトリへの接続を確立します。	オフライン
disconnectProjectRepository	MDSプロジェクト・リポジトリから接続を切断します。	オフライン
importProject	ディスクからプロジェクト・リポジトリにプロジェクトをインポートします。	オフライン
createProject	テンプレート・プロジェクトに基づいて公開共有プロジェクトを作成します。	オフライン
deleteProject	プロジェクト・リポジトリからプロジェクトを削除します。	オフライン
exportProject	リポジトリに格納されているプロジェクトをディスクにエクスポートします。	オフライン
unlockProject	プロジェクトをロック解除します。	オフライン

create_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、テンプレートから公開共有を作成します。そのテンプレートはMDS内に存在している必要があります。

構文

create_public_share(composerUser, composerPassword, connectionURL, templateName, publicshareId, mdsconfigLocation, [Override], [oracleHome] )

引数	定義
composerUser	現在の操作を実行するBusiness Process Composerユーザー。
composerPassword	BPM Composerユーザーのパスワード
connectionURL	host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL
templateName	MDS内のテンプレートの名前
publicshareId	作成する公開共有の名前
mdsconfigLocation	MDSへの接続に使用するmds-config.xmlの場所
projectLocation	公開共有の作成先のパス。そのパスが存在しない場合、作成されます。ルートは、'/'です。
Override	同じ名前を持つ公開共有がMDS内に存在している場合、その公開共有をオーバーライドできます。このコマンドを実行する場合、テンプレートはオーバーライドされません。
oracleHome	オプション。使用されるOracleホーム。

例

次の例では、Sample_PublicShareという名前の公開共有を作成します。これは、Sample_Templateという名前のテンプレートに基づいています。公開共有の名前はSample_PublicShareであり、mds-config.xmlファイルの場所は/tmp/mds-config.xmlです。

create_public_share('user_name', 'password', 'host:port','Sample_Template', 'Sample_PublicShare','/tmp/mds-config.xml')

次の例では、Sample_PublicShareという名前の公開共有を作成します。これは、MDS内に存在するSample_Templateという名前のテンプレートに基づいています。テンプレートではなく、公開共有がオーバーライドされます。mds-config.xmlファイルの場所は/tmp/mds-config.xmlです。

create_public_share('user_name', 'password', 'host:port','Sample_Template', 'Sample_PublicShare','/tmp/mds-config.xml','true')"

unlock_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、公開共有をロック解除します。たとえば、Antタスクcreate_public_shareコマンドを使用してプロジェクトを作成する場合、そのプロジェクトはロックされた状態で作成されます。その後、unlock_public_shareコマンドを使用してそれをロック解除できます。

ロックは、Oracle Business Process Composerの「プロジェクトの作成」ページの「共有の有効化」チェック・ボックスを選択または選択解除することによっても設定できます。

それは、ユーザーが、Business Process Composerからプロジェクトを公開するときもロック解除されます。

その公開共有はMDS内に存在している必要があります。

構文

unlock_public_share(composerUser, composerPassword, connectionURL, publicshareId, mdsconfigLocation, [oracleHome] )

引数	定義
composerUser	現在の操作を実行するBusiness Process Composerユーザー。
composerPassword	BPM Composerユーザーのパスワード
connectionURL	host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL
publicshareId	ロック解除する公開共有の名前
mdsconfigLocation	MDSへの接続に使用するmds-config.xmlの場所
oracleHome	オプション。使用されるOracleホーム

例

次の例では、Sample_PublicShareという名前の公開共有をロック解除します。mds-config.xmlファイルの場所は/tmp/mds-config.xmlです。

unlock_public_share('user_name', 'password', 'host:port','Sample_PublicShare', '/tmp/mds-config.xml')

export_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSからファイル・システムに公開共有をエクスポートします。

構文

export_public_share(composerUser, composerPassword, connectionURL, publicshareId,fsLocation, mdsconfigLocation, [oracleHome] )

引数	定義
composerUser	現在の操作を実行するBusiness Process Composerユーザー。
composerPassword	BPM Composerユーザーのパスワード
connectionURL	host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL
publicshareId	エクスポートする公開共有の名前
fsLocation	プロジェクトをダウンロードするファイル・システムの場所
mdsconfigLocation	MDSへの接続に使用するmds-config.xmlの場所
oracleHome	オプション。使用されるOracleホーム

例

次の例では、公開共有名としてSample_PublicShareを、ファイル・システムの場所として/tmpを、mds-config.xmlファイルの場所として/tmp/mds-config.xmlを指定します。

export_public_share('user_name', 'password', 'host:port','Sample_PublicShare','/tmp', '/tmp/mds-config.xml')

delete_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSから公開共有を削除します。このコマンドを実行するには、公開共有がロックされていないことが必要です。

構文

delete_public_share(composerUser, composerPassword, connectionURL, publicshareId, mdsconfigLocation, [releaseLock], [oracleHome] )

引数	定義
composerUser	現在の操作を実行するBusiness Process Composerユーザー。
composerPassword	BPM Composerユーザーのパスワード
connectionURL	host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL
publicshareId	削除する公開共有の名前
mdsconfigLocation	MDSへの接続に使用するmds-config.xmlの場所
releaseLock	オプション。公開共有がロックされている場合、このロックは解除でき、削除操作を完了できます。この属性は、trueとfalseのいずれかに設定できます。指定しない場合、デフォルト値はfalseです。
oracleHome	オプション。使用されるOracleホーム

例

次の例では、削除する公開共有の名前および場所を指定します。

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

次の例では、削除する公開共有の名前および場所を指定し、ロックされていてもその公開共有を削除することを指定します。

delete_public_share('user_name', 'password', 'host:port','Sample_PublicShare','/tmp/mds-config.xml','true')

publish_template

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、ファイル・システムからMDSにテンプレートを公開します。

構文

publish_template(composerUser, composerPassword, connectionURL, templateName,fsLocation, mdsconfigLocation, [Override], [oracleHome] )

引数	定義
composerUser	現在の操作を実行するBusiness Process Composerユーザー。
composerPassword	BPM Composerユーザーのパスワード
connectionURL	host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL
templateName	公開するテンプレートの名前
fsLocation	テンプレート・プロジェクトのファイル・システムの場所
mdsconfigLocation	MDSへの接続に使用するmds-config.xmlの場所
projectLocation	公開共有の作成先のパス。そのパスが存在しない場合、作成されます。ルートは、'/'です。
Override	MDSにテンプレートを公開するときに、この属性によって、同じ名前を持つ既存のテンプレートをオーバーライドできます。'true'と'false'のいずれかにすることができます。指定しない場合、デフォルト値は'false'です。
oracleHome	オプション。使用されるOracleホーム

例

次の例では、Sample_Template_Name_MDSという名前のテンプレートをルート・フォルダに公開します。

f('user_name', 'password', 'host:port','Sample_Template','/tmp/MyTemplate','/', '/tmp/mds-config.xml')

次の例では、Sample_Template_Name_MDSという名前のテンプレートを'/WorkingOn/'フォルダに公開します。

publish_template('user_name', 'password', 'host:port','Sample_Template','/tmp/MyTemplate','/WorkingOn', '/tmp/mds-config.xml')

export_template

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSからファイル・システムにテンプレートをエクスポートします。

構文

export_template(composerUser, composerPassword, connectionURL, templateName, fsLocation, mdsconfigLocation, [oracleHome] )

引数	定義
composerUser	現在の操作を実行するBusiness Process Composerユーザー。
composerPassword	BPM Composerユーザーのパスワード
connectionURL	host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL
templateName	エクスポートするテンプレートの名前
fsLocation	プロジェクトをダウンロードするファイル・システムの場所
mdsconfigLocation	MDSへの接続に使用するmds-config.xmlの場所
oracleHome	オプション。使用されるOracleホーム

例

次の例では、テンプレート名としてSample_Templateを、ファイル・システムの場所として/tmpを、mds-config.xmlファイルの場所として/tmp/mds-config.xmlを指定します。

export_template('user_name', 'password', 'host:port','Sample_Template','/tmp','/tmp/mds-config.xml')

delete_template

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSからテンプレートを削除します。

構文

delete_template(composerUser, composerPassword, connectionURL, templateName,mdsconfigLocation, [oracleHome] )

引数	定義
composerUser	現在の操作を実行するBusiness Process Composerユーザー。
composerPassword	BPM Composerユーザーのパスワード
connectionURL	host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL
templateName	削除するテンプレートの名前
fsLocation	テンプレート・プロジェクトのファイル・システムの場所
mdsconfigLocation	MDSへの接続に使用するmds-config.xmlの場所
projectLocation	公開共有の作成先のパス。そのパスが存在しない場合、作成されます。ルートは、'/'です。
oracleHome	オプション。使用されるOracleホーム

例

次の例では、Sample_templateという名前のテンプレートをMDSから削除します。

delete_template('weblogic', 'welcome1', 'host:port','/Sample_template','/tmp/mds-config.xml')

connectProjectRepository

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSプロジェクト・リポジトリへの接続を確立します。

構文

connectProjectRepository(connectionURL, mdsConfigLocation, composerUser, composerPassword, [mdsDbUser], [mdsDbPassword])

引数	定義
connectionURL	host:port形式のセキュリティ・サーバー・サービスへのJNDI接続URL
mdsConfigLocation	MDSへの接続に使用するmds-config.xmlの場所
composerUser	BPM Composerユーザー。このユーザーが現在の操作を実行します。
composerPassword	BPM Composerユーザーのパスワード。
mdsDbUser	オプション。mds-config.xmlファイルに格納されているMDSデータベース・ユーザー名をオーバーライドします。
mdsDbPassword	オプション。mds-config.xmlファイルに格納されているMDSデータベース・パスワードをオーバーライドします。

例

connectProjectRepository(connectionURL='localhost:7001', mdsConfigLocation='/home/user/mds-config.xml', composerUser='weblogic', composerPassword='welcome1')

connectProjectRepository(connectionURL='localhost:7001', mdsConfigLocation='/home/user/mds-config.xml', composerUser='weblogic', composerPassword='welcome1', mdsDbUser='DEV_MDS', mdsDbPassword='dbPassword')

disconnectProjectRepository

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSプロジェクト・リポジトリから接続を切断します。

構文

disconnectProjectRepository()

例

disconnectProjectRepository()

importProject

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、ディスクからプロジェクト・リポジトリにプロジェクトをインポートします。すべてのプロジェクトはテンプレートとしてインポートされます。つまり、インポートされたプロジェクトがテンプレートと公開共有のどちらであるかは関係ありません。

構文

importProject(srcDir, toName, [toPath], [override])

引数	定義
srcDir	テンプレート・プロジェクトのファイル・システムの場所。
toName	テンプレート・プロジェクトのファイル・システムの場所。
toPath	[オプション] テンプレートのインポート先のパス。そのパスが存在しない場合、作成されます。指定しない場合は、ルート'/'が使用されます。
override	[オプション] インポート時に同じ名前の既存のテンプレートをオーバーライドするかどうかを指定します。指定しない場合は、'false'が使用されます。

例

importProject(srcDir='/home/user/myFolder/myTemplate', toName='NewTemplateName')

importProject(srcDir='/home/user/myFolder/myTemplate', toName='NewTemplateName', toPath='/NewFolder', override='true')

セキュリティ制約

なし。すべてのユーザーがプロジェクト・テンプレートをインポートできます。これらのテンプレートは、デフォルトではすべてのユーザーにパブリック権限が付与された状態でインポートされます。

createProject

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、テンプレート・オブジェクトに基づいて公開共有プロジェクトを作成します。

構文

createProject(fromId, toName, [toPath])

引数	定義
fromId	MDS内でのテンプレートの識別子。
toName	作成する公開共有の名前。
toPath	[オプション] 公開共有の作成先のパス。そのパスが存在しない場合、作成されます。指定しない場合は、ルート'/'が使用されます。

例

createProject(fromId='/SampleTemplate', toName='SamplePublicShare')

createProject(fromId='/folder/SampleTemplate', toName='SamplePublicShare', toPath='/newFolder')

セキュリティ制約

なし。すべてのユーザーがテンプレートに基づいて公開共有を作成できます。デフォルトでは、MDS内のすべてのテンプレートはパブリックです。

deleteProject

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、プロジェクト・リポジトリからプロジェクトを削除します。

構文

deleteProject(id, [type], [breakLinks])

引数	定義
id	削除するプロジェクトの識別子。
type	[オプション] プロジェクトがテンプレートまたは公開共有の場合に指定します。有効な値: 'TEMPLATE'、'PUBLIC_SHARED'。指定しない場合、'TEMPLATE'が指定されたものと見なされます。
breakLinks	[オプション] テンプレートを削除する場合にのみ有効です。このテンプレートにリンクされている公開共有がある場合は、リンクを削除する必要があるかどうかを指定します。デフォルト: 'true'

例

deleteProject(id='/SampleTemplate', type='TEMPLATE', breakLinks='true')

deleteProject(id='/folder/SamplePublicShare', type='PUBLIC_SHARED')

セキュリティ制約

ADMIN | OWNER

削除操作を行うには、ユーザーには削除するプロジェクトのADMINまたはOWNERロールが必要です。

exportProject

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、リポジトリに格納されているプロジェクトをディスクにエクスポートします。

構文

exportProject(id, toDir, [type])

引数	定義
id	エクスポートするプロジェクトの識別子。
toDir	プロジェクトのダウンロード先であるファイル・システムの場所。そのパスが存在しない場合、作成されます。
type	[オプション] プロジェクトがテンプレートまたは公開共有の場合に指定します。有効な値: 'TEMPLATE'、'PUBLIC_SHARED'。指定しない場合、'TEMPLATE'が指定されたものと見なされます。

例

exportProject(id='/SampleTemplate', toDir='/home/user/myFolder', type='TEMPLATE')

exportProject(id='/aFolder/SamplePublicShare', toDir='/home/user/myFolder', type='PUBLIC_SHARED')

セキュリティ制約

ADMIN | OWNER | EDITOR | VIEWER

ユーザーには、エクスポートするプロジェクトに対するVIEWER権限が少なくとも必要です。

unlockProject

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

プロジェクトをロック解除します。ロック解除できるのは公開共有のみです。

構文

unlockProject(id)

引数	定義
id	ロック解除するプロジェクトの識別子。

例

unlockProject(id='SamplePublicShare')

セキュリティ制約

ADMIN | OWNER | EDITOR

プロジェクトをロック解除できるのは、それをロックしたユーザーまたはアプリケーションのみです。例外は管理者ユーザーです。管理者は、どのユーザーまたはアプリケーションがプロジェクトをロックしたかにかかわらず、そのプロジェクトをロック解除できます。

アプリケーションとは、Oracle Business Process Composer、Oracle Business Process Management Studioまたは汎用アプリケーションのことです。WLSTの機能は汎用アプリケーションであると見なされます。

注意: プロジェクトに対するWLSTロック操作はないため、プロジェクトが別のアプリケーションによりロックされている場合に、所有者または編集者ユーザーは、WLST unlockProjectコマンドを使用してプロジェクトをロック解除できません。この場合、プロジェクトをロック解除できるのは管理者のみです。