ヘッダーをスキップ
Oracle® Fusion Middleware Oracle SOA Suite開発者ガイド
11gリリース1 (11.1.1.7)
B56238-10
  目次へ移動
目次
索引へ移動
索引

前
 
次
 

G Oracle BAM ICommandの操作とファイル形式

この付録では、ICommandコマンドライン・ユーティリティとWebサービスで使用できる操作とパラメータについてそれぞれ詳細に説明します。

項目は次のとおりです。

ICommandの詳細は、次の各トピックを参照してください。

G.1 個々の操作のサマリー

この項では、各ICommand操作で使用可能なパラメータの要約を示します。これらの操作のサマリーは、コマンド・プロンプトでicommand(パラメータなし)と入力してコマンド・ウィンドウに表示することもできます。

表G-1に、ICommandで使用できるコマンドの要約を示します。

表G-1 ICommandコマンドのサマリー

コマンド パラメータ

clear

-name itemname

[-type [dataobject|folder|distributionlist]]

clearの詳細は、G.2.1項「clear」を参照してください。

delete

[-name itemname]

[-type [dataobject|folder|report|rule|securityfilters|

 distributionlist|ems|eds|all]]

[-match pattern]

[-regex regularexpression]

[-all [0|1]]

[-systemobjects [0|1]]

deleteの詳細は、G.2.2項「delete」を参照してください。

export

-file file_name

[-name itemname]

[-type [dataobject|folder|report|rule|securityfilters|

 distributionlist|ems|eds|all]]

[-match pattern]

[-regex regularexpression]

[-all [0|1]]

[-systemobjects [0|1]]

[-dependencies [0|1]]

[-layout [0|1]]

[-contents [0|1]]

[-permissions [0|1]]

[-owner [0|1]]

[-header [0|1]]

[-footer [0|1]]

[-append [0|1]]

[-preview [0|1]]

exportの詳細は、G.2.3項「export」を参照してください。

import

-file file_name

-continueonerror

[-delay milliseconds]

[-updatelayout]

[-mode [preserveid|update|overwrite|append|rename|error]]

[-preserveowner]

[-setcol col_name/[null|now|value:override_value]]

[-preview]

importの詳細は、G.2.4項「import」を参照してください。

rename

-name itemname

-newname newitemname

[-type [dataobject|folder|report|rule|distributionlist|ems|

eds]]

renameの詳細は、G.2.5項「rename」を参照してください。


G.2 操作に関する詳細な説明

この項では、ICommandコマンド、各種パラメータおよびその例の詳細を説明します。次の項目が含まれます。

G.2.1 clear

アクティブ・データ・キャッシュにあるアイテムのコンテンツを消去します。

消去の意味は、アイテム・タイプによって異なります。

  • データ・オブジェクトの場合は、データ・オブジェクト内の既存のすべての行が削除されます。

  • フォルダの場合は、フォルダのすべてのコンテンツが削除されます。

  • ディストリビューション・リストでは、すべてのメンバー(ユーザーおよびグループ)がそのディストリビューション・リストから削除されます。

表G-2 clearコマンドのパラメータ

パラメータ 説明

-name itemname

消去するアイテムの名前。必須です。

-type itemtype

消去するアイテムのタイプ。次の値が有効です。

  • dataobject(例G-1を参照)

  • folder

  • distributionlist

このパラメータを省略すると、dataobjectが使用されます。


例G-1 データ・オブジェクトの消去

icommand -cmd clear -name "/Samples/Call Center" -type dataobject

G.2.2 delete

アクティブ・データ・キャッシュからアイテムを削除します。

表G-3 deleteコマンドのパラメータ

パラメータ 説明

-all [0|1]

指定したタイプのすべてのアイテムを削除するかどうかを制御します(例G-5を参照)。

0(ゼロ)以外の値を指定した場合または値を省略した場合は、指定したタイプのすべてのアイテムが削除され、0(ゼロ)を指定した場合は、指定した(一致した)アイテムのみが削除されます。このパラメータを省略すると、0(ゼロ)が使用されます。

-match pattern

アスタリスク(*)および疑問符(?)を使用するDOS形式のパターン一致文字列。名前がパターンと一致するアイテムが削除されます。

-name itemname

削除するアイテムの名前。

-regex regularexpr

正規表現パターン一致文字列。名前がパターンと一致するアイテムが削除されます。詳細は、G.6項「正規表現」を参照してください。

-systemobjects [0|1]

allmatchまたはregexパラメータを使用した場合にSystemフォルダ内のデータ・オブジェクトが含まれるかどうかを制御します。0(ゼロ)を指定すると、データ・オブジェクトは含まれません。このパラメータを省略すると、0(ゼロ)が使用されます。

-type itemtype

削除するアイテムのタイプ。次の値が有効です。

  • dataobject(例G-2を参照)

  • folder

  • report (例G-5を参照)

  • rule

  • securityfilters(指定したデータ・オブジェクトの場合)

  • distributionlist

  • ems(エンタープライズ・メッセージ・ソース)

  • eds(外部データ・ソース)

  • all(例G-6を参照)

このパラメータを省略すると、dataobjectが使用されます。


例G-2 データ・オブジェクトの削除

TestDOという名前のデータ・オブジェクトを削除します。typeパラメータを指定しない場合は、dataobjectタイプが使用されます。

icommand -cmd delete -name TestDO 

例G-3 アラート・ルールの削除

ICommand操作でアラートが発生する場合、typeパラメータの値はruleです。このコマンドで、MyAlertという名前のルールを削除します。

icommand -cmd delete -type rule -name "MyAlert"

例G-4 データ・オブジェクトに定義されているセキュリティ・フィルタの削除

データ・オブジェクトに定義されているセキュリティ・フィルタを削除するには、セキュリティ・フィルタの名前ではなくデータ・オブジェクトの名前を指定する必要があります。このコマンドで、データ・オブジェクトMyDataObjectに定義されているすべてのセキュリティ・フィルタを削除します。

icommand -cmd delete -type securityfilters -name "MyDataObject"

例G-5 すべてのレポートの削除

reportタイプのすべてのオブジェクトを削除します。

icommand -cmd delete -type report -all 1

例G-6 すべてのオブジェクトの削除

システム・オブジェクト(Systemフォルダのデータ・オブジェクト)を除くすべてのアイテムを削除します。

