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

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

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

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

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

help('capture')

Enterprise Captureワークスペース・コンソールの使用については、『Oracle WebCenter Enterprise Captureの管理』のCaptureワークスペース・コンソールについてに関する項を参照してください。

ノート:

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

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

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

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

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

5.2 構成コマンド

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

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

使用するコマンド	目的	WLSTでの使用
listWorkspaces	管理者またはワークスペース管理者がアクセスできるすべてのCaptureワークスペースをリストします。	オンライン
listBatches	指定したワークスペース内にあるすべてのバッチをリストします。	オンライン
exportBatch	イメージとメタデータを含むバッチを、zipファイルにエクスポートします。	オンライン
exportWorkspace	ドキュメント、メタデータ、スクリプト、プロファイルおよびジョブを含むCaptureワークスペース全体を、XMLファイルにエクスポートします。	オンライン
exportEWSEmailMessage	この電子メールのエクスポート方法は、Microsoft Email Exchange Service固有です。これは、指定された`messageId`のEWS電子メール・メッセージを、指定されたファイルにエクスポートします。エクスポート・ファイル名は完全なパスとともに指定する必要があり、`.eml`拡張子が必要です。	オンライン
exportIMAPEmailMessage	指定された`messageId`のIMAP電子メール・メッセージを、指定されたファイルにエクスポートします。エクスポート・ファイル名は完全なパスとともに指定する必要があり、`.eml`拡張子が必要です。`EmailConnectionSecurity`は整数である必要があり、`0`はセキュリティなし、`1`はセキュリティ・タイプ`SSL_TLS`、および2はセキュリティ・タイプ`STARTTLS`を示します。すべてのパラメータは、`EmailConnectionSecurity`および`Port`以外の文字列形式である必要があります。	オンライン
importWorkspace	`exportWorkspace`コマンドで生成されるXMLファイルからワークスペースをインポートします	オンライン
unlockBatch	指定したバッチのバッチ・ロックに関するレコードを削除します。	オンライン
listLockedBatches	指定されたワークスペースのロックされたバッチのリストを表示します。	オンライン
listCaptureConfig	すべてのEnterprise Capture構成の属性と値のリストを表示します。	オンライン
getCaptureConfig	引数として指定した属性の値をフェッチします。	オンライン
setCaptureConfig	Enterprise Capture属性の値を、入力した値に設定します。	オンライン
scanForClientBundles	クライアント・バンドル・ディレクトリの更新済バンドルをスキャンします。	オンライン
deleteBundle	既存のクライアント・バンドルを削除します。	オンライン
deleteBatches	指定されたIDのバッチを削除します。	オンライン
setObjectProperty	Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)で定義されたプロパティの値を設定します。	オンライン
getObjectProperty	Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)のプロパティの特定の値を出力します。	オンライン
setObjectCredentials	Captureオブジェクト(プロセッサ・ジョブまたはコミット・プロファイル)に関連付けられるユーザー名とパスワードを設定します。	オンライン
updateScript	ワークスペース内でスクリプトを更新します。	オンライン
cloneWorkspaceFromID	既存のワークスペースをコピーし、新しいワークスペースを作成します。	オンライン
cloneWorkspaceFromFile	`exportWorkspace`コマンドで作成された出力ファイルを読み取り、ワークスペースの一意のコピーを作成します。	オンライン
listImportHATokens	特定のワークスペースのすべてのインポート・プロセッサ・トークンを表示します。	オンライン
deleteImportHAToken	`ECIMPORTHATOKEN`および`ECIMPORTHATOKENITEMS`表から特定のインポート・プロセッサのHAトークンを削除します。	オンライン

5.2.1 listWorkspaces

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

説明

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

構文

listWorkspaces()

例

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

listWorkspaces()
4 bills_workspace
2 certificates_workspace
5 receipts_workspace

5.2.2 listBatches

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

説明

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

構文

listBatches (WORKSPACE_ID)

