ヘッダーをスキップ
Oracle® Fusion Middleware WebLogic Scripting Toolコマンド・リファレンス
11gリリース1 (10.3.6)
B55569-05
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次
前
前 		 次
次		  

17 Oracle WebCenter: ImagingカスタムWLSTコマンド

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

次の項では、Oracle WebCenter: Imagingの固有のWLSTコマンドについて説明します。次のトピックがあります。

ImagingのWLSTコマンド・カテゴリの概要

Imaging固有のWLSTコマンドは、次のカテゴリに分かれています。

表17-1 ImagingのWLSTコマンド・カテゴリ

コマンド・カテゴリ 説明

診断コマンド

ワークフロー・エージェントおよびその他の処理情報を返します。

Imagingの構成コマンド

Imaging and Process Managementに固有の設定を構成します。

診断コマンド

表17-2に示すImagingのWLST診断コマンドを使用して、ワークフロー・プロセス中の処理の失敗を一覧表示し、編成します。

表17-2 Imagingの診断コマンド

コマンド 説明 WLSTの使用状況

clearIPMWorkflowFaults

ワークフロー・エージェントの処理中に発生した処理の失敗をクリアします。

オンライン

listIPMWorkflowFaults

ワークフロー・エージェントの処理中に発生した処理の失敗の詳細を提供します。

オンライン

repairIPMWorkflowFaults

ワークフロー・エージェントの処理中に発生した処理の失敗を修復します。

オンライン

sumIPMWorkflowFaults

ワークフロー・エージェントの処理中の処理の失敗を、日付、アプリケーションIDまたはバッチIDによってグループ化してカウントします。

オンライン

resetIpmDMSMetrics

DMSメトリックをゼロにリセットします。

オンライン

clearIPMWorkflowFaults

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オンライン

説明

ワークフロー・エージェントの処理中に発生した処理の失敗をクリアします。

構文

clearIPMWorkflowFaults([startDate], [endDate], [appId], [batchId])
引数 定義 
startDate

オプション。エラー詳細を修復する必要がある日付範囲の開始日(yyyy-MM-dd形式)。

 
endDate

オプション。エラー詳細を修復する必要がある日付範囲の終了日(yyyy-MM-dd形式)。

 
appId

オプション。エラー詳細を修復する必要があるアプリケーションID(yyyy-MM-dd形式)。

 
batchId

オプション。エラー詳細を修復する必要があるバッチID。

例

次の例では、指定したパラメータ内のフォルトをクリアします。

clearIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02")
clearIPMWorkflowFaults(appId=3)
clearIPMWorkflowFaults(batchId=15)
clearIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02", appid=3)

listIPMWorkflowFaults

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オンライン

説明

ワークフロー・エージェントの処理中に発生した処理の失敗の詳細を一覧表示します。

構文

listIPMWorkflowFaults([startDate], [endDate], [appId], [batchId])
引数 定義 
startDate

オプション。エラー詳細を修復する必要がある日付範囲の開始日(yyyy-MM-dd形式)。

 
endDate

オプション。エラー詳細を修復する必要がある日付範囲の終了日(yyyy-MM-dd形式)。

 
appId

オプション。エラー詳細を修復する必要があるアプリケーションID。

 
batchId

オプション。エラー詳細を修復する必要があるバッチID。

例

次の例では、指定したパラメータ内のフォルトを一覧表示します。

listIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02")
listIPMWorkflowFaults(appId=3)
listIPMWorkflowFaults(batchId=15)
listIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02", appId=3)

repairIPMWorkflowFaults

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オンライン

説明

ワークフロー・エージェントの処理中に発生した処理の失敗を修復します。

構文

repairIPMWorkflowFaults([startDate], [endDate], [appId], [batchId])
引数 定義 
startDate

オプション。エラー詳細を修復する必要がある日付範囲の開始日(yyyy-MM-dd形式)。

 
endDate

オプション。エラー詳細を修復する必要がある日付範囲の終了日(yyyy-MM-dd形式)。

 
appId

オプション。エラー詳細を修復する必要があるアプリケーションID。

 
batchId

オプション。エラー詳細を修復する必要があるバッチID。

例

次の例では、指定したパラメータ内のフォルトを修復します。

repairIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02")
repairIPMWorkflowFaults(appId=3)
repairIPMWorkflowFaults(batchId=15)
repairIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02", appid=3)

sumIPMWorkflowFaults

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オンライン

説明

ワークフロー・エージェントの処理中に発生した処理の失敗のカウントを提供します。結果は、日付、アプリケーションIDまたはバッチIDによってグループ化されます。

構文

sumIPMWorkflowFaults(group)
引数 定義 
groupOption

必須。次のうちいずれか。

  • DATE: 日付でグループ化されたフォルト・カウントを返します。

  • APPID: アプリケーションIDでグループ化されたフォルト・カウントを返します。

  • BATCHID: バッチIDでグループ化されたフォルト・カウントを返します。

例

次の例では、最初に日付で、次にアプリケーションIDで、そしてバッチIDでグループ化されたすべてのワークフロー・フォルトを返します。

sumIPMWorkflowFaults(group="DATE")
sumIPMWorkflowFaults(group="APPID")
sumIPMWorkflowFaults(group="BATCHID")

resetIpmDMSMetrics

コマンド・カテゴリ: 診断コマンド

WLSTの使用状況:オンライン

説明

I/PMと関連付けられているすべてのDynamic Monitoring Server (DMS)メトリックをゼロにリセットします。これは、通常、管理者が、履歴パフォーマンス・データによって現在の結果に歪みが生じていることを見つけた場合に行われます。

構文

resetIpmDMSMetrics()

例

次の例では、すべてのDMSメトリックをゼロにリセットします。

resetIpmDMSMetrics()

Imagingの構成コマンド

表17-3に示すImagingの構成コマンドを使用して、Imagingに固有の構成値を一覧表示および設定します。

表17-3 Imagingの構成コマンド

コマンド 説明 WLSTの使用状況

createIPMConnection

接続定義ファイルから新しいImagingの接続を作成します。

オンライン

getIPMConfig

カスタムImaging構成MBeanに移動して標準WLST setコマンドを使用する場合と同様に、Imaging構成設定値を取得します。

オンライン

grantIPMCredAccess

Imaging管理対象サーバーが、管理サーバーとは別のドメイン・ホームにある場合に、ImagingにCredentialAccessPermissionsを付与します。

オンライン

importIPMApplication

前にエクスポートされた定義ファイルからアプリケーション定義をインポートします。

オンライン

importIPMInput

前にエクスポートされた定義ファイルから入力定義をインポートします。

オンライン

importIPMSearch

前にエクスポートされた定義ファイルから検索定義をインポートします。

オンライン

listIPMConfig

Imaging構成MBeanを一覧表示します。

オンライン

listIPMExportFile

エクスポートされたImaging定義ファイルの内容を一覧表示します。

オンライン

refreshIPMSecurity

Imagingデータベースに現在格納されているセキュリティ・アイテムをリフレッシュします。

オンライン

setIPMConfig

Imagingの構成値を設定します。

オンライン

submitIPMToWorkflow

ドキュメントをワークフロー・エージェントに送信します。

オンライン

createIPMConnection

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

接続定義ファイルから新しいImagingの接続を作成します。接続定義ファイルはXMLファイルであり、Imaging ConnectionService WebサービスAPIスキーマ定義からConnection要素タイプを使用して、単一のImaging接続定義を記述します。このスキーマは、次のURLを使用して実行されるImagingサーバーから使用できます。

http://ipm_server_machine:ipm_server_port/imaging/ws/ConnectionService?xsd=1

接続定義ファイル・フォーマットの詳細は、Oracle WebCenter Content Imaging管理者ガイドを参照してください。

構文

createIPMConnection(connectionFile)
引数 定義 
connectionFile

必須。Imagingサーバー・ノード上の接続定義ファイルの場所のフルパス。単一または二重の引用符で囲む必要があります。

例

次の例では、指定された属性に基づいて接続を作成します。

createIPMConnection(connectionFile="/home/ipmuser/localCSConnection.xml")

getIPMConfig

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

Imagingの構成設定値を取得します。このコマンドは、カスタムMBean階層を参照してImaging構成MBeanに移動し、標準WLST setコマンドを使用してMBean属性を設定する場合と同じです。

構文

