20 Oracle WebCenter Enterprise CaptureカスタムWLSTコマンド

この章では、Oracle WebCenter Enterprise Capture用のカスタムWLSTコマンド、およびそのコマンド構文、引数、コマンド例を詳細に説明します。

次以降の項では、Oracle WebCenter Enterprise CaptureのためのカスタムWLSTコマンドについて説明します。これらのコマンドを使用すると、コマンド・ラインからOracle WebCenter Enterprise Captureの様々な構成パラメータにアクセスおよび変更できます。次のトピックがあります。

• 20.1項「WLST Oracle WebCenter Enterprise Captureコマンド・カテゴリの概要」

• 20.2項「構成コマンド」

WLSTから呼び出すことができる、サポートされているすべてのCaptureコマンドを表示するには、WLSTプロンプトで次のコマンドを入力します。

help('capture')

Enterprise Captureワークスペース・コンソール使用の詳細は、Oracle Fusion Middleware Oracle WebCenter Enterprise Captureの管理を参照してください。

注意: Oracle WebCenter Enterprise Captureカスタム・コマンドを使用するには、コンポーネントがインストールされたOracle CommonホームからWLSTスクリプトを起動する必要があります。Oracle WebCenter CaptureアプリケーションがデプロイされたOracle WebLogic Server管理対象サーバー(デフォルト・ポート16400)に接続するか、Oracle WebLogic Server管理サーバーに接続し、コマンドdomainRuntime()を実行することによって、場所をdomainRuntimeに変更します。 Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

20.1 WLST Oracle WebCenter Enterprise Captureコマンド・カテゴリの概要

WLST Oracle WebCenter Enterprise Captureコマンドのカテゴリは、次のとおりです。

表20-1 WLST Oracle WebCenter Enterprise Captureコマンド・カテゴリ

コマンド・カテゴリ	説明
構成コマンド	Oracle WebCenter Enterprise Captureの構成を表示および管理します。

20.2 構成コマンド

表20-2のコマンドを使用して、Oracle WebCenter Enterprise Captureを構成します。

表20-2 WLSTサーバーOracle WebCenter Enterprise Capture構成コマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
listWorkspaces	管理者またはワークスペース管理者がアクセスできるすべてのCaptureワークスペースをリストします。	オンライン
listBatches	指定したワークスペース内にあるすべてのバッチをリストします。	オンライン
exportBatch	イメージとメタデータを含むバッチを、zipファイルにエクスポートします。	オンライン
exportWorkspace	ドキュメント、メタデータ、スクリプト、プロファイルおよびジョブを含むCaptureワークスペース全体を、XMLファイルにエクスポートします。	オンライン
importWorkspace	exportWorkspaceコマンドを使用して生成したXMLファイルからワークスペースをインポートします。	オンライン
unlockBatch	指定したバッチのバッチ・ロックに関するレコードを削除します。	オンライン
listLockedBatches	ロックされたバッチのリストを表示します。	オンライン
listCaptureConfig	すべてのEnterprise Capture構成の属性と値のリストを表示します。	オンライン
getCaptureConfig	引数として指定した属性の値をフェッチします。	オンライン
setCaptureConfig	Enterprise Capture属性の値を、入力した値に設定します。	オンライン
scanForClientBundles	クライアント・バンドル・ディレクトリの更新済バンドルをスキャンします。	オンライン
deleteBundle	既存のクライアント・バンドルを削除します。	オンライン
setObjectProperty	Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)で定義されたプロパティの値を設定します。	オンライン
getObjectProperty	Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)の特定のプロパティの値を出力します。	オンライン
setObjectCredentials	Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)に関連付けられるユーザー名とパスワードを設定します。	オンライン
updateScript	ワークスペース内でスクリプトを更新します。	オンライン

20.2.1 listWorkspaces

WLSTでの使用: オンライン。

20.2.1.1 説明

管理者または Captureワークスペース管理者がアクセスできるすべてのワークスペースをリストします。

20.2.1.2 構文

listWorkspaces()

20.2.1.3 例