icommand -cmd delete -type all

G.2.3 export

アクティブ・データ・キャッシュの1つ以上のオブジェクトに関する情報をXMLファイルにエクスポートします。エクスポートされたデータ・オブジェクトの例は、G.5項「サンプル・エクスポート・ファイル」を参照してください。

表G-4 exportコマンドのパラメータ

パラメータ 説明

-all [0|1]

指定したタイプのすべてのアイテムについて、エクスポートするかどうかを制御します。

0(ゼロ)以外の値を指定した場合または値を省略した場合は、指定したタイプのすべてのアイテムがエクスポートされ、0(ゼロ)を指定した場合は、指定した(一致した)アイテムのみがエクスポートされます。このパラメータを省略すると、0(ゼロ)が使用されます。

レポート、フォルダおよびルールの場合は、ICommandを実行しているユーザーが管理者でないかぎり、そのICommandを実行しているユーザーが所有しているアイテムのみがエクスポートされます。管理者がICommandを実行すると、すべてのユーザーのアイテムがエクスポートされます。

例G-14「システム内のすべてのレポートのエクスポート」を参照してください。

-append [0|1]

エクスポートされた情報を既存のファイルに追加するかどうかを制御します。

0(ゼロ)以外の値を指定すると、追加されます。0(ゼロ)を指定すると、既存ファイルのコンテンツが上書きされます。このパラメータを省略するか、または値を省略すると、0(ゼロ)が使用されます。

appendパラメータは、例G-23「エクスポートでのappendパラメータの使用」の説明に従って、ヘッダー・パラメータおよびフッター・パラメータとともに使用する必要があります。

appendパラメータを使用する場合は、ヘッダー・パラメータとフッター・パラメータを定義する必要があります。これらのパラメータを定義しないと、エクスポート・ファイルへの各appendごとに、XMLヘッダー情報タグとXML </OracleBAMExport>終了タグが含まれます。このファイルはOracle BAMへのインポートに使用できません。これは、最初の</OracleBAMExport>終了タグが検出された時点でインポートが停止し、残りのオブジェクトが無視されるためです。

-contents [0|1]

コンテンツ情報(行、列値)をエクスポートするかどうかを制御します。データ・オブジェクトに対してのみ適用されます。contentsパラメータは他のアーティファクトに対して使用できないため、-type allパラメータとともに使用することはできません。

0(ゼロ)以外の値を指定すると、コンテンツ情報がエクスポートされます。0(ゼロ)を指定すると、コンテンツ情報はエクスポートされません。このパラメータを省略するか、または値を省略すると、0(ゼロ)以外の値が使用されます。

また、次の場合にのみ使用できます。

  • すべてのデータ・オブジェクトが、パラメータ-all 1を使用してエクスポートされる場合

  • 一連のデータ・オブジェクトが、regexまたはmatchパラメータを使用してエクスポートされる場合

  • 単一のデータ・オブジェクトがエクスポートされる場合

-dependencies [0|1]

レポートおよびデータ・オブジェクトに対して適用されます。

レポート: 指定されているレポートが依存しているレポートがエクスポートされるかどうかを制御します。

Icommandでは、指定されているレポートが他のレポートに依存しているかどうかが自動的に判別され、それらが自動的にエクスポートされます。1つ以上の依存レポートが最初にエクスポートされ、その後にコマンドで指定されているレポートが続きます。

レポート・ファイルをインポートする場合、すべての依存レポートが最初にインポートされ、その後に、エクスポートするように選択したレポートが続きます。このパラメータの使用方法の例は、例G-22「関連する依存レポートとともにレポートをエクスポートする」を参照してください。

データ・オブジェクト: エクスポート対象のデータ・オブジェクトが依存する他のデータ・オブジェクトが参照列にある場合、それらをエクスポートするかどうかを制御します。

ゼロ以外の値の場合または値を指定せずにパラメータのみが指定されている場合は、レポートまたはデータ・オブジェクトの依存関係がエクスポートされます。このパラメータを省略すると、0(ゼロ)が使用されます。

-file file_name

エクスポート先のファイルの名前。必須です。

このファイルが存在しない場合は作成されます。このファイルが存在する場合は、appendパラメータを使用しないかぎり、コンテンツは上書きされます。このファイルにはXMLが含まれるため、通常XML拡張子が使用されます。

-footer [0|1]

XMLの終了情報をエクスポート・ファイルの最後に書き込むかどうかを制御します。これを使用すると、ICommandを連続実行して、同じファイルに繰り返し追加を行うことで1つのXMLファイルをアセンブルできます。

0(ゼロ)以外の値を指定すると、終了情報に書込みが行われます。0(ゼロ)を指定すると、終了情報に書込みは行われません。このパラメータを省略するか値を省略すると、0(ゼロ)以外の値が使用されます。

appendパラメータと併用する場合は、フッター値を適切に設定する必要があります。適切に設定しないと、そのファイルはICommandインポートで使用できません。フッターが定義されていないと、各appendに</OracleBAMExport>終了タグが含まれ、最初の終了タグが読み取られた時点でインポートが停止し、このファイルに定義されている残りのオブジェクトはインポートされません。

このパラメータを使用したサンプルについては、例G-23「エクスポートでのappendパラメータの使用」を参照してください。

-header [0|1]

XMLヘッダー情報をエクスポート・ファイルの先頭に書き込むかどうかを制御します。これを使用すると、ICommandを連続実行して、同じファイルに繰り返し追加を行うことで1つのXMLファイルをアセンブルできます。

0(ゼロ)以外の値を指定すると、ヘッダーに書込みが行われます。0(ゼロ)を指定すると、ヘッダーに書込みは行われません。このパラメータを省略するか値を省略すると、0(ゼロ)以外の値が使用されます。

このパラメータを使用したサンプルについては、例G-23「エクスポートでのappendパラメータの使用」を参照してください。

-layout [0|1]

データ・オブジェクトに対してのみ適用されます。レイアウト情報をエクスポートするかどうかを制御します。

0(ゼロ)以外の値を指定すると、レイアウト情報がエクスポートされます。0(ゼロ)を指定すると、レイアウト情報はエクスポートされません。このパラメータを省略するか、または値を省略すると、0(ゼロ)以外の値が使用されます。

