4 Oracle WebCenter Content: ImagingカスタムWLSTコマンド
次の項では、Oracle WebCenter Content: Imagingの固有のWLSTコマンドについて説明します。内容は次のとおりです。
4.1 ImagingのWLSTコマンド・カテゴリの概要
Imaging固有のWLSTコマンドは、次のカテゴリに分かれています。
表4-1 ImagingのWLSTコマンド・カテゴリ
コマンド・カテゴリ | 説明 |
---|---|
ワークフロー・エージェントおよびその他の処理情報を返します。 |
|
Imaging and Process Managementに固有の設定を構成します。 |
4.2 診断コマンド
表4-2に示すImagingのWLST診断コマンドを使用して、ワークフロー・プロセス中の処理の失敗を一覧表示し、編成します。
表4-2 Imagingの診断コマンド
使用するコマンド | 目的 | WLSTでの使用 |
---|---|---|
ワークフロー・エージェントの処理中に発生した処理の失敗をクリアします。 |
オンライン |
|
入力されたドキュメントのワークフロー・エージェントの処理中に発生した処理の失敗をクリアします。 |
オンライン |
|
ワークフロー・エージェントの処理中に発生した処理の失敗の詳細を提供します。 |
オンライン |
|
ワークフロー・エージェントの処理中に発生した処理の失敗を修復します。 |
オンライン |
|
入力されたドキュメントのワークフロー・エージェントの処理中に発生した処理の失敗を修復します。 |
オンライン |
|
ワークフロー・エージェントの処理中の処理の失敗を、日付、アプリケーションIDまたはバッチIDによってグループ化してカウントします。 |
オンライン |
|
DMSメトリックをゼロにリセットします。 |
オンライン |
4.2.1 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)
4.2.2 clearIPMWorkflowFaultsByDocId
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
入力されたドキュメントのワークフロー・エージェントの処理中に発生した処理の失敗をクリアします。
構文
clearIPMWorkflowFaultsByDocId(docIds=<list of docIds>)
引数 | 定義 |
---|---|
docIds |
必須。クリアする対象の処理エラーのドキュメントIDのリスト。 |
例
次の例では、指定したパラメータ内のフォルトをクリアします。
clearIPMWorkflowFaultsByDocId(docIds=<list of docIds>)
4.2.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)
4.2.4 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)
4.2.5 repairIPMWorkflowFaultsByDocId
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
入力されたドキュメントのワークフロー・エージェントの処理中に発生した処理の失敗を修復します。修復するドキュメントの数によっては、この操作に時間がかかる場合があります。
構文
repairIPMWorkflowFaultsByDocId(docIds=<list of docIds>)
引数 | 定義 |
---|---|
docIds |
必須。修復する対象の処理エラーのドキュメントIDのリスト。 |
例
次の例では、指定したパラメータ内のフォルトを修復します。
repairIPMWorkflowFaultsByDocId(docIds=<list document ids>)
4.2.6 sumIPMWorkflowFaults
コマンド・カテゴリ: 診断コマンド
WLSTでの使用: オンライン
説明
ワークフロー・エージェントの処理中に発生した処理の失敗のカウントを提供します。結果は、日付、アプリケーションIDまたはバッチIDによってグループ化されます。
構文
sumIPMWorkflowFaults(group)
引数 | 定義 |
---|---|
groupOption |
必須。次のうちの1つ。
|
例
次の例では、最初に日付で、次にアプリケーションIDで、そしてバッチIDでグループ化されたすべてのワークフロー・フォルトを返します。
sumIPMWorkflowFaults(group="DATE") sumIPMWorkflowFaults(group="APPID") sumIPMWorkflowFaults(group="BATCHID")
4.3 Imagingの構成コマンド
表4-3に示すImagingの構成コマンドを使用して、Imagingに固有の構成値を一覧表示および設定します。
表4-3 Imagingの構成コマンド
使用するコマンド | 目的 | WLSTでの使用 |
---|---|---|
接続定義ファイルから新しいImagingの接続を作成します。 |
オンライン |
|
接続定義ファイルからOracle WebCenter Content: Imaging接続を変更します。 |
オンライン |
|
カスタムImaging構成MBeanに移動して標準WLST setコマンドを使用する場合と同様に、Imaging構成設定値を取得します。 |
オンライン |
|
Oracle WebCenter Content: Imaging MBeanパラメータのパラメータ制限をリストします。 |
オンライン |
|
Imaging管理対象サーバーが、管理サーバーとは別のドメイン・ホームにある場合に、ImagingにCredentialAccessPermissionsを付与します。 |
オンライン |
|
前にエクスポートされた定義ファイルからアプリケーション定義をインポートします。 |
オンライン |
|
前にエクスポートされた定義ファイルから入力定義をインポートします。 |
オンライン |
|
前にエクスポートされた定義ファイルから検索定義をインポートします。 |
オンライン |
|
Imaging構成MBeanを一覧表示します。 |
オンライン |
|
APPLICATIONS、SEARCHES、INPUTSのいずれか1つのタイプに対するシステム上の定義をリストします。 |
オンライン |
|
エクスポートされたImaging定義ファイルの内容を一覧表示します。 |
オンライン |
|
Imagingデータベースに現在格納されているセキュリティ・アイテムをリフレッシュします。 |
オンライン |
|
Imagingの構成値を設定します。 |
オンライン |
|
ドキュメントをワークフロー・エージェントに送信します。 |
オンライン |
4.3.1 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")
4.3.2 modifyIPMConnection
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
接続定義ファイルからOracle WebCenter Content: Imaging接続を変更します。
接続定義ファイルはXMLファイルであり、Oracle WebCenter Content: Imaging ConnectionService WebサービスAPIスキーマ定義からConnection要素タイプを使用して、単一のOracle WebCenter Content: Imaging接続定義を記述します。このスキーマは、次のURLを使用して実行中のOracle WebCenter Content: Imagingサーバーから入手できます。
http://ipm_server_machine:ipm_server_port/imaging/ws/ConnectionService?xsd=1
接続定義のファイル形式の詳細は、『Oracle WebCenter Content: Imagingの管理』の接続の管理に関する項を参照してください。
構文
modifyIPMConnection(connectionFile)
引数 | 定義 |
---|---|
connectionFile |
必須。Imagingサーバー・ノード上の接続定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります |
例
次の例では、指定された属性に基づいて接続を変更します。
modifyIPMConnection(connectionFile="/home/ipmuser/localCSConnection.xml")
4.3.3 getIPMConfig
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
Imagingの構成設定値を取得します。このコマンドは、カスタムMBean階層を参照してImaging構成MBeanに移動し、標準WLST setコマンドを使用してMBean属性を設定する場合と同じです。
構文
getIPMConfig(attrName)
引数 | 定義 |
---|---|
attrName |
必須。読み取る属性の名前。一重または二重の引用符で囲む必要があります。 |
例
次の例では、指定した属性名の値を返します。
getIPMConfig('AgentUser')getIPMConfig('CheckInterval')
4.3.4 getIPMParamLimits
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
Oracle WebCenter Content: Imaging MBeanパラメータのパラメータ制限をリストします。Imaging Mbeanパラメータに適用できる制限の配列を返します。
構文
getIPMParamLimits(paramName="<MBean parameter name>")
引数 | 定義 |
---|---|
paramName |
オプション。制限を返す先のMBeanパラメータ名。設定しない場合、すべての有効なパラメータ名が返されます。 |
例
次の例では、指定した属性名の制限を返します。
getIPMParamLimits("UIMaxSearchResults") getIPMParamLimits("InputAgentCheckInterval") getIPMParamLimits()
4.3.5 grantIPMCredAccess
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
Imagingが資格証明ストアから資格証明を読み取れるようにCredentialAccessPermissionsを付与します。このコマンドは、Imaging管理対象サーバーが、管理サーバーとは別のドメイン・ホームに配置されている場合の構成に必要です。少なくとも1つのImaging管理対象サーバーが管理サーバーと同じドメイン・ホームに配置されている場合、Imagingの起動中にCredentialAccessPermissionsが付与されるため、このコマンドは不要です。
ただし、Imaging管理対象サーバーが管理サーバーと同じドメインにない場合は、Imagingの起動によって、そのローカル設定にのみ作用する権限が付与されます。ローカル設定は管理サーバーがそのコピーをドメイン全体の構成として同期する際に上書きされます。このコマンドは、パーミッションがすべてのドメイン・ノードに適切に配分されるように管理サーバー構成を更新します。
構文
grantIPMCredAccess()
例
次の例では、すべてのImaging構成Mbeanのリストを返します。
grantIPMCredAccess()
4.3.6 importIPMApplication
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
前にエクスポートされた定義ファイルからアプリケーション定義をインポートします。
構文
importIPMApplication(exportFile, action, name, repository, securityOption, securityMember, docSecurityOption, docSecurityGroup, storageOption, storageVolume)
引数 | 定義 |
---|---|
exportFile |
必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります。 |
action |
必須。実行するアクション。使用可能なアクションは次のとおりです。
|
name |
必須。エクスポートされた定義ファイルからインポートするアプリケーションの名前。 |
repository |
そのアプリケーションを作成するリポジトリの名前。アプリケーションを追加する場合は必須であり、アプリケーションを更新または変更する場合は無視されます。 |
securityOption |
オプション。インポートされるアプリケーションのセキュリティを定義する方法を次のように指定します。
|
securityMember |
アプリケーションに対する完全なパーミッションを付与されるユーザーまたはグループの名前。securityOptionをUserまたはGroupのいずれかに設定した場合にのみ有効であり、それ以外の場合は無視されます。 |
docSecurityOption |
オプション。インポートされるアプリケーションのドキュメント・セキュリティを定義する方法を指定します。
|
docSecurityGroup |
ドキュメント・セキュリティに対する完全なパーミッションを付与されるグループの名前。docSecurityOptionをGroupに設定した場合にのみ有効であり、それ以外の場合は無視されます。 |
storageOption |
オプション。インポートされるアプリケーションの記憶域ポリシーを定義する方法を指定します。
|
storageVolume |
必須。記憶域ポリシーを設定するボリューム。VolumeのstorageOptionが使用される場合にのみ有効です。それ以外の場合は無視されます。 |
例1
次の例では、Invoicesという名前の既存のアプリケーションを更新します。更新アクションでは、元のアプリケーションで指定されているリポジトリが使用されるため、リポジトリはNoneと示されます。
importIPMApplication(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", repository=None, securityOption="Existing")
例2
次の例では、Receiptsという名前の新規アプリケーションを作成します。追加アクションでは、有効なリポジトリを指定する必要があるため、リポジトリは明示的に指定されています。
importIPMApplication(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", repository="LocalCS", securityOption="ValidOnly")
4.3.7 importIPMInput
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
前にエクスポートされた定義ファイルから入力定義をインポートします。
構文
importIPMInput(exportFile, action, name, securityOption, securityMember)
引数 | 定義 |
---|---|
exportFile |
必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります。 |
action |
必須。実行するアクション。使用可能なアクションは次のとおりです。
|
name |
必須。エクスポートされた定義ファイルからインポートする入力の名前。 |
repository |
そのアプリケーションを作成するリポジトリの名前。アプリケーションを追加する場合は必須であり、アプリケーションを更新または変更する場合は無視されます。 |
securityOption |
オプション。インポートされるアプリケーションのセキュリティを定義する方法を次のように指定します。
|
securityMember |
入力に対する完全なパーミッションを付与されるユーザーまたはグループの名前。securityOptionをUserまたはGroupのいずれかに設定した場合にのみ有効であり、それ以外の場合は無視されます。 |
例1
次の例では、Invoicesという名前の既存の入力を更新します。更新アクションでは、元のアプリケーションで指定されているリポジトリが使用されるため、リポジトリはNoneと示されます。
importIPMInput(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", securityOption="Existing")
例2
次の例では、Receiptsという名前の新規入力を作成します。追加アクションでは、有効なリポジトリを指定する必要があるため、リポジトリは明示的に指定されています。
importIPMInput(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", securityOption="ValidOnly")
4.3.8 importIPMSearch
コマンド・カテゴリ: Imagingの構成コマンド
説明
前にエクスポートされた定義ファイルから検索定義をインポートします。
構文
importIPMSearch(exportFile, action, name, securityOption, securityMember)
引数 | 定義 |
---|---|
exportFile |
必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります。 |
action |
必須。実行するアクション。使用可能なアクションは次のとおりです。
|
name |
必須。エクスポートされた定義ファイルからインポートする検索の名前。 |
repository |
そのアプリケーションを作成するリポジトリの名前。アプリケーションを追加する場合は必須であり、アプリケーションを更新または変更する場合は無視されます。 |
securityOption |
オプション。インポートされるアプリケーションのセキュリティを定義する方法を次のように指定します。
|
securityMember |
検索に対する完全なパーミッションを付与されるユーザーまたはグループの名前。securityOptionをUserまたはGroupのいずれかに設定した場合にのみ有効であり、それ以外の場合は無視されます。 |
例1
次の例では、Invoicesという名前の既存の検索を更新します。更新アクションでは、元のアプリケーションで指定されているリポジトリが使用されるため、リポジトリはNoneと示されます。
importIPMSearch(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", securityOption="Existing")
例2
次の例では、Receiptsという名前の新規検索を作成します。追加アクションでは、有効なリポジトリを指定する必要があるため、リポジトリは明示的に指定されています。
importIPMSearch(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", securityOption="ValidOnly")
4.3.9 listIPMConfig
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
Imaging構成MBeanの一覧を提供します。このコマンドは、カスタムMBean階層を参照し、Imaging MBean属性を一覧表示する場合と同じです。
構文
listIPMConfig()
例
次の例では、すべてのImaging構成Mbeanのリストを返します。
listIPMConfig()
4.3.10 listIPMDefinitions
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
APPLICATIONS、SEARCHES、INPUTSのいずれか1つのタイプに対するシステム上の定義をリストします。
構文
listIPMDefinitions(defType="<definition type>")
引数 | 定義 |
---|---|
defType |
必須。APPLICATIONS、SEARCHES、INPUTSのいずれか。この引数では、大文字/小文字は区別されません。
|
例
次の例では、システム上の入力およびアプリケーションのリストを返します。
listIPMDefinitions(defType="INPUTS") listIPMDefinitions(defType="APPLICATIONS")
4.3.11 listIPMExportFile
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
エクスポートされたImaging定義ファイルの内容を一覧表示します。
構文
listIPMExportFile(exportFile="<path to file>")
引数 | 定義 |
---|---|
exportFile |
必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります。 |
例
次の例では、Imaging定義ファイルの内容を返します。
listIPMExportFile(exportFile="/home/ipmuser/exportdefinitions.xml")
4.3.12 refreshIPMSecurity
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
Imagingデータベースに現在格納されているセキュリティ・アイテムをリフレッシュします。これは通常、異なるポリシー・ストアにセキュリティを移行し、新しいポリシー・ストア内に見つかったセキュリティ・アイテムのみを更新する場合に実行します。
構文
refreshIPMSecurity()
例
次の例では、Imagingデータベースに格納されているセキュリティ・アイテムをリフレッシュします。
refreshIPMSecurity()
4.3.13 setIPMConfig
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
Imagingの構成設定値を設定します。このコマンドは、カスタムMBean階層を参照してImaging構成MBeanに移動し、標準WLST 'set'コマンドを使用してMBean属性を設定する場合と同じです。
構文
setIPMConfig(attrName, value)
引数 | 定義 |
---|---|
attrName |
必須。設定する属性の名前。一重または二重の引用符で囲む必要があります。 |
value |
必須。設定する属性の値。値が文字列リテラルである場合にのみ、一重または二重の引用符で囲みます。 |
例
次の例では、指定した属性名に指定した値を設定します。
setIPMConfig('AgentUser', 'agentadmin')setIPMConfig('CheckInterval', 30)
4.3.14 submitIPMToWorkflow
コマンド・カテゴリ: Imagingの構成コマンド
WLSTでの使用: オンライン
説明
ドキュメントをワークフロー・エージェントに送信します。ドキュメントが送信されたことを示す確認メッセージが表示されますが、ドキュメントがワークフローで構成されていないアプリケーションに格納されている場合、アクションは実行されません。
構文
submitIPMToWorkflow(documentId)
引数 | 定義 |
---|---|
documentId |
必須。送信されたドキュメントの一意のドキュメントID。 |
例
次の例では、ドキュメントをワークフローに送信します。
submitIPMToWorkflow(documentId="2.IPM_12345")