次の例では、すべてのワークスペースをリストし、先頭にそれらのIDを付けます。

listWorkspaces()
4 bills_workspace
2 certificates_workspace
5 receipts_workspace

20.2.2 listBatches

WLSTでの使用: オンライン。

20.2.2.1 説明

IDによって指定されたワークスペースのすべてのバッチをリストします。リストされる各バッチには、「バッチID」、「バッチ名」、「作成者」(ユーザー)、「最終更新者」(ユーザー)および「最終更新」(日付)という5つの列(この順序で表示されます)が含まれます。

20.2.2.2 構文

listBatches (WORKSPACE_ID)

引数	定義
WORKSPACE_ID	ワークスペースのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。

20.2.2.3 例

次の例では、ワークスペースIDが3のバッチをリストします。

wls:/base_domain/domainRuntime> listBatches(1)
14 ABI1 <anonymous> <anonymous> 4/26/13
15 ABI2 <anonymous> <anonymous> 4/26/13
1 BCP11 captureuser <anonymous> 4/17/13

20.2.3 exportBatch

WLSTでの使用: オンライン。

20.2.3.1 説明

イメージとメタデータを含むバッチを、XMLファイルとバッチ・アイテム・ファイルを含むZIPファイルにエクスポートします。

20.2.3.2 構文

exportBatch(BATCH_ID,'FILE_NAME')

引数	定義
BATCH_ID	バッチのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のバッチに対して有効な引数です。
FILE_NAME	バッチのエクスポート先となるzipファイルの名前です。ファイル名は、その完全なパスとともに指定する必要があります。

注意: パスは、オペレーティング・システムに関係なく、スラッシュ「/」で区切ってください。

20.2.3.3 例

次の例では、バッチをエクスポートします。

exportBatch(8,'/home/abc/batch8.zip')
Batch successfully exported

20.2.4 exportWorkspace

WLSTでの使用: オンライン。

20.2.4.1 説明

ドキュメント、メタデータ、スクリプト、プロファイルおよびジョブを含むワークスペース全体を、XMLファイルにエクスポートします。

20.2.4.2 構文

exportWorkspace(WORKSPACE_ID,'FILE_NAME')

引数	定義
WORKSPACE_ID	ワークスペースのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。
FILE_NAME	ワークスペースのエクスポート先となるファイルの名前です。ファイル名は、その完全なパスとともに指定する必要があります。

注意: パスは、オペレーティング・システムに関係なく、スラッシュ「/」で区切ってください。

20.2.4.3 例

次の例では、IDが3のワークスペースをエクスポートします。

exportWorkspace(3,'/home/abc/workspace3.xml')
Workspace successfully exported

20.2.5 importWorkspace

WLSTでの使用: オンライン。

20.2.5.1 説明

exportWorkspaceコマンドを使用して生成したXMLファイルからワークスペースをインポートします。Oracle WebCenter Enterprise Captureデータベース内にあるワークスペースはインポートできません。

20.2.5.2 構文

importWorkspace('FILE_NAME')

引数	定義
FILE_NAME	ワークスペースのインポート元となるXMLファイルの名前です。ファイル名は、その完全なパスとともに指定する必要があります。

20.2.5.3 例

次の例では、名前がworkspace3.xmlのワークスペースをインポートします。

importWorkspace('/home/abc/workspace3.xml')
Workspace successfully imported

20.2.6 unlockBatch

WLSTでの使用: オンライン。

20.2.6.1 説明

指定したバッチのバッチ・ロックに関するレコードを削除します。バッチの状態がREADYになり、クライアントはそのバッチを開くことができます。

20.2.6.2 構文

unlockBatch('BATCH_ID')

引数	定義
BATCH_ID	バッチのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のバッチに対して有効な引数です。

20.2.6.3 例

次の例では、バッチID 8のロックを解除します。

unlockBatch('8')
Batch successfully unlocked

20.2.7 listLockedBatches

WLSTでの使用: オンライン。

20.2.7.1 説明