-match pattern

アスタリスク(*)および疑問符(?)を使用するDOS形式のパターン一致文字列。名前がパターンと一致するアイテムがエクスポートされます(例G-21「一致パラメータを使用したデータ・オブジェクトのエクスポート」を参照)。

-name itemname

エクスポートするアイテムの名前。

-owner [0|1]

フォルダ、レポートおよびルールに対してのみ適用されます。エクスポート対象のアイテムの所有者に関する情報をエクスポートに含めるかどうかを制御します。

0(ゼロ)以外の値を指定すると、所有者情報がエクスポートされます。0(ゼロ)を指定すると、所有者情報はエクスポートされません。このパラメータを省略するか値を省略すると、0(ゼロ)以外の値が使用されます。

-permissions [0|1]

データ・オブジェクトおよびフォルダに対してのみ適用されます。権限情報をエクスポートするかどうかを制御します。

0(ゼロ)以外の値を指定すると、エクスポート対象のデータ・オブジェクトまたはフォルダの権限設定に関する情報がエクスポートされます。0(ゼロ)を指定すると、権限に関する情報はエクスポートされません。このパラメータを省略するか、または値を省略すると、0(ゼロ)が使用されます。

データ・オブジェクトの場合は、データ・オブジェクト自体の権限のみがエクスポートされます。データ・オブジェクトが含まれているフォルダまたはサブフォルダに対する権限は含まれません。

フォルダの場合は、対象となる権限に、エクスポート対象のフォルダのすべての親フォルダの累積権限が反映されます。

-preview [0|1]

previewモードでICommandを実行すると、指定したすべてのアイテムがエクスポートされますが、実際に情報は出力されません。このモードを使用すると、指定したコマンドラインでエクスポートされる情報および発生する可能性があるエラーを確認できます。このモードの場合、preview以外のモードではエクスポートが停止するようなエラーが発生した後も、ICommand exportの処理は続行されます。

0(ゼロ)以外の値を指定すると、previewモードになります。この値を省略すると、0(ゼロ)以外の値が使用されます。パラメータを省略すると、0(ゼロ)が使用されます。

-regex regularexpr

正規表現パターン一致文字列。名前がパターンと一致するアイテムがエクスポートされます。詳細は、G.6項「正規表現」を参照してください。

-systemobjects [0|1]

allmatchまたはregexパラメータを使用した場合にシステム・フォルダ内のデータ・オブジェクトが含まれるかどうかを制御します。0(ゼロ)を指定すると、データ・オブジェクトは含まれません。このパラメータを省略すると、0(ゼロ)が使用されます。

-type itemtype

エクスポートするアイテムのタイプ。次の値が有効です。

このパラメータを省略すると、dataobjectが使用されます。


例G-7 データ・オブジェクトのフォルダ内へのエクスポート

icommand -cmd export -name "/Samples/Call Center" -file "C:\CallCenter.xml"

typeパラメータはこの例に含まれていないことに注意してください。デフォルトでは、指定がない場合typeにはdataobjectが割り当てられます。

例G-8 データ・オブジェクトのルートへのエクスポート

icommand -cmd export -name TestDataObject -file "C:\TestDataObject.xml"

データ・オブジェクト名の前にスラッシュ(/)がないことに注意してください。データ・オブジェクトがルートのData Objectsフォルダにある場合、スラッシュは必要ありません。

例G-9 マイ・レポートからフォルダをエクスポート

最初のケースの場合、フォルダをエクスポートしているユーザーがフォルダの所有者ではないため、nameパラメータにprivate:owner/Report接頭辞が使用されます。

icommand -cmd export -name "/private:bamadmin/Report/TestMainFolder/TestSubFolder"
 -type folder -file C:\FolderExportTest.xml

2番目のケースの場合、フォルダをエクスポートしているユーザーがフォルダの所有者であるため、nameパラメータにprivate:owner/Report接頭辞は使用されません。

icommand -cmd export -name "/TestMainFolder/TestSubFolder" -type folder -file
 C:\FolderExportTest.xml

例G-10 共有レポートからフォルダをエクスポート

icommand -cmd export -name "/public/Report/MainFolderInShared" -type folder -file
 C:\FolderExportTest2.xml

public接頭辞がnameパラメータに追加されていることに注意してください。

例G-11 データ・オブジェクトからフォルダをエクスポート

icommand -cmd export -name "/public/DataObject/Test Sub folder" -type folder -file
 C:\foldertest1.xml

例G-12 プライベート・レポートのエクスポート

例G-9にあるように、プライベート・レポートのエクスポート方法は2種類あります。

icommand -cmd export -name "/private:bamadmin/Report/MyReport" -type report -file C:\MyReport.xml

icommand -cmd export -name MyReport -type report -file C:\MyReport.xml

例G-13 共有レポートのエクスポート

icommand -cmd export -name "/public/Report/SharedReport" -type report -file C:\SharedReport.xml

例G-14 システム内のすべてのレポートのエクスポート

icommand -cmd export -type report -all -file C:\temp\TestAll.xml

例G-15 アラート・ルールのエクスポート

icommand -cmd export -name Alert1 -type rule -file C:\Alert1.xml

例G-16 セキュリティ・フィルタのエクスポート

icommand -cmd export -type securityfilters -name "TestDO" -file "C:\TestFilter.xml"

nameパラメータでは、セキュリティ・フィルタの名前ではなくデータ・オブジェクトの名前が指定されていることに注意してください。

例G-17 ディストリビューション・リストのエクスポート

icommand -cmd export -name MyDistList -type distributionlist -file C:\MyDistList.xml

例G-18 エンタープライズ・メッセージ・ソースのエクスポート

icommand -cmd export -type ems -name TestEMS -file C:\TestEMS.xml

例G-19 外部データ・ソースのエクスポート

icommand -cmd export -type eds -name TestEDS -file C:\TestEDS.xml

例G-20 システム内のすべてのOracle BAMオブジェクトのエクスポート

icommand -cmd export -type all -file C:\temp\TestAll.xml

例G-21 一致パラメータを使用したデータ・オブジェクトのエクスポート

icommand -cmd export -match "/M*" -file "c:/exportDOstartingwithM.xml"

例G-22 関連する依存レポートとともにレポートをエクスポートする

