| Oracle® Fusion Middleware WebCenter WLSTコマンド・リファレンス 12c (12.2.1) E70080-01 |
|
 前 |
 次 |
次以降の項では、Oracle WebCenter Enterprise CaptureのためのカスタムWLSTコマンドについて説明します。これらのコマンドを使用すると、コマンド・ラインからOracle WebCenter Enterprise Captureの様々な構成パラメータにアクセスおよび変更できます。内容は次のとおりです。
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の管理』のJavaコンポーネントおよびOracle Fusion MiddlewareサービスでのWLSTの使用に関する項を参照してください。
WLST Oracle WebCenter Enterprise Captureコマンドのカテゴリは、次のとおりです。
表4-1 WLST Oracle WebCenter Enterprise Captureコマンド・カテゴリ
| コマンド・カテゴリ | 説明 |
|---|---|
Oracle WebCenter Enterprise Captureの構成を表示および管理します。 |
表4-2のコマンドを使用して、Oracle WebCenter Enterprise Captureを構成します。
表4-2 WLSTサーバーOracle WebCenter Enterprise Capture構成コマンド
| 使用するコマンド | 目的 | WLSTでの使用 |
|---|---|---|
管理者またはワークスペース管理者がアクセスできるすべてのCaptureワークスペースをリストします。 |
オンライン |
|
指定したワークスペース内にあるすべてのバッチをリストします。 |
オンライン |
|
イメージとメタデータを含むバッチを、zipファイルにエクスポートします。 |
オンライン |
|
ドキュメント、メタデータ、スクリプト、プロファイルおよびジョブを含むCaptureワークスペース全体を、XMLファイルにエクスポートします。 |
オンライン |
|
|
オンライン |
|
指定したバッチのバッチ・ロックに関するレコードを削除します。 |
オンライン |
|
指定されたワークスペースのロックされたバッチのリストを表示します。 |
オンライン |
|
すべてのEnterprise Capture構成の属性と値のリストを表示します。 |
オンライン |
|
引数として指定した属性の値をフェッチします。 |
オンライン |
|
Enterprise Capture属性の値を、入力した値に設定します。 |
オンライン |
|
クライアント・バンドル・ディレクトリの更新済バンドルをスキャンします。 |
オンライン |
|
既存のクライアント・バンドルを削除します。 |
オンライン |
|
Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)で定義されたプロパティの値を設定します。 |
オンライン |
|
Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)のプロパティの特定の値を出力します。 |
オンライン |
|
Captureオブジェクト(プロセッサ・ジョブまたはコミット・プロファイル)に関連付けられるユーザー名とパスワードを設定します。 |
オンライン |
|
ワークスペース内でスクリプトを更新します。 |
オンライン |
|
既存のワークスペースをコピーし、新しいワークスペースを作成します。 |
オンライン |
|
|
オンライン |
|
特定のワークスペースのすべてのインポート・プロセッサ・トークンを表示します。 |
オンライン |
|
|
オンライン |
WLSTでの使用: オンライン。
説明
管理者または Captureワークスペース管理者がアクセスできるすべてのワークスペースをリストします。
構文
listWorkspaces()
例
次の例では、すべてのワークスペースをリストし、先頭にそれらのIDを付けます。
listWorkspaces()
4 bills_workspace
2 certificates_workspace
5 receipts_workspace
WLSTでの使用: オンライン。
説明
IDによって指定されたワークスペースのすべてのバッチをリストします。リストされる各バッチには、「バッチID」、「バッチ名」、「作成者」(ユーザー)、「最終更新者」(ユーザー)および「最終更新」(日付)という5つの列(この順序で表示されます)が含まれます。
構文
listBatches (WORKSPACE_ID)
| 引数 | 定義 |
|---|---|
|
ワークスペースのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。 注意: 有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。 |
例
次の例では、IDが1の特定のワークスペースのバッチをリストします。
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
WLSTでの使用: オンライン。
説明
イメージとメタデータを含むバッチを、XMLファイルとバッチ・アイテム・ファイルを含むZIPファイルにエクスポートします。
構文
exportBatch(BATCH_ID,'FILE_NAME')
| 引数 | 定義 |
|---|---|
|
バッチのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のバッチに対して有効な引数です。 注意: 有効なバッチIDのリストを取得するには、listBatchesコマンドを使用します。 |
|
バッチのエクスポート先となるzipファイルの名前です。ファイル名は、その完全なパスとともに指定する必要があります。 |
注意:
パスは、オペレーティング・システムに関係なく、スラッシュ「/」で区切ってください。
例
次の例では、バッチをエクスポートします。
exportBatch(8,'/home/abc/batch8.zip')
Batch successfully exported
WLSTでの使用: オンライン。
説明
ドキュメント、メタデータ、スクリプト、プロファイルおよびジョブを含むワークスペース全体を、XMLファイルにエクスポートします。
構文
exportWorkspace(WORKSPACE_ID,'FILE_NAME')
| 引数 | 定義 |
|---|---|
|
ワークスペースのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。 注意: 有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。 |
|
ワークスペースのエクスポート先となるファイルの名前です。ファイル名は、その完全なパスとともに指定する必要があります。 |
注意:
パスは、オペレーティング・システムに関係なく、スラッシュ「/」で区切ってください。
例
次の例では、IDが3のワークスペースをエクスポートします。
exportWorkspace(3,'/home/abc/workspace3.xml')
Workspace successfully exported
WLSTでの使用: オンライン。
説明
exportWorkspaceコマンドを使用して生成したXMLファイルからワークスペースをインポートします。Oracle WebCenter Enterprise Captureデータベース内にあるワークスペースはインポートできません。
構文
importWorkspace('FILE_NAME')
| 引数 | 定義 |
|---|---|
|
ワークスペースのインポート元となるXMLファイルの名前です。ファイル名は、その完全なパスとともに指定する必要があります。 |
例
次の例では、名前がworkspace3.xmlのワークスペースをインポートします。
importWorkspace('/home/abc/workspace3.xml')
Workspace successfully imported
WLSTでの使用: オンライン。
説明
指定したバッチのバッチ・ロックに関するレコードを削除します。バッチの状態がREADYになり、クライアントはそのバッチを開くことができます。
構文
unlockBatch('BATCH_ID')
| 引数 | 定義 |
|---|---|
|
バッチのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のバッチに対して有効な引数です。 注意: ロックされたバッチのリストを取得するには、listLockedBatchesコマンドを使用します。 |
例
次の例では、IDが8のバッチのロックを解除します。
unlockBatch('8')
Batch successfully unlocked
WLSTでの使用: オンライン。
説明
ロックされたバッチのリストを表示します。リストされる各バッチには、「ワークスペースID」、「バッチID」、「バッチ名」、「作成者」(ユーザー)、ワークステーション(名前/IPアドレス)および「最終更新」(日付)という6つの列(この順序で表示されます)が含まれます。
構文
listLockedBatches('WORKSPACE_ID')
| 引数 | 定義 |
|---|---|
|
ワークスペースのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。 注意: 有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。 |
例
次の例では、IDが1のワークスペースのロックされたバッチをリストします。
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
WLSTでの使用: オンライン。
説明
すべてのEnterprise Capture構成の属性と値のリストを表示します。値をフェッチできない場合、その値は「VALUE CANNOT BE DISPLAYED」と表示されます。値をフェッチできない最も可能性が高い原因は、権限が不十分であることです。
構文
listCaptureConfig()
例
次の例に、Enterprise Captureの構成の属性と値をリストします。
listCaptureConfig()
CaptureSystemID CAPTURE_01
BatchRefreshLimit 5
WLSTでの使用: オンライン。
説明
引数として指定した属性の値をフェッチします。listCaptureConfigコマンドを使用して、可能な属性名をリストします。
構文
getCaptureConfig(['NAME_OF_ATTRIBUTE'])
| 引数 | 定義 |
|---|---|
|
Enterprise Capture構成に対する属性の名前(文字列)です。 |
例
次の例では、Enterprise CaptureシステムIDに対する属性の値をフェッチします。
getCaptureConfig('CaptureSystemID')
CAPTURE_01
WLSTでの使用: オンライン。
説明
Enterprise Capture属性の値を、入力した値に設定します。
構文
setCaptureConfig(['NAME_OF_ATTRIBUTE'],['VALUE_OF_ATTRIBUTE'])
| 引数 | 定義 |
|---|---|
|
構成するEnterprise Captureの構成の属性名。 |
|
Enterprise Capture構成属性に設定する値です。 |
例
次の例では、CaptureSystemID属性を値CAPTURE_02に設定します。
setCaptureConfig('CaptureSystemID','CAPTURE_02')
Attribute 'CaptureSystemID' changed to "CAPTURE_02'
WLSTでの使用: オンライン。
説明
クライアント・バンドル・ディレクトリのバンドルをスキャンします。既存のバンドルのデータが更新されるだけでなく、新しいバンドルの情報がロードされ、データベース内にキャッシュされます。
構文
scanForClientBundles()
例
次の例では、バンドルをスキャンし、処理済のバンドルをリストします。
scanForclientBundles()
Processed capture bundle.jar
WLSTでの使用: オンライン。
説明
既存のバンドルを削除します。
構文
deleteBundle('bundlename')
| 引数 | 定義 |
|---|---|
|
削除する既存のバンドルの名前です。 |
例
次の例では、指定したバンドルを削除します。
deleteBundle('Example')
WLSTでの使用: オンライン。
説明
Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)で定義されたプロパティの値を設定します。
各Captureオブジェクトに設定できるプロパティの詳細は、「Captureオブジェクト・プロパティ」を参照してください。
構文
setObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_ASSIGNMENT_STRING>')
このコマンドに必要なパラメータは次のとおりです。
| 引数 | 定義 |
|---|---|
|
変更されるオブジェクトが含まれるCaptureワークスペースの名前。呼び出すユーザーが、複数のワークスペースに対して、指定された名前の権限を持っている場合、最初に検索されたワークスペースが使用されます。 注意: ワークスペースのリストを取得するには、listWorkspacesコマンドを使用します。 |
|
クライアント・プロファイル、プロセッサ・ジョブ、またはコミット・プロファイルを定義するクラスの名前。 |
|
オブジェクトを見つけるために使用できるプロパティの名前と、そのプロパティの期待される値で構成されているキー/値ペア。 |
|
更新するプロパティの名前と値を等号で区切ったもの。 |
注意点
次のリストに、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
例
次に示すのは、コミット・プロファイルに適用される<オブジェクト識別子>の例です。
profileName=Commit to CS
次に示すのは、クライアント・プロファイルのプロパティprofileDescを更新するための<プロパティ割当て文字列>の例です:
profileDesc=Test Profile Desc
次に示すのは、Commit to CSという名のWebCenter Contentコミット・プロファイルに関連付けられたプロパティ<serverURL>を設定する例です。
setObjectProperty('TEST_WORKSPACE','oracle.odc.entity.CommitProfileEntity','profileName=Commit to CS','serverURL=http://myhost.example.com:16200/cs/idcplg/')
WLSTでの使用: オンライン。
説明
Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)の特定のプロパティの値を出力します。
構文
getObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_NAME>')
このメソッドに必要なパラメータは次のとおりです。
| 引数 | 定義 |
|---|---|
|
変更されるオブジェクトが含まれるCaptureワークスペースの名前。呼び出すユーザーが、複数のワークスペースに対して、指定された名前の権限を持っている場合、最初に検索されたワークスペースが使用されます。 注意: ワークスペースのリストを取得するには、listWorkspacesコマンドを使用します。 |
|
クライアント・プロファイル、プロセッサ・ジョブ、またはコミット・プロファイルを定義するクラスの名前。 |
|
オブジェクトを見つけるために使用できるプロパティの名前と、そのプロパティの期待される値で構成されているキー/値ペア。 |
|
アクセスするプロパティの名前。 |
注意:
このコマンドに対するバッキングMBeanメソッドは、setObjectPropertyコマンドで行われた変更が反映されたかを検証するための自動化テストで使用できます。
例
有効なクラス名を次に示します。
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')
WLSTでの使用: オンライン。
説明
プロファイルまたはジョブに関連付けられたユーザー名とパスワードを設定するために使用されます。
構文
setObjectCredentials('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<USER_NAME>','<PASSWORD>')
このメソッドに必要なパラメータは次のとおりです。
| 引数 | 定義 |
|---|---|
|
変更される資格証明が含まれるCaptureワークスペースの名前。呼び出すユーザーが、複数のワークスペースに対して、指定された名前の権限を持っている場合、最初に検索されたワークスペースが使用されます。 注意: ワークスペースのリストを取得するには、listWorkspacesコマンドを使用します。 |
|
資格証明の変更に必要なクラスの名前。 |
|
変更するオブジェクトのプロパティ名と予期される値から構成される、キー/値ペア。 |
|
オブジェクトの資格証明に割り当てるユーザー名。 |
|
オブジェクトの資格証明に割り当てるパスワード。 |
例
有効なクラス名は、次のとおりです。
oracle.odc.importprocessor.ImportJob oracle.odc.entity.CommitProfileEntity
電子メール・インポート・ジョブに関連付けられた資格証明を設定する例を次に示します。
setObjectCredentials('TEST-WORKSPACE','oracle.odc.importprocessor.ImportJob','jobName=import Email','xyz@example.com','welcome123')
WebCenter Imagingコミット・プロファイルに関連付けられた資格証明を設定する例を次に示します。
setObjectCredentials('TEST-WORKSPACE','oracle.odc.entity.CommitProfileEntity','profileName=commit to Imaging','admin','welcome123')
WLSTでの使用: オンライン。
説明
ワークスペース内でスクリプトを更新します。
構文
updateScript('<WORKSPACE_NAME>','<SCRIPT_NAME>','<SCRIPT_FILE>')
このコマンドに必要なパラメータは次のとおりです。
| 引数 | 定義 |
|---|---|
|
スクリプトを含むワークスペースの名前。ワークスペースの一意の識別子をルックアップするためには、名前を使用する必要があります。名前が見つからない場合、エラー・メッセージが表示されます。 注意: ワークスペースのリストを取得するには、listWorkspacesコマンドを使用します。 |
|
更新するスクリプトの名前。スクリプトが見つからない場合、エラー・メッセージが表示されます。 |
|
更新されるスクリプト・ファイルへの絶対パス。スクリプトは、このファイルのコンテンツで更新されます。 |
例
次の例は、ワークスペース内でスクリプトを更新します。
updateScript('TEST-WORKSPACE','Client_Script','/scratch/aime/scripts/client.txt')
WLSTでの使用: オンライン。
説明
IDで指定されたワークスペースの一意のコピーを作成します。
構文
cloneWorkspaceFromID(WORKSPACE_ID, 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION')
このコマンドに必要なパラメータは次のとおりです。
| 引数 | 定義 |
|---|---|
|
コピーするワークスペースのID番号。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。 注意: 有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。 |
|
作成する新しいワークスペースの名前。 |
|
作成する新しいワークスペースの説明。 |
例
次の例では、既存のワークスペースをクローニングします。
cloneWorkspaceFromID(3,'Expenses','Expenses Workspace')
WLSTでの使用: オンライン。
説明
exportWorkspaceコマンドで作成された出力ファイルを読み取り、ワークスペースの一意のコピーを作成します。
構文
cloneWorkspaceFromFile('FILE_NAME', 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION')
このコマンドに必要なパラメータは次のとおりです。
| 引数 | 定義 |
|---|---|
|
コンテンツをコピーする必要がある出力ファイルの名前。 |
|
作成する新しいワークスペースの名前。 |
|
作成する新しいワークスペースの説明。 |
例
次の例では、ワークスペースを作成するために出力ファイルを読み取ります。
cloneWorkspaceFromFile('/home/bills/expense1.xml','Expenses','Expenses Workspace')
WLSTでの使用: オンライン。
説明
特定のワークスペースのすべてのインポート・プロセッサ・トークンを表示します。
構文
listImportHATokens(WORKSPACE_ID)
このコマンドに必要なパラメータは次のとおりです。
| 引数 | 定義 |
|---|---|
|
トークンを表示する必要があるワークスペースのID番号。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。 注意: 有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。 |
例
次の例では、IDが3のワークスペースのインポート・プロセッサ・トークンを表示します。
listImportHATokens(3)