ロックされたバッチのリストを表示します。リストされる各バッチには、「ワークスペースID」、「バッチID」、「バッチ名」、「作成者」(ユーザー)、ワークステーション(名前/IPアドレス)および「最終更新」(日付)という6つの列(この順序で表示されます)が含まれます。

20.2.7.2 構文

listLockedBatches('WORKSPACE_ID')

引数	定義
WORKSPACE_ID	ワークスペースのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。

20.2.7.3 例

次の例では、ワークスペースIDが3のロックされたバッチをリストします。

wls:/base_domain/domainRuntime> listLockedBatches(1)
1 14 ABI1 <anonymous> sic01lzz.example.com 4/26/13
1 15 ABI2 <anonymous> slc01lzz.example.xom 4/26/13
1 17 BCP16 <captureuser> 10.159.104.189 4/30/13

20.2.8 listCaptureConfig

WLSTでの使用: オンライン。

20.2.8.1 説明

すべてのEnterprise Capture構成の属性と値のリストを表示します。値をフェッチできない場合、その値は「VALUE CANNOT BE DISPLAYED」と表示されます。値をフェッチできない最も可能性が高い原因は、権限が不十分であることです。

20.2.8.2 構文

listCaptureConfig()

20.2.8.3 例

次の例に、Enterprise Captureの構成の属性と値をリストします。

listCaptureConfig()
CaptureSystemID CAPTURE_01
BatchRefreshLimit 5

20.2.9 getCaptureConfig

WLSTでの使用: オンライン。

20.2.9.1 説明

引数として指定した属性の値をフェッチします。listCaptureConfigコマンドを使用して、可能な属性名をリストします。

20.2.9.2 構文

getCaptureConfig(['NAME_OF_ATTRIBUTE'])

引数	定義
NAME_OF_ATTRIBUTE	Enterprise Capture構成に対する属性の名前(文字列)です。

20.2.9.3 例

次の例では、Enterprise CaptureシステムIDに対する属性の値をフェッチします。

getCaptureConfig('CaptureSystemID')
CAPTURE_01

20.2.10 setCaptureConfig

WLSTでの使用: オンライン。

20.2.10.1 説明

Enterprise Capture属性の値を、入力した値に設定します。

20.2.10.2 構文

setCaptureConfig(['NAME_OF_ATTRIBUTE'],['VALUE_OF_ATTRIBUTE'])

引数	定義
NAME_OF_ATTRIBUTE	構成するEnterprise Captureの構成の属性名。
VALUE_OF_ATTRIBUTE	Enterprise Capture構成属性に設定する値です。

20.2.10.3 例

次の例では、CaptureSystemID属性を値CAPTURE_02に設定します。

setCaptureConfig('CaptureSystemID','CAPTURE_02')
Attribute 'CaptureSystemID' changed to "CAPTURE_02'

20.2.11 scanForClientBundles

WLSTでの使用: オンライン。

20.2.11.1 説明

クライアント・バンドル・ディレクトリのバンドルをスキャンします。既存のバンドルのデータが更新されるだけでなく、新しいバンドルの情報がロードされ、データベース内にキャッシュされます。

20.2.11.2 構文

scanForClientBundles()

20.2.11.3 例

次の例では、バンドルをスキャンし、処理済のバンドルをリストします。

scanForclientBundles()
Processed capture bundle.jar

20.2.12 deleteBundle

WLSTでの使用: オンライン。

20.2.12.1 説明

既存のバンドルを削除します。

20.2.12.2 構文

deleteBundle('bundlename')

引数	定義
bundlename	削除する既存のバンドルの名前です。

20.2.12.3 例

次の例では、指定したバンドルを削除します。

deleteBundle('Example')

20.2.13 setObjectProperty

WLSTでの使用: オンライン。

20.2.13.1 説明

Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)で定義されたプロパティの値を設定します。

各Captureオブジェクトに設定できるプロパティの詳細は、付録Aを参照してください。

20.2.13.2 構文

setObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_ASSIGNMENT_STRING>')

このコマンドに必要なパラメータは次のとおりです。