引数	定義
`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

5.2.3 exportBatch

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

説明

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

構文

exportBatch(BATCH_ID,'FILE_NAME')

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

ノート:

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

例

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

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

5.2.4 exportWorkspace

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

説明

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

ノート:

ワークスペース・セキュリティ設定は、生成されたXMLファイルにはエクスポートされません。

構文

exportWorkspace(WORKSPACE_ID,'FILE_NAME')

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

ノート:

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

例

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

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

5.2.5 exportEWSEmailMessage

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

説明

指定されたmessageIdのEWS電子メール・メッセージを、指定されたファイルにエクスポートします。

構文

exportEWSEmailMessage('<MICROSOFT_EMAIL_EXCHANGE_SERVICE_URL>','<EMAIL_ADDRESS>','<PASSWORD>','<MESSAGE_ID>', '<SEARCH_FOLDER>', 
'<EXPORT_FILE_NAME>')

引数	定義
`MICROSOFT_EMAIL_EXCHANGE_SERVICE_URL`	Microsoft電子メール交換サービスURL
`Email_ADDRESS`	メッセージがチェックされる電子メール・アカウント
`PASSWORD`	電子メール・アカウントのパスワード
`MESSAGE_ID`	メッセージの一意のID
`SEARCH_FOLDER`	メッセージがチェックされるフォルダ
`EXPORT_FILE_NAME`	エクスポート・ファイル名は完全なパスとともに、`.eml`拡張子が必要です

例

次の例では、ID '12abc-3456-7ddd-e891-b1234567'のメッセージをファイル名'Exported_Email_Message_.eml'として'/home/abc/'の場所にエクスポートします。

exportEWSEmailMessage('https://<hostname>/ews/exchange.asmx','abc.xyz@oracle.com','myEmailPassword','12abc-3456-7ddd-e891-b1234567', 'inbox','/home/abc/Exported_Email_Message_.eml')
 
Email Message successfully exported.

5.2.6 exportIMAPEmailMessage

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

説明

指定されたmessageIdのIMAP電子メール・メッセージを、指定されたファイルにエクスポートします。エクスポート・ファイル名は完全なパスとともに指定する必要があり、.eml拡張子が必要です。EmailConnectionSecurityは整数である必要があり、0はセキュリティなし、1はセキュリティ・タイプSSL_TLS、および2はセキュリティ・タイプSTARTTLSを示します。すべてのパラメータは、EmailConnectionSecurityおよびPortを除いた文字列形式である必要があります。

構文

exportIMAPEmailMessage('<EMAIL_SERVER_NAME>', <PORT>, <IMAP_CONNECTION_SECURITY>, '<Email_ADDRESS>', '<PASSWORD>', '<MESSAGE_ID>', '<SEARCH_FOLDER>', '<EXPORT_FILE_NAME>')

引数	定義
`EMAIL_SERVER_NAME`	電子メール・サーバー名(DNS名またはIPアドレス)
`Port`	ポート番号
`IMAP_CONNECTION_SECURITY`	0はセキュリティ - なし、1はセキュリティ - SSL/TLS、2はセキュリティ - STARTTLS
`Email_ADDRESS`	メッセージがチェックされる電子メール・アカウント
`PASSWORD`	電子メール・アカウントのパスワード
`MESSAGE_ID`	メッセージの一意のID
`SEARCH_FOLDER`	メッセージがチェックされるフォルダ
`EXPORT_FILE_NAME`	エクスポート・ファイル名は完全なパスとともに、`.eml`拡張子が必要です。

例

次の例では、ID '12abc-3456-7ddd-e891-b1234567'のメッセージをファイル名'Exported_Email_Message_.eml'として'/home/abc/'の場所にエクスポートします。

exportIMAPEmailMessage('stbeehive.oracle.com',993,1,'abc.xyz@oracle.com','myEmailPassword','12abc-3456-7ddd-e891-b1234567', 'inbox','/hom/abc/Exported_Email_Message_.eml')
                
Email Message successfully exported.

5.2.7 importWorkspace

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

説明

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

ノート:

ワークスペースをインポートするときには、セキュリティ設定はインポートされません。

構文

importWorkspace('FILE_NAME')

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

例

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

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

5.2.8 unlockBatch

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

説明

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

構文

unlockBatch('BATCH_ID')

引数	定義
`BATCH_ID`	バッチのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のバッチに対して有効な引数です。ノート: ロックされたバッチのリストを取得するには、`listLockedBatches`コマンドを使用します。

例

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

unlockBatch('8')
Batch successfully unlocked

5.2.9 listLockedBatches

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

説明

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

構文

listLockedBatches('WORKSPACE_ID')

引数	定義
`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