icommand -cmd export -type report -name Report1 -dependencies 1 -file Report1.xml

依存レポートは自動的に判別され、最初にエクスポートされます。それらは、指定したレポートをインポートするときに、再びインポートされます。

例G-23 エクスポートでのappendパラメータの使用

最初のケース(不適切な例)では、appendをヘッダー・パラメータとフッター・パラメータを設定せずに使用しています(デフォルトでは、ヘッダーとフッターは1に設定されます)。

icommand -cmd export -type dataobject -name "/Samples/Call Center" -file do.xml
icommand -cmd export -type dataobject -name "/Samples/Employees" -file do.xml -append
icommand -cmd export -type dataobject -name "/Samples/Film Sales" -file do.xml  -append

これらのコマンドからの出力を次に示します。ファイルへの各appendごとに、XMLヘッダー・タグと終了タグが含まれていることに注意してください。データをOracle BAMにインポートするためにこのファイルを使用すると、最初のオブジェクトのみがインポートされます。4行目にある最初の</OracleBAMExport>が読み取られると、インポートは停止します。

<?xml version="1.0"?>
<OracleBAMExport Version="2020">
  <exported object/>
</OracleBAMExport>
<?xml version="1.0"?>
<OracleBAMExport Version="2020">
  <exported object/>
</OracleBAMExport>
<?xml version="1.0"?>
<OracleBAMExport Version="2020">
  <exported object/>
</OracleBAMExport>

2番目のケース(適切な例)では、必要な出力を生成するために、ヘッダー・パラメータとフッター・パラメータが指定されています。

icommand -cmd export -type dataobject -name "/Samples/Call Center" -file do2.xml
 -header 1 -footer 0
 //only the footer is supressed in the first command
icommand -cmd export -type dataobject -name "/Samples/Employees" -file do2.xml
 -append 1 -header 0 -footer 0
 //both the header and the footer are suppressed in the intermediate commands
icommand -cmd export -type dataobject -name "/Samples/Film Sales" -file do2.xml
 -append 1 -header 0 -footer 1
 //only the header is suppressed in the last commands

これらのコマンドによって生成された出力ファイルによって、オブジェクトをOracle BAMサーバーにインポートできます。

<?xml version="1.0"?>
<OracleBAMExport Version="2020">
  <exported object>
  <exported object>
</OracleBAMExport>

G.2.4 import

XMLファイルからの情報をアクティブ・データ・キャッシュのオブジェクトにインポートします。このオブジェクトは、作成、置換または更新できます。

このオブジェクトが存在しない場合、可能であれば作成されます。データ・オブジェクトの場合、入力ファイルには、データ・オブジェクトを作成するためにレイアウト情報を含める必要があります。また、このファイルにコンテンツ情報が含まれていない場合は、空のデータ・オブジェクトが作成されます。

ICommandを実行しているユーザーが管理者でない場合、レポートは、ICommandを実行しているユーザーのプライベート・フォルダに常にインポートされます。インポート・ファイル内のパス情報が、ICommandを実行しているユーザーの既存のプライベート・フォルダと完全に一致する場合、インポートされたファイルはその場所に格納されます。そうでない場合は、ユーザーのプライベート・フォルダのルートに格納されます。

ICommandを実行しているユーザーが管理者の場合は、preserveownerオプションを使用すると、フォルダ、レポートおよびルールをそれらの元の場所に元の所有権のままでインポートできることがあります。

表G-5 importコマンドのパラメータ

パラメータ 説明

-continueonerror [0|1]

ファイルからオブジェクトをインポートする際、デフォルトでは、ICommandはエラーが起きるたびに停止します。複数のオブジェクトをインポートしている際にそのうちの1つにエラーが見つかっても停止しないようにするには、コマンドで指定したオブジェクトの残りのインポートを継続するようにcontinueonerrorパラメータを使用します。

エラーを無視して他のオブジェクトのインポートを継続する場合は1を指定します(例G-24を参照)。

-delay millisec

データ・オブジェクトに対してのみ適用されます。行の挿入または行の更新を行ってから次の行の挿入または行の更新を行うまでの遅延を指定する値。

これを使用すると、指定した速度でアクティブ・データをシミュレートできます。

この数値は、次の行に対して処理を行うまで待機する時間(ミリ秒)です。0(ゼロ)より大きい必要があります。

このパラメータを省略すると、遅延は発生しません。

例G-24「遅延を伴うデータ・オブジェクトのインポート」を参照してください。

-file file_name

インポート元のファイルの名前。必須です。通常、これは、exportコマンドで作成されたファイルです。

-preserveowner

フォルダ、レポートおよびルールに対してのみ適用されます。アイテムのインポート時に、アイテムの所有権をインポート・ファイルに指定されているとおりに設定するかどうかを制御します。

この所有権の設定は、エクスポート時に所有権がファイルに付与されていた場合およびICommandを実行しているユーザーが管理者の場合にのみ行うことができます。

0(ゼロ)以外の値を指定すると、インポート・ファイルに指定されているとおりに所有権が設定されます。0(ゼロ)は、ICommandを実行しているユーザーがインポートしたアイテムを所有していることを意味します。このパラメータを省略するか、または値を省略すると、0(ゼロ)が使用されます。

-preview [0|1]

previewモードでICommandを実行すると、指定したすべてのアイテムがインポートされますが、実際に情報は入力されません。このモードを使用すると、指定したコマンドラインでインポートされる情報および発生する可能性があるエラーを確認できます。このモードでは、preview以外のモードではインポートが停止するようなエラーが発生した後も、ICommand importの処理は続行されます。

0(ゼロ)以外の値を指定すると、previewモードになります。この値を省略すると、0(ゼロ)以外の値が使用されます。パラメータを省略すると、0(ゼロ)が使用されます。

このパラメータは、ルール、ディストリビューション・リスト、EDS、EMS、レポート、フォルダおよびセキュリティ・フィルタの各オブジェクトに対してサポートされます。

例G-25「プレビュー・モードでのレポートのインポート」を参照してください。

-mode mode

デフォルトでは、モード・パラメータの指定がない場合、タイプがフォルダ、レポート、EDS、EMSおよびディストリビューション・リストのオブジェクトに対してerrorの値が使用されます。