引数	定義
WORKSPACE_NAME	変更されるオブジェクトが含まれるCaptureワークスペースの名前。呼び出すユーザーが、複数のワークスペースに対して、指定された名前の権限を持っている場合、最初に検索されたワークスペースが使用されます。
CLASS_NAME	クライアント・プロファイル、プロセッサ・ジョブ、またはコミット・プロファイルを定義するクラスの名前。
OBJECT_IDENTIFIER	オブジェクトを見つけるために使用できるプロパティの名前と、そのプロパティの期待される値で構成されているキー/値ペア。
PROPERTY_ASSIGNMENT_STRING	更新するプロパティの名前と値を等号で区切ったもの。

20.2.13.3 注意点

次のリストに、setObjectPropertyコマンドを使用する場合の追加の注意点を示します。

• 変更可能なオブジェクトは、標準的なJavaBeanのゲッター/セッター・パターンを使用してプロパティを公開します。次の例では、メソッドgetProfileDescとsetProfileDescが、Profileクラス内に存在すると想定しています。

• プロパティに割り当てられる値は、プロパティのデータ型と互換性を持っている必要があります。プロパティのデータ型と互換性を持たない値の場合、例外が発生します。

• 有効なクラス名を次に示します。

  • oracle.oddc.data.Profile(変更されるCaptureオブジェクト: クライアント・プロファイル)

  • oracle.odc.recognition.RecognitionJob(変更されるCaptureオブジェクト: 認識プロセッサ・ジョブ)

  • oracle.odc.importprocessor.ImportJob(変更されるCaptureオブジェクト: インポート・プロセッサ・ジョブ)

  • oracle.odc.entity.CommitProfileEntity(変更されるCaptureオブジェクト: コミット・プロファイル)

  • oracle.odc.docconverter.DocConverterJob(変更されるCaptureオブジェクト: ドキュメント変換ジョブ)

• プロファイルまたはジョブ内でネストされたオブジェクト上に値を設定する必要がある場合、ネストされたプロパティにアクセスするために、「ドット」記法を使用できます。propertyName.propertyName=value

• 複数のネスト・レベルがサポートされます。認識プロセッサ・ジョブのdocTypeBarcodeプロパティのbarcodeNameプロパティを変更する場合、次を使用できます。docTypeBarcode.barcodeName=value

• コレクションに含まれるオブジェクトのプロパティへのアクセスをサポートする場合、次のように「山カッコ」記法を使用できます。propertyName<identifierPropertyName=value>.propertyName=value

  • 山カッコの内側の値は、変更するオブジェクトをコレクション内で見つけるために使用されます。identifierPropertyNameはコレクション内でオブジェクトを識別するために使用できるプロパティの名前で、値は、プロパティが一致とみなされる場合に含む値です。例: barcodes<barcodeName=barcode 1>.barcodeName=barcode 2.

20.2.13.4 例

• 次に示すのは、クライアント・プロファイルに適用される<オブジェクト識別子>の例です。

  profileName=Commit to CS
  

• 次に示すのは、クライアント・プロファイルのプロパティprofileDescを更新するための<プロパティ割当て文字列>の例です:

  profileDesc=Test Profile Desc
  

• 次に示すのは、Commit to CSという名のWebCenter Contentコミット・プロファイルに関連付けられたプロパティ<serverURL>を設定する例です。

  setObjectProperty('TEST_WORKSPACE','corporate.odc.entity.CommitProfileEntity','profileName=Commit to CS','serverURL=http://myhost.example.com:16200/cs/idcplg/')
  

20.2.14 getObjectProperty

WLSTでの使用: オンライン。

20.2.14.1 説明

Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)の特定のプロパティの値を出力します。

20.2.14.2 構文

getObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_NAME>')

このメソッドに必要なパラメータは次のとおりです。