getIPMConfig(attrName)
引数 定義 
attrName

必須。読み取る属性の名前。単一または二重の引用符で囲む必要があります。

例

次の例では、指定した属性名の値を返します。

getIPMConfig('AgentUser')getIPMConfig('CheckInterval')

grantIPMCredAccess

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

Imagingが資格証明ストアから資格証明を読み取れるようにCredentialAccessPermissionsを付与します。このコマンドは、Imaging管理対象サーバーが、管理サーバーとは別のドメイン・ホームに配置されている場合の構成に必要です。少なくとも1つのImaging管理対象サーバーが管理サーバーと同じドメイン・ホームに配置されている場合、Imagingの起動中にCredentialAccessPermissionsが付与されるため、このコマンドは不要です。

ただし、Imaging管理対象サーバーが管理サーバーと同じドメインにない場合は、Imagingの起動によって、そのローカル設定にのみ作用する権限が付与されます。ローカル設定は管理サーバーがそのコピーをドメイン全体の構成として同期する際に上書きされます。このコマンドは、権限がすべてのドメイン・ノードに適切に配分されるように管理サーバー構成を更新します。

構文

grantIPMCredAccess()

例

次の例では、すべてのImaging構成Mbeanのリストを返します。

grantIPMCredAccess()

importIPMApplication

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

前にエクスポートされた定義ファイルからアプリケーション定義をインポートします。

構文

importIPMApplication(exportFile, action, name, repository, securityOption, securityMember, docSecurityOption, docSecurityGroup, storageOption, storageVolume)
引数 定義 
exportFile

必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。単一または二重の引用符で囲む必要があります。

 
action

必須。実行するアクション。実行可能なアクションは次のとおりです。

  • Add: 新規入力を作成します。同じ名前のアプリケーションがすでに存在する場合は失敗します。

  • Update: 既存の入力を変更します。同じ名前のアプリケーションが存在しない場合は失敗します。

  • AddOrUpdate: まだ存在していない場合は新規アプリケーションを作成します。存在する場合はそれを更新します。

 
name

必須。エクスポートされた定義ファイルからインポートするアプリケーションの名前。

 
repository

そのアプリケーションを作成するリポジトリの名前。アプリケーションを追加する場合は必須であり、アプリケーションを更新または変更する場合は無視されます。

 
securityOption

オプション。インポートされるアプリケーションのセキュリティを定義する方法を次のように指定します。

  • Existing: 既存の定義で定義されているアプリケーション・セキュリティを使用します。更新アクションの場合にのみ有効です。

  • Imported: インポート・ファイルで定義されているアプリケーション・セキュリティの使用を試みます。インポート・ファイルに定義されているメンバーのいずれかが無効な場合は失敗します。

  • ValidOnly: インポート・ファイルで定義されているアプリケーション・セキュリティを使用し、無効なメンバーをすべてフィルタで除外します。

  • CurrentUser: サーバーに接続するために使用するユーザーに完全な権限を設定します。

  • User: securityMemberパラメータで指定されているユーザー名に完全な権限を設定します。

  • Group: securityMemberパラメータで指定されているグループ名に完全な権限を設定します。

 
securityMember

アプリケーションに対する完全な権限を付与されるユーザーまたはグループの名前。securityOptionをUserまたはGroupのいずれかに設定した場合にのみ有効であり、それ以外の場合は無視されます。

 
docSecurityOption

オプション。インポートされるアプリケーションのドキュメント・セキュリティを定義する方法を指定します。

  • Existing: 既存のアプリケーションで定義されているドキュメント・セキュリティを使用します。更新アクションの場合にのみ有効です。

  • Imported: インポート・ファイルで定義されているドキュメント・セキュリティの使用を試みます。インポート・ファイルに定義されているメンバーのいずれかが無効な場合は失敗します。

  • ValidOnly: インポート・ファイルで定義されているドキュメント・セキュリティを使用し、無効なメンバーをすべてフィルタで除外します。

  • Group: docSecurityGroupパラメータで指定されているグループ名に完全な権限を設定します。

 
docSecurityGroup

ドキュメント・セキュリティに対する完全な権限を付与されるグループの名前。docSecurityOptionをGroupに設定した場合にのみ有効であり、それ以外の場合は無視されます。

 
storageOption

