11 高度な機能の実行
Captureシステム管理者がCaptureシステムのインストール、構成および全体的な監視を実行する際には、ワークスペース・マネージャのアクセス権を持つワークスペースに対して高度な機能を実行することが必要になる場合があります。たとえば、ワークスペースの構成のインポートやエクスポート、スタック・バッチのリリースやエクスポートを行う場合です。
この章では、次の項目について説明します。
11.1 ワークスペース・マネージャのWLSTコマンドの使用
表11-1は、Capture WLSTコマンドの一部であり、Captureワークスペース・マネージャが通常使用するコマンドを示しています。『WebCenter WLSTコマンド・リファレンス』の構成コマンドに関する項を参照してください。
Capture WLSTコマンドを実行するには:
-
Weblogic Scripting Tool (WLST)をインストールして実行します。
-
Middlewareホーム内のCaptureホーム・ディレクトリにあるwlstスクリプト(プラットフォームによってwlst.shまたはwlst.cmd) (
MIDDLEWARE_HOME/oracle_common/common/bin/wlst.shまたはwlst.cmd)を呼び出して、Capture固有のWLSTコマンドを実行します。次はWindowsの場所の例です。
C:\Oracle\Middleware\oracle_common\common\bin\wlst.cmd次はLinuxの場所の例です。
/home/middleware/oracle_common/common/bin/wlst.shOracle WebCenter Enterprise CaptureアプリケーションがデプロイされたOracle WebLogic Server管理対象サーバー(デフォルト・ポート16400)に接続するか、Oracle WebLogic Server管理サーバーに接続し、次のコマンドを実行することによって、場所をdomainRuntimeに変更します:
domainRuntime() -
IDで実行するワークスペースまたはバッチを識別するには、表11-1に示されているコマンドのうち
listで始まるコマンドを使用します。 -
後続の項で説明するように、指定されたバッチまたはワークスペースに基づいて実行するには、エクスポート、インポートまたはロック解除コマンドを使用します。
表11-1 ワークスペース・マネージャが通常使用するCapture WLSTコマンド
| Capture WLSTコマンド | 説明 | 構文 | 例 |
|---|---|---|---|
listWorkspaces |
アクセス可能なすべてのワークスペース(その前にIDが付きます)をリストします。 | listWorkspaces() |
コマンド: listWorkspaces() 出力: 4 bills_workspace2 certificates_workspace5 receipts_workspace |
listBatches |
ID別に指定されるワークスペースのすべてのバッチをリストします。 | listBatches(WORKSPACE_ID) |
コマンド: listBatches(3) 出力: CERT000000001CERT000000002CERT000000007 |
listLockedBatches |
ID別に指定されるワークスペースのすべてのロックされたバッチのリストを表示します。 | listLockedBatches(WORKSPACE_ID) |
コマンド: listLockedBatches(3) 出力: 3 1 EXP1 AUSER AUSER_PC 01/01/13 |
exportWorkspace |
スクリプト、プロファイルおよびジョブを含む、ワークスペースの構成全体を指定された場所の指定されたxmlファイルにエクスポートします。 | exportWorkspace(WORKSPACE_ID,'FILE_NAME') |
コマンド: exportWorkspace(3,'/home/abc/workspace3.xml') 出力: ワークスペースは正常にエクスポートされました |
importWorkspace |
exportWorkspaceコマンドで生成されるxmlファイルからワークスペースをインポートします。インポートするワークスペースは、Captureデータベースに存在しません。 |
importWorkspace('FILE_NAME') |
コマンド: importWorkspace('/home/abc/workspace3.xml')出力: ワークスペースは正常にインポートされました |
exportBatch |
イメージ、ドキュメント、添付およびメタデータを含む指定されたバッチを、指定された場所の指定されたXMLファイルにエクスポートします。 | exportBatch(BATCH_ID,'FILE_NAME') |
コマンド: exportBatch(8,'/home/abc/batch8.xml') 出力: バッチは正常にエクスポートされました |
unlockBatch |
指定されたバッチのバッチ・ロック・レコードを削除し、バッチを「準備完了」状態に変更して、ユーザーがクライアントで開けるようにします。ワークスペースのロックされたバッチのリストを表示するには、listLockedBatchesコマンドを使用します。 |
unlockBatch('BATCH_ID') |
コマンド: unlockBatch('8') 出力: バッチは正常にロック解除されました |
deleteBatches |
指定されたバッチを削除します。 | deleteBatches(<BATCH_ID_1>,<BATCH_ID_2>,...<BATCH_ID_N>) |
コマンド: deleteBatches(3,7) 出力: バッチが正常に削除されました |
exportIMAPEmailMessage |
指定されたメッセージIDのIMAP電子メール・メッセージを、指定されたファイルにエクスポートします。 | exportIMAPEmailMessage('<EMAIL_SERVER_NAME>', <PORT>, <IMAP_CONNECTION_SECURITY>, '<Email_ADDRESS>', '<PASSWORD>', '<MESSAGE_ID>', '<SEARCH_FOLDER>', '<EXPORT_FILE_NAME>') |
コマンド: exportIMAPEmailMessage('stbeehive.oracle.com',993,1,'abc.xyz@oracle.com','myEmailPassword','12abc-3456-7ddd-e891-b1234567', 'inbox','/hom/abc/Exported_Email_Message_.eml') 出力: 電子メール・メッセージは正常にエクスポートされました |
exportEWSEmailMessage |
指定されたメッセージIDのEWS電子メール・メッセージを、指定されたファイルにエクスポートします。 | exportEWSEmailMessage('<MICROSOFT_EMAIL_EXCHANGE_SERVICE_URL>','<EMAIL_ADDRESS>','<PASSWORD>','<MESSAGE_ID>', '<SEARCH_FOLDER>', '<EXPORT_FILE_NAME>') |
コマンド: exportEWSEmailMessage('https://<hostname>/ews/exchange.asmx','abc.xyz@oracle.com','myEmailPassword','12abc-3456-7ddd-e891-b1234567', 'inbox','/home/abc/Exported_Email_Message_.eml') 出力: 電子メール・メッセージは正常にエクスポートされました |
setObjectProperty |
Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)で定義されたプロパティの値を設定します。 | setObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_ASSIGNMENT_STRING>') |
コマンド: setObjectProperty('TEST_WORKSPACE','corporate.odc.entity.CommitProfileEntity','profileName=Commit to CS','serverURL=http://myhost.example.com:16200/cs/idcplg/') 出力: プロパティは正常に更新されました。 |
getObjectProperty |
Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)のプロパティの特定の値を出力します。 | getObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_NAME>') |
コマンド: getObjectProperty('TEST-WORKSPACE','oracle.odc.importprocessor.ImportJob','jobName=ImportEmail','serverName') 出力: プロパティが次のように正常に取得されました: mail.oracle.com |
setObjectCredentials |
Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)に関連付けられるユーザー名とパスワードを設定します。 | setObjectCredentials('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<USER_NAME>','<PASSWORD>') |
コマンド: setObjectCredentials('TEST-WORKSPACE','oracle.odc.importprocessor.ImportJob','jobName=import Email','xyz@oracle.com','welcome123') 出力: 資格証明が正常に更新されました。 |
updateScript |
ワークスペース内でスクリプトを更新します。 | updateScript('<WORKSPACE_NAME>','<SCRIPT_NAME>','<SCRIPT_FILE>') |
コマンド: updateScript('TEST-WORKSPACE','Client_Script','/scratch/scripts/client.txt') 出力: スクリプトは正常に更新されました。 |
cloneWorkspaceFromID |
既存のワークスペースをコピーし、新しいワークスペースを作成します。 | cloneWorkspaceFromID(WORKSPACE_ID, 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION') |
コマンド: cloneWorkspaceFromID(3,'Expenses','Expenses Workspace')Output: Workspace successfully copied 出力: ワークスペースは正常にコピーされました。 |
cloneWorkspaceFromFile |
exportWorkspaceコマンドで作成された出力ファイルを読み取り、ワークスペースの一意のコピーを作成します。 |
cloneWorkspaceFromFile('FILE_NAME', 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION') |
コマンド: cloneWorkspaceFromFile('/home/bills/expense1.xml','Expenses','Expenses Workspace') 出力: ワークスペースは正常にコピーされました。 |
listImportHATokens |
特定のワークスペースのすべてのインポート・プロセッサ・トークンを表示します。 | listImportHATokens(WORKSPACE_ID) |
コマンド: listImportHATokens(3) 出力: トークンID: d:\bills\ha_token.lstソース・クラス名: oracle.odc.importprocessor.listfile.ListFileSource作成日: 11/10/14変更日: 11/11/14 |
deleteImportHAToken |
ECIMPORTHATOKENおよびECIMPORTHATOKENITEMS表から特定のインポート・プロセッサのHAトークンを削除します。 |
deleteImportHAToken ('TOKEN_ID') |
コマンド: deleteImportHAToken('d:\bills\ha_token.lst') 出力: インポート・プロセッサのHAトークンが正常に削除されました。 |
11.2 ワークスペース構成のエクスポート
exportWorkspaceコマンドを使用して、その定義、プロファイル、ジョブおよびスクリプトを含むワークスペースの構成全体をXMLファイルに出力できます。importWorkspaceコマンドとともに使用する場合、exportWorkspaceコマンドは、テスト目的など、環境間でワークスペース構成を転送する際に役立ちます。
ノート: ワークスペース・セキュリティ設定は、生成されたXMLファイルにはエクスポートされません。
XMLファイルにワークスペースをエクスポートするには:
-
管理対象サーバーに接続するか、domainRuntimeに移動した後で、
listWorkspacesコマンドを実行して、エクスポートするワークスペースのIDを識別します。 -
エクスポートするワークスペースID、ファイルおよび書き込むXMLファイルの場所を指定して、
exportWorkspaceコマンドを実行します。コマンドの詳細と例は、表11-1を参照してください。
11.3 ワークスペース構成のインポート
ノート: ワークスペースをインポートするときには、セキュリティ設定はインポートされません。
importWorkspaceコマンドを使用すると、構成(プロファイル、ジョブおよびスクリプト)とデータ(イメージ、ドキュメントおよびメタデータ)を含め、ワークスペース全体をexportWorkspace WLSTコマンドを使用して作成されたXMLファイルからインポートできます。これは、テスト目的など、環境間でワークスペース構成を転送する際に役立ちます。
XMLファイルからワークスペースをインポートするには:
-
管理対象サーバーに接続するか、domainRuntimeに移動した後で、
listWorkspacesコマンドを使用して、インポートするワークスペースがCaptureシステムにすでに存在していないことを確認します。ワークスペースがすでに存在している場合は、xmlファイルの変更内容がワークスペースにマージされます。
-
インポートする場所とXMLファイルを指定して、
importWorkspaceコマンドを実行します。コマンドの詳細と例は、表11-1を参照してください。
11.4 ロックされたバッチのリリース
別のユーザーにロックされているバッチをリリースして、バッチが機能するようにすることが必要になる場合があります。
バッチをリリースするには:
-
管理対象サーバーに接続するか、domainRuntimeに移動した後で、
listLockedBatchesコマンドを使用して、リリースするバッチのIDを確認します。 -
ロックを解除するバッチのIDを指定して、
unlockBatchコマンドを実行します。コマンドの詳細と例は、表11-1を参照してください。
11.5 バッチのエクスポート
特にトラブルシューティング目的で、イメージ、ドキュメント、添付およびメタデータを含め、バッチをエクスポートすることが役立つ場合があります。
バッチをエクスポートするには:
-
管理対象サーバーに接続するか、domainRuntimeに移動した後で、
listBatchesコマンドを使用して、エクスポートするバッチのIDを確認します。 -
エクスポートするバッチのIDを指定して、
exportBatchコマンドを実行します。コマンドの詳細と例は、表11-1を参照してください。
11.6 バッチの削除
管理者は、場合によっては不要になったバッチ、特に、誤りがあったり、延々と処理ステージから抜け出せない(他のユーザーが作成した)特定のバッチの削除が必要になることがあります。deleteBatchesコマンドを使用すると、管理者は指定したバッチの一括削除を実行できます。
このコマンドを使用すると、管理者はロックされたバッチとロック解除されたバッチの両方を削除できます。WLSTでの使用: オンライン。これは管理者固有のコマンドであり、他のCaptureユーザーが使用することはできません。指定されたバッチを削除するには:
-
管理対象サーバーに接続した後またはdomainRuntimeに移動した後で、
listLockedBatchesコマンドまたはlistBatchesコマンドを使用して削除するバッチのIDを確認します。 -
削除するバッチのIDを指定して、
deleteBatchesコマンドを実行します。コマンドの詳細と例は、表11-1を参照してください。
11.7 IMAP電子メール・メッセージのエクスポート
exportIMAPEmailMessageコマンドを使用すると、指定したメッセージIDとともにIMAP電子メール・メッセージを指定ファイルにエクスポートできます。WLSTでの使用: オンライン。
電子メール接続セキュリティおよびポートのパラメータを除き、パラメータはすべて、文字列形式である必要があります。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してexportIMAPEmailMessageコマンドを実行します:
- 電子メール・サーバーの名前(DNS名またはIPアドレス)
- ポート番号
- 整数形式のセキュリティ設定(セキュリティなし:
0、SSL/TLSセキュリティ・タイプ:1、STARTTLSセキュリティ・タイプ:2など)。 - メッセージのチェック対象となる電子メール・アカウント
- 電子メール・アカウントのパスワード
- メッセージの一意のID
- メッセージのチェック対象となるフォルダ
- エクスポート・ファイル名とその完全なパス。
.eml拡張子が必要です。
コマンドの詳細と例は、表11-1を参照してください。
11.8 EWS電子メール・メッセージのエクスポート
exportEWSEmailMessageコマンドを使用すると、指定したメッセージIDとともにEWS電子メール・メッセージを指定ファイルにエクスポートできます。WLSTでの使用: オンライン。
「交換サービス・タイプ」で「基本認証」を選択した場合、このコマンドはMicrosoft電子メール交換サービスに固有です。電子メール・メッセージと電子メール添付のインポートの構成を参照してください。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してexportEWSEmailMessageコマンドを実行します:
- Microsoft電子メール交換サービスURL
- メッセージのチェック対象となる電子メール・アカウント
- 電子メール・アカウントのパスワード
- メッセージの一意のID
- メッセージのチェック対象となるフォルダ
- エクスポート・ファイル名とその完全なパス。
.eml拡張子が必要です。
コマンドの詳細と例は、表11-1を参照してください。
11.9 オブジェクト・プロパティの値の設定
setObjectPropertyコマンドを使用すると、Captureオブジェクトで定義されたプロパティの値を設定できます。Captureオブジェクトは、クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイルのいずれかです。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してsetObjectPropertyコマンドを実行します:
-
変更するオブジェクトが格納されているワークスペース名
-
オブジェクトを定義するクラス名
-
オブジェクト識別子(変更するオブジェクトのプロパティ名と想定される値で構成されるキー/値ペア)
-
等号で区切られた、更新するプロパティの名前および値
コマンドの詳細と例は、表11-1を参照してください。『WebCenter WLSTコマンド・リファレンス』の「Captureオブジェクトのプロパティ」およびsetObjectPropertyに関する項を参照してください。
11.10 オブジェクト・プロパティの値の表示
getObjectPropertyコマンドを使用すると、Captureオブジェクトで定義されたプロパティの値を表示できます。Captureオブジェクトは、クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイルのいずれかです。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してgetObjectPropertyコマンドを実行します:
-
オブジェクトが格納されているワークスペース名
-
オブジェクトを定義するクラス名
-
オブジェクト識別子(出力するオブジェクトのプロパティ名と想定される値で構成されるキー/値ペア)
-
アクセスするプロパティの名前
コマンドの詳細と例は、表11-1を参照してください。『WebCenter WLSTコマンド・リファレンス』のgetObjectPropertyに関する項を参照してください。
11.11 オブジェクトの資格証明の設定
setObjectCredentialsコマンドを使用すると、Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)に関連付けられるユーザー名およびパスワードを設定できます。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してsetObjectCredentialsコマンドを実行します:
-
変更する資格証明が格納されているワークスペース名
-
オブジェクトを定義するクラス名
-
オブジェクト識別子(変更するオブジェクトのプロパティ名と想定される値で構成されるキー/値ペア)
-
オブジェクトの資格証明に割り当てるユーザー名
-
オブジェクトの資格証明に割り当てるパスワード
コマンドの詳細と例は、表11-1を参照してください。
11.12 ワークスペース内でのスクリプトの更新
updateScriptコマンドを使用すると、ワークスペース内でスクリプトを更新できます。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してupdateScriptコマンドを実行します:
-
更新するスクリプトが格納されているワークスペース名
-
更新するスクリプトの名前
-
新しいスクリプト・ファイルへの絶対パス。スクリプトは、このファイルのコンテンツで更新されます。
コマンドの詳細と例は、表11-1を参照してください。
11.13 既存のワークスペースのコピー
cloneWorkspaceFromIDコマンドを使用すると、既存のワークスペースのコピーを作成できます。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してcloneWorkspaceFromIDコマンドを実行します:
-
コピーするワークスペースのワークスペースID
-
作成される新しいワークスペースのワークスペース名
-
新しいワークスペースを表す説明
コマンドの詳細と例は、表11-1を参照してください。
11.14 ファイルからのワークスペースのクローニング
cloneWorkspaceFromFileコマンドを使用すると、exportWorkspaceコマンドで作成された出力ファイルを読み取り、ワークスペースの一意のコピーを作成できます。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してcloneWorkspaceFromFileコマンドを実行します:
-
新しいワークスペースの作成に使用されるソースXMLファイルのフルパスが含まれるファイル名
-
作成される新しいワークスペースのワークスペース名
-
新しいワークスペースを表す説明
コマンドの詳細と例は、表11-1を参照してください。
11.15 インポート・プロセッサ・トークンの表示
listImportHATokensコマンドを使用すると、特定のワークスペースのインポート・プロセッサ・トークンをすべて表示できます。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してlistImportHATokensコマンドを実行します:
- ワークスペースID
コマンドの詳細と例は、表11-1を参照してください。
11.16 インポート・プロセッサ・トークンの削除
deleteImportHATokenコマンドを使用すると、ECIMPORTHATOKENおよびECIMPORTHATOKENITEMS表から特定のインポート・プロセッサのHAトークンを削除できます。
管理対象サーバーに接続した後またはdomainRuntimeに移動した後に、次を指定してdeleteImportHATokenコマンドを実行します:
- 削除されるインポート・プロセッサのHAトークンの一意の識別子が含まれるトークンID
コマンドの詳細と例は、表11-1を参照してください。