引数	定義
WORKSPACE_NAME	変更されるオブジェクトが含まれるCaptureワークスペースの名前。呼び出すユーザーが、複数のワークスペースに対して、指定された名前の権限を持っている場合、最初に検索されたワークスペースが使用されます。
CLASS_NAME	クライアント・プロファイル、プロセッサ・ジョブ、またはコミット・プロファイルを定義するクラスの名前。
OBJECT_IDENTIFIER	オブジェクトを見つけるために使用できるプロパティの名前と、そのプロパティの期待される値で構成されているキー/値ペア。
PROPERTY_NAME	アクセスするプロパティの名前。setObjectPropertyに記述したドット記法と山カッコ記法を使用して、アクセスするプロパティを分離することができます。

注意: このコマンドに対するバッキングMBeanメソッドは、setObjectPropertyコマンドで行われた変更が反映されたかを検証するための自動化テストで使用できます。

20.2.14.3 例

• 有効なクラス名を次に示します。

  oracle.oddc.data.Profile
  oracle.odc.recognition.RecognitionJob
  oracle.odc.importprocessor.ImportJob
  oracle.odc.entity.CommitProfileEntity
  oracle.odc.docconverter.DocConverterJob
  

• 次に示すのは、インポート・ジョブに適用される<オブジェクト識別子>の例です。

  jobName=Import Email
  

• 電子メール・インポート・ジョブに関連付けられたプロパティ<serverName>の値を取得するための例を次に示します。

  getObjectProperty('TEST-WORKSPACE','oracle.odc.importprocessor.ImportJob','jobName=Import Email','serverName')
  

20.2.15 setObjectCredentials

WLSTでの使用: オンライン。

20.2.15.1 説明

プロファイルまたはジョブに関連付けられたユーザー名とパスワードを設定するために使用されます。

20.2.15.2 構文

setObjectCredentials('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<USER_NAME>','<PASSWORD>')

このメソッドに必要なパラメータは次のとおりです。

引数	定義
WORKSPACE_NAME	変更される資格証明が含まれるCaptureワークスペースの名前。呼び出すユーザーが、複数のワークスペースに対して、指定された名前の権限を持っている場合、最初に検索されたワークスペースが使用されます。
CLASS_NAME	プロファイルまたはジョブを定義するクラスの名前。
OBJECT_IDENTIFIER	変更するオブジェクトのプロパティ名と予期される値から構成される、キー/値ペア。
USER_NAME	オブジェクトの資格証明に割り当てるユーザー名。
PASSWORD	オブジェクトの資格証明に割り当てるパスワード。

20.2.15.3 例

• 有効なクラス名は、次のとおりです。

  oracle.odc.importprocessor.ImportJob
  oracle.odc.entity.CommitProfileEntity
  

• 電子メール・インポート・ジョブに関連付けられた資格証明を設定する例を次に示します。

  setObjectCredentials('TEST-WORKSPACE','oracle.odc.importprocessor.ImportJob','jobName=import Email','[e-mail]','welcome123')
  

• WebCenter Imagingコミット・プロファイルに関連付けられた資格証明を設定する例を次に示します。

  setObjectCredentials('TEST-WORKSPACE','oracle.odc.entity.CommitProfileEntity','profileName=commit to Imaging','admin','welcome123')
  

20.2.16 updateScript

WLSTでの使用: オンライン。

20.2.16.1 説明

ワークスペース内でスクリプトを更新します。

20.2.16.2 構文

updateScript('<WORKSPACE_NAME>','<SCRIPT_NAME>','<SCRIPT_FILE>')

このコマンドに必要なパラメータは次のとおりです。

引数	定義
WORKSPACE_NAME	スクリプトを含むワークスペースの名前。ワークスペースの一意の識別子をルックアップするためには、名前を使用する必要があります。名前が見つからない場合、エラー・メッセージが表示されます。
SCRIPT_NAME	更新するスクリプトの名前。スクリプトが見つからない場合、エラー・メッセージが表示されます。
SCRIPT_FILE	更新されるスクリプト・ファイルへの絶対パス。スクリプトは、このファイルのコンテンツで更新されます。

20.2.16.3 例

次の例は、ワークスペース内でスクリプトを更新します。

updateScript('TEST-WORKSPACE','Client_Script','/scratch/aime/scripts/client.txt')