次のモード値は、フォルダ、レポート、EMSおよびEDSの各オブジェクトに対して有効です。

  • overwrite

    アイテムが存在している場合は、インポートしたアイテムに置換されます。

  • rename

    アイテムが存在している場合は、インポートしたアイテムの名前が変更されます。新しい名前は、自動的に計算され、メッセージでレポートされます。

  • error

    アイテムが存在している場合はインポートが終了し、エラーが戻されます。

次の値は、ディストリビューション・リスト・オブジェクトに対して有効です。

  • overwrite

    アイテムが存在している場合は、インポートしたアイテムに置換されます。

  • rename

    アイテムが存在している場合は、インポートしたアイテムの名前が変更されます。新しい名前は、自動的に計算され、メッセージでレポートされます。

  • append

    アイテムが存在している場合は、インポートしたリスト内のユーザーが既存のリストに追加されます。

  • error

    アイテムが存在している場合はインポートが終了し、エラーが戻されます。

データ・オブジェクトまたはレポートに対しては、次の値がサポートされています。

  • preserveid

    このオプションは重要です。レポートなどの他の一部のアイテムでは、使用されるオブジェクトが名前ではなくIDで示されるためです。

    データ・オブジェクトの使用:

    インポートしたデータ・オブジェクトが存在しないため、それらを作成する必要がある場合は、ICommandによって、エクスポートしたデータ・オブジェクトに含まれている内部IDと同じ内部IDがデータ・オブジェクトに割り当てられます。これが不可能な場合はインポートが終了し、エラーが戻されます。

    レポートの使用:

    インポートしたレポートが存在しないため、それらを作成する必要がある場合は、ICommandによって、エクスポートしたレポートに含まれている内部IDと同じ内部IDがレポートに割り当てられます。これが不可能な場合はインポートが終了し、エラーが戻されます。

-mode mode(続き)

次の値は、データ・オブジェクトに対してのみ有効です。

  • update

    通常、ICommandでデータ・オブジェクトをインポートすると、新しいデータ・オブジェクトが作成されるか、または既存のデータ・オブジェクトが検索され、インポートした行がそのデータ・オブジェクトに挿入されます。

    updateモードでは、かわりに、既存の一致する行が行IDで検索され、それらの既存の行がインポート・ファイル内の値で更新されます。一致しない行は挿入されます。インポート・ファイル内の一致する行IDにデータ列が指定されていない場合、その行は既存のデータ・オブジェクトから削除されます。

セキュリティ・フィルタの場合、サポートされている値はoverwriteのみです。データ・オブジェクトに1つ以上のセキュリティ・フィルタが含まれている場合は、overwriteを指定しないとインポートが終了し、エラーが戻されます。

このパラメータは、ルールに対してはサポートされていません。

-setcol

インポート時にコマンドラインから列値のオーバーライド(現在の日時への設定など)を実行できます。

-setcol column_name/NULL

-setcol column_name/NOW

-setcol column_name/VALUE:override-value

column_nameは、インポート対象データ・オブジェクト内の列の名前です。検索型または計算型の列は指定できません。インポート対象の入力XMLに含まれていない列名は、インポート先のデータ・オブジェクト内の列である場合に指定できます。スラッシュの後の部分によって、インポートする各行上の該当する列のかわりに使用される値を指定します。この場合、インポート・ファイル内の該当する列のすべての値が無視(オーバーライド)されます。スラッシュは列名に使用できない文字の1つであるため、この構文の列名で競合が発生する可能性はありません。

NULLによって、列値がNULLに設定されるように指定します。この列は、データ・オブジェクトのレイアウトでNULL値可能と定義されている必要があります。

NOWによって、列値が行に設定された日時に、列値が設定されるように指定します。このオプションは、日時型、タイムスタンプ型および文字列型の列に対してのみ使用できます。

VALUE:override-valueによって、列に設定される任意の定数値を(コロンの後に)指定します。この値は、列の型に対して有効な値である必要があります。複数の列をオーバーライド可能にするために、多数のsetcolパラメータが存在する場合があります。ただし、パラメータの重複は許容されないため、ICommandでは、setcolで始まるすべてのパラメータ名(setcol1setcol2など)がsetcolパラメータとして認識されます。次にサンプル・コマンドラインを示します。

icommand -cmd import -file myfile.xml -setcol1 Field1/null -setcol2 Field3/now -setcol3 "Customer Name/value:John Q. Public"

-updatelayout

データ・オブジェクトに対してのみ適用されます。インポート対象のデータ・オブジェクトが存在する場合にそのデータ・オブジェクトのレイアウト(スキーマ)を、インポート・ファイル内のレイアウト情報に従って更新するかどうかを制御します。

パラメータが存在する場合はtrueで、存在しない場合はfalseです。


例G-24 遅延を伴うデータ・オブジェクトのインポート

icommand -cmd import -file C:\TestDO.xml -delay 1000 -continueonerror 1

例G-25 プレビュー・モードでのレポートのインポート

icommand -cmd import -file C:\TestReport.xml -preview 1

G.2.5 rename

アクティブ・データ・キャッシュにあるアイテムの名前を変更します。

表G-6 renameコマンドのパラメータ

パラメータ 説明

-name itemname

名前を変更するアイテムの名前。必須です。

フォルダ・タイプのオブジェクトの名前を変更する場合は、フォルダのフルパスを指定する必要があります(例G-27「フォルダの名前の変更」を参照)。

-newname newitemname

アイテムの新しい名前。必須です。

フォルダ・タイプのオブジェクトの名前を変更する場合は、フォルダのフルパスを指定する必要があります(例G-27「フォルダの名前の変更」を参照)。

データ・オブジェクトおよびレポートの場合は、新しいベース名のみをパスなしで指定する必要があります(たとえば、-newname "MyReport"などです)。

-type itemtype

名前を変更するオブジェクトのタイプ。次の値が有効です。

  • dataobject(例G-26を参照)

  • folder(例G-27を参照)

  • report (例G-28を参照)

  • rule

  • distributionlist(例G-29を参照)

  • ems(エンタープライズ・メッセージ・ソース)

  • eds(外部データ・ソース)

このパラメータを省略すると、dataobjectが使用されます。allは、renameコマンドのアイテム・タイプとしてサポートされていません。


例G-26 フォルダ内のデータ・オブジェクトの名前の変更