オプション。インポートされるアプリケーションの記憶域ポリシーを定義する方法を指定します。

  • Existing: 既存のアプリケーションで定義されているドキュメント記憶域ポリシーを使用します。更新アクションの場合にのみ有効です。

  • Imported: インポート・ファイルで定義されている記憶域ポリシーの使用を試みます。

  • Volume: storageVolumeパラメータで指定されている特定のボリュームを使用します。

  • Default: システム・デフォルト・ボリュームを使用するための記憶域ポリシーを設定します。

 
storageVolume

必須。記憶域ポリシーを設定するボリューム。VolumeのstorageOptionが使用される場合にのみ有効です。それ以外の場合は無効です。

例

次の例では、Invoicesという名前の既存のアプリケーションを更新します。更新アクションでは、元のアプリケーションで指定されているリポジトリが使用されるため、リポジトリはNoneと示されます。

importIPMApplication(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", repository=None, securityOption="Existing")

例

次の例では、Receiptsという名前の新規アプリケーションを作成します。追加アクションでは、有効なリポジトリを指定する必要があるため、リポジトリは明示的に指定されています。

importIPMApplication(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", repository="LocalCS", securityOption="ValidOnly")

importIPMInput

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

前にエクスポートされた定義ファイルから入力定義をインポートします。

構文

importIPMInput(exportFile, action, name, securityOption, securityMember)
)
引数 定義 
exportFile

必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。単一または二重の引用符で囲む必要があります。

 
action

必須。実行するアクション。実行可能なアクションは次のとおりです。

  • Add: 新規入力を作成します。同じ名前の入力がすでに存在する場合は失敗します。

  • Update: 既存の入力を変更します。同じ名前の入力が存在しない場合は失敗します。

  • AddOrUpdate: まだ存在していない場合は新規アプリケーションを作成します。存在する場合はそれを更新します。

 
name

必須。エクスポートされた定義ファイルからインポートする入力の名前。

 
repository

そのアプリケーションを作成するリポジトリの名前。アプリケーションを追加する場合は必須であり、アプリケーションを更新または変更する場合は無視されます。

 
securityOption

オプション。インポートされるアプリケーションのセキュリティを定義する方法を次のように指定します。

  • Existing: 既存の定義で定義されている入力セキュリティを使用します。更新アクションの場合にのみ有効です。

  • Imported: インポート・ファイルで定義されている入力セキュリティの使用を試みます。インポート・ファイルに定義されているメンバーのいずれかが無効な場合は失敗します。

  • ValidOnly: インポート・ファイルで定義されている入力セキュリティを使用し、無効なメンバーをすべてフィルタで除外します。

  • CurrentUser: サーバーに接続するために使用するユーザーに完全な権限を設定します。

  • User: securityMemberパラメータで指定されているユーザー名に完全な権限を設定します。

  • Group: securityMemberパラメータで指定されているグループ名に完全な権限を設定します。

 
securityMember

入力に対する完全な権限を付与されるユーザーまたはグループの名前。securityOptionをUserまたはGroupのいずれかに設定した場合にのみ有効であり、それ以外の場合は無視されます。

例

次の例では、Invoicesという名前の既存の入力を更新します。更新アクションでは、元のアプリケーションで指定されているリポジトリが使用されるため、リポジトリはNoneと示されます。

importIPMInput(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", securityOption="Existing")

例

次の例では、Receiptsという名前の新規入力を作成します。追加アクションでは、有効なリポジトリを指定する必要があるため、リポジトリは明示的に指定されています。

importIPMInput(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", securityOption="ValidOnly")

importIPMSearch

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

前にエクスポートされた定義ファイルから検索定義をインポートします。

構文

importIPMSearch(exportFile, action, name, securityOption, securityMember)
引数 定義 
exportFile

必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。単一または二重の引用符で囲む必要があります。

 
action

必須。実行するアクション。実行可能なアクションは次のとおりです。

  • Add: 新規検索を作成します。同じ名前の検索がすでに存在する場合は失敗します。

  • Update: 既存の検索を変更します。同じ名前の検索が存在しない場合は失敗します。

  • AddOrUpdate: まだ存在していない場合は新規検索を作成します。存在する場合はそれを更新します。

 
name

必須。エクスポートされた定義ファイルからインポートする検索の名前。

 
repository

そのアプリケーションを作成するリポジトリの名前。アプリケーションを追加する場合は必須であり、アプリケーションを更新または変更する場合は無視されます。

 
securityOption

オプション。インポートされるアプリケーションのセキュリティを定義する方法を次のように指定します。

  • Existing: 既存の定義で定義されている検索セキュリティを使用します。更新アクションの場合にのみ有効です。

  • Imported: インポート・ファイルで定義されている検索セキュリティの使用を試みます。インポート・ファイルに定義されているメンバーのいずれかが無効な場合は失敗します。

  • ValidOnly: インポート・ファイルで定義されている検索セキュリティを使用し、無効なメンバーをすべてフィルタで除外します。

  • CurrentUser: サーバーに接続するために使用するユーザーに完全な権限を設定します。

  • User: securityMemberパラメータで指定されているユーザー名に完全な権限を設定します。

  • Group: securityMemberパラメータで指定されているグループ名に完全な権限を設定します。

 
securityMember

検索に対する完全な権限を付与されるユーザーまたはグループの名前。securityOptionをUserまたはGroupのいずれかに設定した場合にのみ有効であり、それ以外の場合は無視されます。

例

次の例では、Invoicesという名前の既存の検索を更新します。更新アクションでは、元のアプリケーションで指定されているリポジトリが使用されるため、リポジトリはNoneと示されます。

importIPMSearch(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", securityOption="Existing")

例

次の例では、Receiptsという名前の新規検索を作成します。追加アクションでは、有効なリポジトリを指定する必要があるため、リポジトリは明示的に指定されています。

importIPMSearch(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", securityOption="ValidOnly")

listIPMConfig

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

Imaging構成MBeanの一覧を提供します。このコマンドは、カスタムMBean階層を参照し、Imaging MBean属性を一覧表示する場合と同じです。

構文

listIPMConfig()

例

次の例では、すべてのImaging構成Mbeanのリストを返します。

listIPMConfig()

listIPMExportFile

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

エクスポートされたImaging定義ファイルの内容を一覧表示します。

構文

listIPMExportFile(exportFile="<path to file>")
引数 定義 
exportFile

必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。単一または二重の引用符で囲む必要があります。

例

次の例では、Imaging定義ファイルの内容を返します。

listIPMExportFile(exportFile="/home/ipmuser/exportdefinitions.xml")

refreshIPMSecurity

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

Imagingデータベースに現在格納されているセキュリティ・アイテムをリフレッシュします。これは通常、異なるポリシー・ストアにセキュリティを移行し、新しいポリシー・ストア内に見つかったセキュリティ・アイテムのみを更新する場合に実行します。

構文

refreshIPMSecurity()

例

次の例では、Imagingデータベースに格納されているセキュリティ・アイテムをリフレッシュします。

refreshIPMSecurity()

setIPMConfig

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

Imagingの構成設定値を設定します。このコマンドは、カスタムMBean階層を参照してImaging構成MBeanに移動し、標準WLST 'set'コマンドを使用してMBean属性を設定する場合と同じです。

構文

setIPMConfig(attrName, value)
引数 定義 
attrName

必須。設定する属性の名前。単一または二重の引用符で囲む必要があります。

 
value

必須。設定する属性の値。値が文字列リテラルである場合にのみ、単一または二重引用符で囲みます。

例

次の例では、指定した属性名に指定した値を設定します。

setIPMConfig('AgentUser', 'agentadmin')setIPMConfig('CheckInterval', 30)

submitIPMToWorkflow

コマンド・カテゴリ: Imagingの構成コマンド

WLSTの使用状況:オンライン

説明

ドキュメントをワークフロー・エージェントに送信します。ドキュメントが送信されたことを示す確認メッセージが表示されますが、ドキュメントがワークフローで構成されていないアプリケーションに格納されている場合、アクションは実行されません。

構文

submitIPMToWorkflow(documentId)
引数 定義 
documentId

必須。送信されたドキュメントの一意のドキュメントID。

例

次の例では、ドキュメントをワークフローに送信します。

submitIPMToWorkflow(documentId="2.IPM_12345")
  前
前 		 次
次
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次