5.2.10 listCaptureConfig

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

説明

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

構文

listCaptureConfig()

例

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

listCaptureConfig()
CaptureSystemID CAPTURE_01
BatchRefreshLimit 5

5.2.11 getCaptureConfig

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

説明

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

構文

getCaptureConfig(['NAME_OF_ATTRIBUTE'])

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

例

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

getCaptureConfig('CaptureSystemID')
CAPTURE_01

5.2.12 setCaptureConfig

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

説明

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

構文

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

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

例

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

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

5.2.13 scanForClientBundles

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

説明

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

構文

scanForClientBundles()

例

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

scanForclientBundles()
Processed capture bundle.jar

5.2.14 deleteBatches

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

説明

指定されたIDのバッチを削除します。

構文

deleteBatches(<BATCH_ID_1>,<BATCH_ID_2>,...<BATCH_ID_N>)

引数	定義
`BATCH_ID`	バッチのID番号。整数形式のみ指定できます。たとえば、1です

例

次の例では、IDが3および7のバッチを削除します。

deleteBatches(3,7)
Batch(es) successfully deleted.

5.2.15 deleteBundle

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

説明

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

構文

deleteBundle('bundlename')

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

例

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

deleteBundle('Example')

5.2.16 setObjectProperty

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

説明

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

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

構文

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

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

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

ノート

次のリストに、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/')
```

5.2.17 getObjectProperty

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

説明

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

各Captureオブジェクトに出力できるプロパティの詳細は、「Captureオブジェクト・プロパティ」を参照してください。

構文

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

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

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

ノート:

このコマンドに対するバッキング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')
```

5.2.18 setObjectCredentials

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

説明

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

構文

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

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

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

例

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

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')

5.2.19 updateScript

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

説明

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

構文

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

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

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

例

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

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

5.2.20 cloneWorkspaceFromID

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

説明

IDで指定されたワークスペースの一意のコピーを作成します。

構文

cloneWorkspaceFromID(WORKSPACE_ID, 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION')

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

引数	定義
`WORKSPACE_ID`	コピーするワークスペースのID番号。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。ノート: 有効なワークスペースIDのリストを取得するには、`listWorkspaces`コマンドを使用します。
`WORKSPACE_NAME`	作成する新しいワークスペースの名前。
`WORKSPACE_DESCRIPTION`	作成する新しいワークスペースの説明。

例

次の例では、既存のワークスペースをクローニングします。

cloneWorkspaceFromID(3,'Expenses','Expenses Workspace')

5.2.21 cloneWorkspaceFromFile

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

説明

exportWorkspaceコマンドで作成された出力ファイルを読み取り、ワークスペースの一意のコピーを作成します。

構文

cloneWorkspaceFromFile('FILE_NAME', 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION')

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

引数	定義
`FILE_NAME`	コンテンツをコピーする必要がある出力ファイルの名前。
`WORKSPACE_NAME`	作成する新しいワークスペースの名前。
`WORKSPACE_DESCRIPTION`	作成する新しいワークスペースの説明。

例

次の例では、ワークスペースを作成するために出力ファイルを読み取ります。

cloneWorkspaceFromFile('/home/bills/expense1.xml','Expenses','Expenses Workspace')

5.2.22 listImportHATokens

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

説明

特定のワークスペースのすべてのインポート・プロセッサ・トークンを表示します。

構文

listImportHATokens(WORKSPACE_ID)

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

引数	定義
`WORKSPACE_ID`	トークンを表示する必要があるワークスペースのID番号。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。ノート: 有効なワークスペースIDのリストを取得するには、`listWorkspaces`コマンドを使用します。

例

次の例では、IDが3のワークスペースのインポート・プロセッサ・トークンを表示します。

listImportHATokens(3)

5.2.23 deleteImportHAToken

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

説明

ECIMPORTHATOKENおよびECIMPORTHATOKENITEMS表から特定のインポート・プロセッサのHAトークンを削除します。

構文

deleteImportHAToken('TOKEN_ID')

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

引数	定義
`TOKEN_ID`	削除するトークンのID。

例

次の例では、特定のインポート・プロセッサのHAトークンを削除します。

deleteImportHAToken('d:\bills\ha_token.lst')