icommand -cmd rename -type dataobject -name "/TestDataObjectFolder/TestDataObject"
 -newname NewTestDataObject

例G-27 フォルダの名前の変更

データ・オブジェクト・フォルダの名前の変更

icommand -cmd rename -type folder -name "/public/DataObject/TestFolder"
 -newname "/public/DataObject/NewTestFolder"

プライベート・レポート・フォルダの名前の変更

icommand -cmd rename -type folder -name "/private:weblogic/Report/MySubFolder"
 -newname "/private:weblogic/Report/NewMySubFolder"

共有レポート・フォルダの名前の変更

icommand -cmd rename -type folder -name "/public/Report/TestSubFolder" 
-newname "/public/Report/NewTestSubFolder"

例G-28 プライベート・フォルダ内のレポートの名前の変更

icommand -cmd rename -type report -name "/TestReportFolder/TestReport" -newname
 NewTestReport

例G-29 ディストリビューション・リストの名前の変更

icommand -cmd rename -type distributionlist -name TestList -newname MyDistList

例G-30 アラート・ルールの名前の変更

ICommand操作でアラートが発生する場合、typeパラメータの値はruleです。このコマンドで、MyAlertというルールの名前を削除します。

icommand -cmd rename -type rule -name "MyAlert" -newname "MyRenamedAlert"

G.3 コマンド・ファイルのフォーマット

この項のトピックは、次のとおりです。

コマンド・ファイルには、ルート・タグOracleBAMCommandsが含まれています。

ルート・タグ内には、すべてのコマンドを実行するタグがあります。タグ名はコマンド名です。また、コマンドのパラメータは属性です。

サンプル・コマンド・ファイル

<?xml version="1.0" encoding="utf-8"?>
<OracleBAMCommands continueonerror="1">
  <Export name="Samples/Media Sales" file="MediaSales.xml" contents="0" />
  <Rename name="Samples/Call Center" newname="Call Centre" />
  <Delete type="EMS" name="WebLog" />
  <Delete type="EMS" name="WebLog2" />
</OracleBAMCommands>

このサンプル・コマンド・ファイルの出力は、G.4項「ログ・ファイルのフォーマット」を参照してください。

G.3.1 インライン・コンテンツ

コマンド・ファイルを使用してインポートする場合、inlineオプションを使用するとインポートするコンテンツを、別のインポート・ファイル内ではなくコマンド・ファイル内に含めることができます。次に例を示します。

<?xml version="1.0"?>
<OracleBAMCommands>
<Import inline="1">
<OracleBAMExport Version="2013">
  <DataObject Version="14" Name="Employees_Inline" ID="_Employees_Inline"
    Path="/Samples" External="0">
    <Layout>
      <Column Name="Salesperson" ID="_Salesperson" Type="string" MaxSize="100"
        Nullable="1" Public="1"/>
      <Column Name="Sales Area" ID="_Sales_Area" Type="string" MaxSize="100"
        Nullable="1" Public="1"/>
      <Column Name="Sales Number" ID="_Sales_Number" Type="integer"
        Nullable="1" Public="1"/>
      <Column Name="Timestamp" ID="_Timestamp" Type="timestamp" Nullable="0"
        Public="1"/>
      <Indexes/>
    </Layout>
    <Contents>
      <Row ID="1">
        <Column ID="_Salesperson" Value="Greg Masters"/>
        <Column ID="_Sales_Area" Value="Northeast"/>
        <Column ID="_Sales_Number" Value="567"/>
        <Column ID="_Timestamp" Value="2004-09-14T14:07:41.0000560PDT"/>
      </Row>
      <Row ID="2">
        <Column ID="_Salesperson" Value="Lynette Jones"/>
        <Column ID="_Sales_Area" Value="Southwest"/>
        <Column ID="_Sales_Number" Value="228"/>
        <Column ID="_Timestamp" Value="2004-09-14T14:07:41.0000560PDT"/>
      </Row>
      <Row ID="3">
        <Column ID="_Salesperson" Value="Noel Rogers"/>
        <Column ID="_Sales_Area" Value="Northwest"/>
        <Column ID="_Sales_Number" Value="459"/>
        <Column ID="_Timestamp" Value="2004-09-14T14:07:41.0000560PDT"/>
      </Row>
    </Contents>
  </DataObject>
</OracleBAMExport>
</Import>
</OracleBAMCommands>

G.3.2 コマンドID

この機能は、出力をログ・ファイルに送信する場合にのみ使用されます。ログ結果の解析を簡単にするために、各コマンドにIDを指定できます。このIDは、該当するコマンドに関連する出力の結果要素またはエラー要素に含まれます。

入力例

<OracleBAMCommands continueonerror="1">
  <Delete id="1" type="dataobject" name="Data Object A"/>
  <Delete id="2" type="dataobject" name="Data Object B"/>
</OracleBAMCommands>

出力ログ・ファイル例

<?xml version="1.0"?>
<ICommandLog Login="weblogic">
  <Results Command="Delete" ID="1">Data Object &quot;/Data Object A&quot;
 deleted.</Results>
  <Error Command="Delete" ID="2">
    <![CDATA[BAM-02409: There is no Data Object named "Data Object B".
    [ErrorSource="ICommandEngine",ErrorID="ICommandEngine.DOExist"]]]>
  </Error>
</ICommandLog>

G.3.3 エラー時も続行

通常、ICommandでは、障害が発生するまで、またはすべてのコマンドが正常に完了するまでコマンド・ファイル内のコマンドが実行されます。つまり、コマンド・ファイルに20のコマンドが含まれていて、2つ目のコマンドで障害が発生した場合、それ以降のコマンドは実行されません。continueonerror属性をグローバル・レベルで使用するか、または各コマンドに対して使用することによって、この動作を変更できます。

例G-31に、continueonerror属性を使用して、障害が発生したかどうかに関係なくすべてのコマンドを実行する方法を示します。

例G-31 グローバル・レベルでのContinueOnErrorモードの有効化

<OracleBAMCommands  continueonerror="1">
  <Delete id="1" type="dataobject" name="Data Object A"/>
  <Delete id="2" type="dataobject" name="Data Object B"/>
</OracleBAMCommands>

例G-32で、continueonerrorが適用されているのは、データ・オブジェクトAを削除するコマンドのみです。このコマンドが失敗した場合、ICommandはエラーを出力して処理を続行します。しかし、他のコマンドが失敗した場合、ICommandはただちに停止します。

例G-32 コマンド・レベルでのContinueOnErrorモードの有効化

<OracleBAMCommands>
  <Delete id="1" type="dataobject" name="Data Object A" continueonerror="1"/>
  <Delete id="2" type="dataobject" name="Data Object B"/>
  <Delete id="3" type="dataobject" name="Data Object C"/>
  <Delete id="4" type="dataobject" name="Data Object D"/>
</OracleBAMCommands>

G.4 ログ・ファイルのフォーマット

ログ・ファイルには、ルート・タグICommandLogが含まれています。

ルート・タグ内には、記録されたすべてのエラー・メッセージまたは情報メッセージのエントリがあります。

エラーは、Errorタグ付きで記録されます。

情報メッセージは、Resultsタグ付きで記録されます。

ResultsErrorの両方のタグには、必要に応じてCommand=cmdnameという形式の属性が含まれます。この属性には、エラー・メッセージまたは情報メッセージを生成したコマンドの名前が含まれます。

このサンプル・ログ・ファイルは、G.3項「コマンド・ファイルのフォーマット」で指定したコマンド・ファイルの出力です。

<?xml version="1.0" encoding="utf-8"?>
<ICommandLog Login="user_name">
  <Results Command="Export">Data Object "/Samples/Media Sales" exported
 successfully (0 rows).</Results>
  <Results Command="Export">1 items exported successfully.</Results>
  <Results Command="Rename">Data Object "/Samples/Call Center" renamed to
 "/Samples/Call Centre".</Results>
  <Results Command="Delete">Enterprise Message Source "WebLog" deleted.</Results>
  <Error Command="Delete"><![CDATA[Error while processing command "Delete".
 [ErrorSource="ICommand", ErrorID="ICommand.Error"] There is no Enterprise Message
 Source named "WebLog2". [ErrorSource="ICommand",
 ErrorID="ICommand.EMSExist"]]]></Error>
</ICommandLog>

G.5 サンプル・エクスポート・ファイル

次の例は、データ・オブジェクトをエクスポートした結果生じたサンプル・ファイルを示しています。

<?xml version="1.0"?>
<OracleBAMExport Version="2018">
  <DataObject Version="14" Name="Employees" ID="_Employees" Path="/Samples"
 External="0">
    <Layout>
      <Column Name="Salesperson" ID="_Salesperson" Type="string" MaxSize="100"
 Nullable="1" Public="1"/>
      <Column Name="Sales Area" ID="_Sales_Area" Type="string" MaxSize="100"
 Nullable="1" Public="1"/>
      <Column Name="Sales Number" ID="_Sales_Number" Type="integer" Nullable="1"
 Public="1"/>
      <Column Name="Timestamp" ID="_Timestamp" Type="timestamp" Nullable="0"
 Public="1"/>
      <Indexes/>
    </Layout>
    <Contents>
      <Row ID="1">
        <Column ID="_Salesperson" Value="Greg Masters"/>
        <Column ID="_Sales_Area" Value="Northeast"/>
        <Column ID="_Sales_Number" Value="567"/>
        <Column ID="_Timestamp" Value="2004-09-14T14:07:41.0000560PDT"/>
      </Row>
      <Row ID="2">
        <Column ID="_Salesperson" Value="Lynette Jones"/>
        <Column ID="_Sales_Area" Value="Southwest"/>
        <Column ID="_Sales_Number" Value="228"/>
        <Column ID="_Timestamp" Value="2004-09-14T14:07:41.0000560PDT"/>
      </Row>
      <Row ID="3">
        <Column ID="_Salesperson" Value="Noel Rogers"/>
        <Column ID="_Sales_Area" Value="Northwest"/>
        <Column ID="_Sales_Number" Value="459"/>
        <Column ID="_Timestamp" Value="2004-09-14T14:07:41.0000560PDT"/>
      </Row>
    </Contents>
  </DataObject>
</OracleBAMExport>

G.6 正規表現

exportコマンドとdeleteコマンドでは、必要に応じてregexパラメータ付きの正規表現が使用されます。

正規表現は、通常の文字(たとえば、aからzの英字)と、メタ文字と呼ばれる特殊文字で構成されるテキストのパターンです。このパターンによって、アイテムを名前で検索するときに一致する1つ以上の文字列を表します。


注意:

ICommandの-regexの動作は、文字シーケンスを正規表現で指定したパターンと照合するためのjava.util.regexパッケージと同じです。


表G-7に、メタ文字の完全なリストおよび正規表現におけるメタ文字の動作を示します。

表G-7 正規表現で使用するメタ文字

文字 説明

\


次に続く文字が特殊文字、リテラル、前方参照または8進エスケープであることを示します。たとえば、「n」は文字「n」と一致します。「\\」は「\」と一致し、「\(」は「(」と一致します。

^

入力文字列の先頭と一致します。RegExpオブジェクトのMultilineプロパティが設定されている場合は、「\n」または「\r」の直後とも一致します。

$


入力文字列の末尾と一致します。RegExpオブジェクトのMultilineプロパティが設定されている場合は、「\n」または「\r」の直前とも一致します。

*


直前の文字または部分式と0回以上一致します。たとえば、「zo*」は「z」と「zoo」のどちらにも一致します。「*」は「{0,}」と同じ意味です。

+


直前の文字または部分式と1回以上一致します。たとえば、「zo+」は「zo」や「zoo」とは一致しますが、「z」とは一致しません。「+」は「{1,}」と同じ意味です。

?

直前の文字または部分式と0回または1回一致します。たとえば、「do(es)?」は「do」または「does」の「do」と一致します。「?」は「{0,1}」と同じ意味です。

{n}

nには、0以上の整数を指定します。直前の文字と正確にn回一致します。たとえば、「o{2}」は「Bob」の「o」とは一致しませんが、「food」の2つの「o」とは一致します。

{n,}

nには、0以上の整数を指定します。直前の文字とn回以上一致します。たとえば、「o{2,}」は「Bob」のoとは一致しませんが、「foooood」のすべての「o」とは一致します。「o{1,}」は「o+」と同じ意味です。「o{0,}」は「o*」と同じ意味です。

{n,m}

mおよびnには0以上の整数を指定します。n <= mです。nからm回一致します。たとえば、「o{1,3}」は「fooooood」の最初の3つの「o」と一致します。「o{0,1}」は「o?」と同じ意味です。カンマと数の間には空白を入れません。

?

他の量指定子(*、+、?、{n}、{n,}、{n,m})の直後に指定すると、一致パターンが最短一致になります。デフォルトの最長一致パターンでは、できるだけ多くの文字列と一致しますが、最短一致パターンでは、できるだけ少ない文字列と一致します。たとえば、文字列「oooo」に対して、「o+?」を指定すると1つの「o」と一致し、「o+」を指定するとすべての「o」と一致します。

.

「\n」以外の任意の1文字に一致します。「\n」を含めて任意の文字と一致させるには、「[\s\S]」などのパターンを指定します。

(pattern)

patternと一致した文字列を保存する部分式。一致した文字列が見つかった場合は、Matchesコレクションから$0...$9プロパティを使用して取得できます。カッコ( )と一致させるには、「\(」または「\)」を指定します。

(?:pattern)

patternと一致しても、その文字列を保存しない部分式(後で使用するための保存は行わない非保存一致)。これは、「または」を意味する(|)を使用して、パターンの一部を結合するときに便利です。たとえば、「industr(?:y|ies)」と指定するより、「industry|industries」と指定する方が簡潔です。

(?=pattern)

肯定先読み検索を実行する部分式です。patternと一致する文字列が始まる位置にある検索文字列と一致します。これは、非保存一致で、一致した文字列は後で使用できません。たとえば、「Windows (?=95|98|NT|2000)」は「Windows 2000」の「Windows」には一致しますが、「Windows 3.1」の「Windows」には一致しません。先読み処理では、文字は検索対象ではありません。一致の検出後、次の検索処理は、先読みされた文字の後からではなく、一致文字列のすぐ後から開始されます。

(?!pattern)

否定先読み検索を実行する部分式です。patternに一致しない文字列が始まる位置にある検索文字列と一致します。これは、非保存一致で、一致した文字列は後で使用できません。たとえば、「Windows (?!95|98|NT|2000)」は「Windows 3.1」の「Windows」には一致しますが、「Windows 2000」の「Windows」には一致しません。先読み処理では、文字は検索対象ではありません。一致の検出後、次の検索処理は、先読みされた文字の後からではなく、一致文字列のすぐ後から開始されます。

x|y

xまたはyと一致します。たとえば、「z|food」は「z」または「food」と一致します。「(z|f)ood」は「zood」または「food」と一致します。

[xyz]

文字セットを指定します。大カッコで囲まれたいずれかの文字に一致します。たとえば、「[abc]」は「plain」の「a」と一致します。

[^xyz]

除外する文字セットを指定します。大カッコで囲まれた文字以外の文字に一致します。たとえば、「[^abc]」は「plain」の「p」に一致します。

[a-z]

文字の範囲を指定します。指定した範囲に含まれる任意の文字に一致します。たとえば、「[a-z]」はaからzの範囲にある任意の小文字と一致します。

[^a-z]

除外する文字の範囲を指定します。指定した範囲に含まれていない任意の文字と一致します。たとえば、「[^a-z]」はaからzの範囲外にある任意の文字と一致します。

\b

単語の境界と一致します。単語の境界とは、単語と空白との間の位置のことです。たとえば、「er\b」は「never」の「er」とは一致しますが、「verb」の「er」とは一致しません。

\B

単語の境界以外と一致します。たとえば、「er\B」は「verb」の「er」とは一致しますが、「never」の「er」とは一致しません。

\cx

xで指定した制御文字と一致します。たとえば、\cMはControl-Mまたは復帰改行文字と一致します。xの値は、AからZまたはaからzの範囲内で指定します。そうでない場合、cはリテラル文字の「c」と見なされます。

\d

任意の10進文字と一致します。[0-9]と同じ意味です。

\D

10進数字以外と一致します。[^0-9]と同じ意味です。

\f

フォーム・フィード文字と一致します。\x0cおよび\cLと同じ意味です。

\n

改行文字と一致します。\x0aおよび\cJと同じ意味です。

\r

復帰文字と一致します。\x0dおよび\cMと同じ意味です。

\s

空白、タブ、フォーム・フィードなどの任意の空白文字と一致します。[ \f\n\r\t\v]と同じ意味です。

\S

空白文字以外の任意の文字と一致します。[^ \f\n\r\t\v]と同じ意味です。

\t

タブ文字と一致します。\x09および\cIと同じ意味です。

\v

垂直タブ文字と一致します。\x0bおよび\cKと同じ意味です。

\w

単語に使用される任意の文字と一致します。アンダースコアも含まれます。[A-Za-z0-9_]と同じ意味です。

\W

単語に使用される文字以外の任意の文字と一致します。[^A-Za-z0-9_]と同じ意味です。

\xn

nと一致します。nには16進のエスケープ値を指定します。16進数のエスケープ値は2桁である必要があります。たとえば、「\x41」は「A」と一致します。「\x041」は「\x04」および「1」と同じ意味です。この表記によって、正規表現でASCIIコードを使用できるようになります。

\num

numと一致します。numには正の整数を指定します。すでに保存されている部分を参照します。たとえば、「(.)\1」は連続する2つの同じ文字と一致します。

\n

8進数のエスケープ値または前方参照を指定します。\nの前にn個以上の保存された部分式がある場合、nは前方参照になります。それ以外の場合でnが8進数(0から7)である場合、nは8進エスケープ値です。

\nm

8進数のエスケープ値または前方参照を指定します。\nmの前にnm個以上の保存された部分式がある場合、nmは前方参照になります。\nmの前にn個以上の保存された部分式がある場合、nが前方参照で、リテラルmが後に続きます。いずれの条件も当てはまらない場合でnおよびmが8進数(0から7)である場合、\nmは8進エスケープ値nmと一致します。

\nml

nが8進数値の0から3で、mおよびlが8進数(0から7)の場合は、8進エスケープ値nmlと一致します。

\un

nと一致します。nにはUnicode文字で表した4桁の16進数を指定します。たとえば、\u00A9は著作権記号(©)と一致します。