Oracle® Fusion Middleware

SOA Suite WLSTコマンド・リファレンス

12c (12.2.1.2.0)

E82921-01(原本部品番号:E68167-02)

2016年10月

Oracle Fusion Middleware SOA Suite WLSTコマンド・リファレンス, 12c (12.2.1.2.0)

E82921-01

Copyright © 2007, 2016, Oracle and/or its affiliates.  All rights reserved.

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクル社までご連絡ください。

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。オラクル社およびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。オラクル社およびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

目次

タイトルおよび著作権情報

はじめに

- ドキュメントのアクセシビリティについて

- 表記規則

1 概要とロードマップ

- 1.1 ドキュメントのスコープと対象読者

- 1.2 このドキュメントの手引き

- 1.3 関連ドキュメント

2 Oracle SOA SuiteのカスタムWLSTコマンド

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

- 2.2 デプロイメント・コマンド

- 2.2.1 sca_deployComposite

- 2.2.1.1 説明

- 2.2.1.2 構文

- 2.2.1.3 例

- 2.2.2 sca_undeployComposite

- 2.2.2.1 説明

- 2.2.2.2 構文

- 2.2.2.3 例

- 2.3 SOAコンポジット・アプリケーションの管理コマンド

- 2.3.1 sca_startComposite

- 2.3.1.1 説明

- 2.3.1.2 構文

- 2.3.1.3 例

- 2.3.2 sca_stopComposite

- 2.3.2.1 説明

- 2.3.2.2 構文

- 2.3.2.3 例

- 2.3.3 sca_activateComposite

- 2.3.3.1 説明

- 2.3.3.2 構文

- 2.3.3.3 例

- 2.3.4 sca_retireComposite

- 2.3.4.1 説明

- 2.3.4.2 構文

- 2.3.4.3 例

- 2.3.5 sca_assignDefaultComposite

- 2.3.5.1 説明

- 2.3.5.2 構文

- 2.3.5.3 例

- 2.3.6 sca_listDeployedComposites

- 2.3.6.1 説明

- 2.3.6.2 構文

- 2.3.6.3 例

- 2.4 構成プラン管理コマンド

- 2.4.1 sca_attachPlan

- 2.4.1.1 説明

- 2.4.1.2 構文

- 2.4.1.3 例

- 2.4.2 sca_extractPlan

- 2.4.2.1 説明

- 2.4.2.2 構文

- 2.4.2.3 例

- 2.4.3 sca_generatePlan

- 2.4.3.1 説明

- 2.4.3.2 構文

- 2.4.3.3 例

- 2.4.4 sca_validatePlan

- 2.4.4.1 説明

- 2.4.4.2 構文

- 2.4.4.3 例

- 2.5 タスク検証コマンド

- 2.5.1 sca_validateTask

- 2.5.1.1 説明

- 2.5.1.2 構文

- 2.5.1.3 例

- 2.6 SOAコンポジット・アプリケーションのコンパイル・コマンド

- 2.6.1 sca_setProp

- 2.6.1.1 説明

- 2.6.1.2 構文

- 2.6.1.3 例

- 2.6.2 sca_compile

- 2.6.2.1 説明

- 2.6.2.2 構文

- 2.6.2.3 例

- 2.7 SOAコンポジット・アプリケーションのパッケージ化コマンド

- 2.7.1 sca_package

- 2.7.1.1 説明

- 2.7.1.2 構文

- 2.7.1.3 例

- 2.8 SOAコンポジット・アプリケーションのテスト・コマンド

- 2.8.1 sca_test

- 2.8.1.1 説明

- 2.8.1.2 構文

- 2.8.1.3 例

- 2.9 SOAコンポジット・アプリケーションのHTTPクライアントベースのエクスポートおよびインポート・コマンド

- 2.9.1 sca_exportComposite

- 2.9.1.1 説明

- 2.9.1.2 構文

- 2.9.1.3 例

- 2.9.2 sca_exportUpdates

- 2.9.2.1 説明

- 2.9.2.2 構文

- 2.9.2.3 例

- 2.9.3 sca_importUpdates

- 2.9.3.1 説明

- 2.9.3.2 構文

- 2.9.3.3 例

- 2.9.4 sca_exportSharedData

- 2.9.4.1 説明

- 2.9.4.2 構文

- 2.9.4.3 例

- 2.9.5 sca_removeSharedData

- 2.9.5.1 説明

- 2.9.5.2 構文

- 2.9.5.3 例

- 2.10 SOAコンポジット・アプリケーションのMBeanベースのエクスポートおよびインポート・コマンド

- 2.10.1 sca_exportCompositeMb

- 2.10.1.1 説明

- 2.10.1.2 構文

- 2.10.1.3 例

- 2.10.2 sca_exportUpdatesMb

- 2.10.2.1 説明

- 2.10.2.2 構文

- 2.10.2.3 例

- 2.10.3 sca_importUpdatesMb

- 2.10.3.1 説明

- 2.10.3.2 構文

- 2.10.3.3 例

- 2.10.4 sca_exportSharedDataMb

- 2.10.4.1 説明

- 2.10.4.2 構文

- 2.10.4.3 例

- 2.11 SOAコンポジット・アプリケーションのパーティション管理コマンド

- 2.11.1 sca_createPartition

- 2.11.1.1 説明

- 2.11.1.2 構文

- 2.11.1.3 例

- 2.11.2 sca_deletePartition

- 2.11.2.1 説明

- 2.11.2.2 構文

- 2.11.2.3 例

- 2.11.3 sca_startCompositesInPartition

- 2.11.3.1 説明

- 2.11.3.2 構文

- 2.11.3.3 例

- 2.11.4 sca_stopCompositesInPartition

- 2.11.4.1 説明

- 2.11.4.2 構文

- 2.11.4.3 例

- 2.11.5 sca_activateCompositesInPartition

- 2.11.5.1 説明

- 2.11.5.2 構文

- 2.11.5.3 例

- 2.11.6 sca_retireCompositesInPartition

- 2.11.6.1 説明

- 2.11.6.2 構文

- 2.11.6.3 例

- 2.11.7 sca_listPartitions

- 2.11.7.1 説明

- 2.11.7.2 構文

- 2.11.7.3 例

- 2.11.8 sca_listCompositesInPartition

- 2.11.8.1 説明

- 2.11.8.2 構文

- 2.11.8.3 例

- 2.11.9 sca_createPartitionWMG

- 2.11.9.1 説明

- 2.11.9.2 構文

- 2.11.9.3 例

- 2.12 SOAコンポジット・アプリケーションのオフライン・デプロイメント管理コマンド

- 2.12.1 sca_registerCompositeOfflineDeployment

- 2.12.1.1 説明

- 2.12.1.2 構文

- 2.12.1.3 例

- 2.12.2 sca_unregisterCompositeOfflineDeployment

- 2.12.2.1 説明

- 2.12.2.2 構文

- 2.12.2.3 例

- 2.13 SOAヘルス・チェック・コマンド

- 2.13.1 executeHealthCheckAndGenerateReport

- 2.13.2 executeHealthCheckCategoryAndGenerateReport

- 2.13.3 executeHealthChecksAndGenerateReport

- 2.13.4 getUnsuccessfulHCRequestIds

- 2.13.5 getUnsuccessfulHCRequestResultReport

- 2.13.6 listHealthChecks

- 2.13.7 listHealthChecksInCategory

- 2.13.8 listHealthCheckCategories

- 2.13.9 deleteAllHCRequestResults

- 2.13.10 deleteHCRequestResults

- 2.13.11 getUnsuccessfulHCResultReport

- 2.13.12 getHCParameter

- 2.13.13 setHCParameter

- 2.13.14 resetHCParameter

- 2.13.15 getHCParameters

- 2.13.16 enableHCStartupRun

- 2.13.17 setHCStartupRunCategory

- 2.13.18 getHCStartupRun

- 2.13.19 createHCPeriodicRun

- 2.13.20 enableHCPeriodicRun

- 2.13.21 setHCPeriodicRunInterval

- 2.13.22 setHCPeriodicRunSchedule

- 2.13.23 setHCPeriodicRunCategory

- 2.13.24 getHCPeriodicRun

- 2.13.25 getHCPeriodicRuns

- 2.13.26 removeHCPeriodicRun

- 2.13.27 getDisabledHealthChecks

- 2.13.28 addDisabledHealthCheck

- 2.13.29 removeDisabledHealthCheck

3 Oracle Business Process ManagementのカスタムWLSTコマンド

- 3.1 BPMLifecycleAdminコマンド・グループ

- 3.1.1 create_public_share

- 3.1.1.1 説明

- 3.1.1.2 構文

- 3.1.1.3 例

- 3.1.2 unlock_public_share

- 3.1.2.1 説明

- 3.1.2.2 構文

- 3.1.2.3 例

- 3.1.3 export_public_share

- 3.1.3.1 説明

- 3.1.3.2 構文

- 3.1.3.3 例

- 3.1.4 delete_public_share

- 3.1.4.1 説明

- 3.1.4.2 構文

- 3.1.4.3 例

- 3.1.5 publish_template

- 3.1.5.1 説明

- 3.1.5.2 構文

- 3.1.5.3 例

- 3.1.6 export_template

- 3.1.6.1 説明

- 3.1.6.2 構文

- 3.1.6.3 例

- 3.1.7 delete_template

- 3.1.7.1 説明

- 3.1.7.2 構文

- 3.1.7.3 例

4 Oracle Enterprise SchedulerのカスタムWLSTコマンド

- 4.1 ネイティブ呼出し

- 4.1.1 プリント文の有効化および無効化

- 4.1.2 ヘルプの利用

- 4.2 Oracle Enterprise Schedulerのカスタム・ネイティブ・コマンド

- 4.2.1 構成パラメータの管理(追加/削除/修正/取得)

- 4.2.1.1 説明

- 4.2.1.2 構文

- 4.2.1.3 例

- 4.2.1.4 関連シェル・スクリプト

- 4.2.2 リクエストのログおよび出力コンテンツの取得

- 4.2.2.1 説明

- 4.2.2.2 構文

- 4.2.2.3 例

- 4.2.2.4 関連シェル・スクリプト

- 4.2.3 リクエストの検索および一覧表示

- 4.2.3.1 説明

- 4.2.3.2 構文

- 4.2.3.3 例

- 4.2.3.4 シェル・スクリプト

- 4.2.4 リクエストの管理

- 4.2.4.1 説明

- 4.2.4.2 構文

- 4.2.4.3 例

- 4.2.4.4 関連シェル・スクリプト

- 4.2.5 Oracle Enterprise Schedulerサーバーの管理

- 4.2.5.1 説明

- 4.2.5.2 構文

- 4.2.5.3 例

- 4.2.5.4 関連シェル・スクリプト

- 4.2.6 Oracle Enterprise Schedulerへのジョブ・リクエストの発行

- 4.2.6.1 説明

- 4.2.6.2 構文

- 4.2.6.3 例

- 4.2.6.4 関連シェル・スクリプト

- 4.2.7 Oracle Enterprise Schedulerのジョブ定義の管理

- 4.2.7.1 説明

- 4.2.7.2 構文

- 4.2.7.3 例

- 4.2.7.4 関連シェル・スクリプト

- 4.2.8 Oracle Enterprise Schedulerのスケジュール定義の管理

- 4.2.8.1 説明

- 4.2.8.2 構文

- 4.2.8.3 例

- 4.2.8.4 関連シェル・スクリプト

- 4.3 Oracle Enterprise Schedulerのバッチ削除リクエスト

- 4.3.1 batchDeleteSchedulerRequestコマンド

- 4.3.1.1 説明

- 4.3.1.2 構文

- 4.3.1.2.1 バッチ削除パラメータ

- 4.3.1.3 例

- 4.3.1.4 関連シェル・スクリプト

- 4.4 作業割当てコマンド

- 4.4.1 addProcessorBinding

- 4.4.1.1 説明

- 4.4.1.2 構文

- 4.4.1.3 例

- 4.4.2 createWorkshift

- 4.4.2.1 説明

- 4.4.2.2 構文

- 4.4.2.3 例

- 4.4.3 deleteWorkAssignment

- 4.4.3.1 説明

- 4.4.3.2 構文

- 4.4.3.3 例

- 4.4.4 deleteWorkshift

- 4.4.4.1 説明

- 4.4.4.2 構文

- 4.4.4.3 例

- 4.4.5 queryProcessorBindings

- 4.4.5.1 説明

- 4.4.5.2 構文

- 4.4.5.3 例

- 4.4.6 queryWorkAssignments

- 4.4.6.1 説明

- 4.4.6.2 構文

- 4.4.6.3 例

- 4.4.7 queryWorkSchedules

- 4.4.7.1 説明

- 4.4.7.2 構文

- 4.4.7.3 例

- 4.4.8 queryWorkshifts

- 4.4.8.1 説明

- 4.4.8.2 構文

- 4.4.8.3 例

- 4.4.9 removeProcessorBinding

- 4.4.9.1 説明

- 4.4.9.2 構文

- 4.4.9.3 例

- 4.4.10 updateWorkshift

- 4.4.10.1 説明

- 4.4.10.2 構文

- 4.4.10.3 例

- 4.5 Oracle Enterprise Schedulerの診断ダンプ

- 4.5.1 ダンプ・コマンド

- 4.5.1.1 executeDump

- 4.5.1.1.1 構文

- 4.5.1.2 listDumps

- 4.5.1.2.1 構文

- 4.5.1.3 describeDump

- 4.5.1.3.1 構文

- 4.5.2 ダンプ例

- 4.5.3 Oracle Enterprise Schedulerのインシデントの作成

- 4.6 Oracle Enterprise Schedulerの便利なスクリプト

- 4.6.1 essManageRuntimeConfig

- 4.6.1.1 構文

- 4.6.1.2 オプション

- 4.6.1.3 関連ファイル

- 4.6.1.4 終了値

- 4.6.1.5 例

- 4.6.1.6 関連ネイティブ・コマンド

- 4.6.2 essGetOutputContent

- 4.6.2.1 構文

- 4.6.2.2 オプション

- 4.6.2.3 関連ファイル

- 4.6.2.4 終了値

- 4.6.2.5 例

- 4.6.2.6 関連ネイティブ・コマンド

- 4.6.3 essQueryRequests

- 4.6.3.1 構文

- 4.6.3.2 オプション

- 4.6.3.3 関連ファイル

- 4.6.3.4 終了値

- 4.6.3.5 例

- 4.6.3.6 関連ネイティブ・コマンド

- 4.6.4 essManageRequests

- 4.6.4.1 構文

- 4.6.4.2 オプション

- 4.6.4.3 関連ファイル

- 4.6.4.4 終了値

- 4.6.4.5 例

- 4.6.4.6 関連ネイティブ・コマンド

- 4.6.5 essManageServer

- 4.6.5.1 構文

- 4.6.5.2 オプション

- 4.6.5.3 関連ファイル

- 4.6.5.4 終了値

- 4.6.5.5 例

- 4.6.5.6 関連ネイティブ・コマンド

- 4.6.6 essSubmitRequest

- 4.6.6.1 構文

- 4.6.6.2 オプション

- 4.6.6.3 関連ファイル

- 4.6.6.4 終了値

- 4.6.6.5 例

- 4.6.6.6 関連ネイティブ・コマンド

- 4.6.7 essManageJobDefn

- 4.6.7.1 構文

- 4.6.7.2 オプション

- 4.6.7.3 関連ファイル

- 4.6.7.4 終了値

- 4.6.7.5 例

- 4.6.7.6 関連ネイティブ・コマンド

- 4.6.8 essManageSchedule

- 4.6.8.1 構文

- 4.6.8.2 オプション

- 4.6.8.3 関連ファイル

- 4.6.8.4 終了値

- 4.6.8.5 例

- 4.6.8.6 関連ネイティブ・コマンド

- 4.6.9 essBatchDeleteRequests

- 4.6.9.1 構文

- 4.6.9.2 オプション

- 4.6.9.3 関連ファイル

- 4.6.9.4 終了値

- 4.6.9.5 例

- 4.6.9.6 関連ネイティブ・コマンド

5 Oracle Managed File TransferのカスタムWLSTコマンド

- 5.1 MFT WLSTコマンド・カテゴリの概要

- 5.2 MFTアーティファクト管理コマンド

- 5.2.1 bulkDeployArtifact

- 5.2.1.1 説明

- 5.2.1.2 構文

- 5.2.1.3 例

- 5.2.2 deleteArtifact

- 5.2.2.1 説明

- 5.2.2.2 構文

- 5.2.2.3 例

- 5.2.3 deleteArtifactDeployment

- 5.2.3.1 説明

- 5.2.3.2 構文

- 5.2.3.3 例

- 5.2.4 deployArtifact

- 5.2.4.1 説明

- 5.2.4.2 構文

- 5.2.4.3 例

- 5.2.5 disableArtifact

- 5.2.5.1 説明

- 5.2.5.2 構文

- 5.2.5.3 例

- 5.2.6 enableArtifact

- 5.2.6.1 説明

- 5.2.6.2 構文

- 5.2.6.3 例

- 5.2.7 exportDeployedArtifact

- 5.2.7.1 説明

- 5.2.7.2 構文

- 5.2.7.3 例

- 5.2.8 isArtifactInMDS

- 5.2.8.1 説明

- 5.2.8.2 構文

- 5.2.8.3 例

- 5.2.9 undeployArtifact

- 5.2.9.1 説明

- 5.2.9.2 構文

- 5.2.9.3 例

- 5.3 MFTメタデータ・コマンド

- 5.3.1 exportMftMetadata

- 5.3.1.1 説明

- 5.3.1.2 構文

- 5.3.1.3 例

- 5.3.2 exportTransferMetadata

- 5.3.2.1 説明

- 5.3.2.2 構文

- 5.3.2.3 例

- 5.3.3 importMftMetadata

- 5.3.3.1 説明

- 5.3.3.2 構文

- 5.3.3.3 例

- 5.3.4 resetMetadata

- 5.3.4.1 説明

- 5.3.4.2 構文

- 5.3.4.3 例

- 5.4 MFT鍵管理コマンド

- 5.4.1 deleteCSFKey

- 5.4.1.1 説明

- 5.4.1.2 構文

- 5.4.1.3 例

- 5.4.2 exportCSFKey

- 5.4.2.1 説明

- 5.4.2.2 構文

- 5.4.2.3 例

- 5.4.3 generateKeys

- 5.4.3.1 説明

- 5.4.3.2 構文

- 5.4.3.3 例

- 5.4.4 importCSFKey

- 5.4.4.1 説明

- 5.4.4.2 構文

- 5.4.4.3 例

- 5.4.5 listCSFKeyAliases

- 5.4.5.1 説明

- 5.4.5.2 構文

- 5.4.5.3 例

- 5.4.6 updateCSFKey

- 5.4.6.1 説明

- 5.4.6.2 構文

- 5.4.6.3 例

- 5.5 MFTデプロイメント履歴コマンド

- 5.5.1 getSourceDeploymentHistory

- 5.5.1.1 説明

- 5.5.1.2 構文

- 5.5.1.3 例

- 5.5.2 getTargetDeploymentHistory

- 5.5.2.1 説明

- 5.5.2.2 構文

- 5.5.2.3 例

- 5.5.3 getTransferDeploymentHistory

- 5.5.3.1 説明

- 5.5.3.2 構文

- 5.5.3.3 例

- 5.6 MFT転送管理コマンド

- 5.6.1 getTransferInfo

- 5.6.1.1 説明

- 5.6.1.2 構文

- 5.6.1.3 例

- 5.6.2 pauseTransfer

- 5.6.2.1 説明

- 5.6.2.2 構文

- 5.6.2.3 例

- 5.6.3 resubmit

- 5.6.3.1 説明

- 5.6.3.2 構文

- 5.6.3.3 例

- 5.6.4 resumeTransfer

- 5.6.4.1 説明

- 5.6.4.2 構文

- 5.6.4.3 例

- 5.7 MFT埋込みサーバー・コマンド

- 5.7.1 ConfigureHomeDir

- 5.7.1.1 説明

- 5.7.1.2 構文

- 5.7.1.3 例

- 5.7.2 grantPermissionToDirectory

- 5.7.2.1 説明

- 5.7.2.2 構文

- 5.7.2.3 例

- 5.7.3 listAllPermissions

- 5.7.3.1 説明

- 5.7.3.2 構文

- 5.7.3.3 例

- 5.7.4 revokePermissionForDirectory

- 5.7.4.1 説明

- 5.7.4.2 構文

- 5.7.4.3 例

- 5.7.5 startEmbeddedServer

- 5.7.5.1 説明

- 5.7.5.2 構文

- 5.7.5.3 例

- 5.7.6 stopEmbeddedServer

- 5.7.6.1 説明

- 5.7.6.2 構文

- 5.7.6.3 例

- 5.7.7 updatePorts

- 5.7.7.1 説明

- 5.7.7.2 構文

- 5.7.7.3 例

- 5.8 MFTコールアウト・コマンド

- 5.8.1 createCallouts

- 5.8.1.1 説明

- 5.8.1.2 構文

- 5.8.1.3 例

- 5.8.2 deleteCallout

- 5.8.2.1 説明

- 5.8.2.2 構文

- 5.8.2.3 例

- 5.8.3 listCallouts

- 5.8.3.1 説明

- 5.8.3.2 構文

- 5.8.3.3 例

- 5.8.4 updateCallouts

- 5.8.4.1 説明

- 5.8.4.2 構文

- 5.8.4.3 例

- 5.9 MFTイベント通知コマンド

- 5.9.1 addContactToNotification

- 5.9.1.1 説明

- 5.9.1.2 構文

- 5.9.1.3 例

- 5.9.2 createContact

- 5.9.2.1 説明

- 5.9.2.2 構文

- 5.9.2.3 例

- 5.9.3 deleteContact

- 5.9.3.1 説明

- 5.9.3.2 構文

- 5.9.3.3 例

- 5.9.4 listContacts

- 5.9.4.1 説明

- 5.9.4.2 構文

- 5.9.4.3 例

- 5.9.5 removeContactFromNotification

- 5.9.5.1 説明

- 5.9.5.2 構文

- 5.9.5.3 例

- 5.9.6 updateEvent

- 5.9.6.1 説明

- 5.9.6.2 構文

- 5.9.6.3 例

- 5.10 MFTアーカイブおよび復元コマンド

- 5.10.1 archiveInstanceData

- 5.10.1.1 説明

- 5.10.1.2 構文

- 5.10.1.3 例

- 5.10.2 restoreInstanceData

- 5.10.2.1 説明

- 5.10.2.2 構文

- 5.10.2.3 例

- 5.10.3 archivePayloads

- 5.10.3.1 説明

- 5.10.3.2 構文

- 5.10.3.3 MBeanプロパティ

- 5.10.3.4 例

- 5.10.4 restorePayloadsByName

- 5.10.4.1 説明

- 5.10.4.2 構文

- 5.10.4.3 MBeanプロパティ

- 5.10.4.4 例

- 5.10.5 restorePayloadsByPrefix

- 5.10.5.1 説明

- 5.10.5.2 構文

- 5.10.5.3 MBeanプロパティ

- 5.10.5.4 例

- 5.11 MFTパージ・コマンド

- 5.11.1 purgeInstanceData

- 5.11.1.1 説明

- 5.11.1.2 構文

- 5.11.1.3 例

- 5.11.2 purgePayloads

- 5.11.2.1 説明

- 5.11.2.2 構文

- 5.11.2.3 MBeanプロパティ

- 5.11.2.4 例

- 5.12 MFT WLSTコマンドのシステムMBeanプロパティの設定

はじめに

ここでは、ドキュメントのアクセシビリティの機能と、このドキュメント(SOA Suite WLSTコマンド・リファレンス)で使用している表記規則について説明します。

ドキュメントのアクセシビリティについて

Oracleのアクセシビリティへの取り組みについては、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)にアクセスしてください。

Oracle Supportへのアクセス

Oracleのお客様は、My Oracle Supportにアクセスして電子サポートを受けることができます。詳細は、http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info、聴覚に障害があるお客様はhttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=trsを参照してください。

表記規則

このマニュアルでは次の表記規則を使用します。

表記規則

意味

太字

太字は、操作に関連するGraphical User Interface要素、または本文中で定義されている用語および用語集に記載されている用語を示します。

イタリック

イタリックは、ユーザーが特定の値を指定するプレースホルダ変数を示します。

固定幅フォント

固定幅フォントは、段落内のコマンド、URL、サンプル内のコード、画面に表示されるテキスト、または入力するテキストを示します。

1 概要とロードマップ

この項では、このガイド(SOA Suite WLSTコマンド・リファレンス)の対象読者および内容と構成について説明します。

- ドキュメントのスコープと対象読者

- このドキュメントの手引き

- 関連ドキュメント

1.1 ドキュメントのスコープと対象読者

このドキュメントでは、WebLogic Scripting Tool (WLST)で使用できる、Oracle SOA Suite、Business Process Management、Enterprise SchedulerおよびManaged File TransferのすべてのWLSTコマンドについて説明します。

注意:

Oracle Fusion Middlewareコンポーネント用のWLSTコマンドは、コンポーネントが ORACLE_HOMEディレクトリにインストールされている場合のみ使用できます。そのため、SOA Suite WLSTコマンドは、SOA Suiteがインストールされている場合のみ使用できます。

このドキュメントは、SOAアプリケーションをデプロイするOracle SOA Suiteの管理者およびオペレータを対象としています。読者は、WebテクノロジおよびWebLogic Server製品およびFusion Middleware製品がインストールされているオペレーティング・システムとプラットフォームに精通していることを前提としています。

1.2 このドキュメントの手引き

このマニュアルの構成は次のとおりです。

- この章「概要とロードマップ」では、このガイドの構成および関連ドキュメントについて説明します。

- 「Oracle SOA SuiteのカスタムWLSTコマンド」では、SOA Suiteの各カスタムWLSTコマンドについて詳細に説明します。

- 「カスタムWLSTコマンド」では、Business Process Management (BPM)の各カスタムWLSTコマンドについて詳細に説明します。

- 「Oracle Enterprise SchedulerのカスタムWLSTコマンド」では、Oracle Enterprise Scheduler (ESS)の各カスタムWLSTコマンドについて詳細に説明します。

- 「カスタムWLSTコマンド」では、Oracle Managed File Transfer (MFT)の各カスタムWLSTコマンドについて詳細に説明します。

1.3 関連ドキュメント

WebLogic Scripting Toolの使用方法については、『WebLogic Scripting Toolの理解』を参照してください。

その他のWLSTコマンドおよびその他のWebLogic Server管理インタフェースについては、次を参照してください。

- 『WebLogic Server WLSTコマンド・リファレンス』では、WebLogic ServerのWLSTコマンドについて説明しています。

- インフラストラクチャ・コンポーネントWLSTコマンド・リファレンスは、Java Required Files (JRF)、Webサービス、Metadata Services (MDS)、Application Development Framework (ADF)、ダイナミック・モニタリング・サービス(DMS)、ロギング、診断フレームワーク、User Messaging Service (UMS)およびEnterprise Scheduling Service (ESS)などの、Oracle Fusion Middlewareのコア・コンポーネントで使用可能なWLSTコマンドについて説明しています。

- インフラストラクチャ・セキュリティWLSTコマンド・リファレンスでは、監査、SSL、Oracle Identity Federation、Directory Integration Platform、Oracle Access Management (OAM)、Oracle Security Token ServiceおよびOracle Keystore Serviceを含むOracle Fusion Middlewareインフラストラクチャのセキュリティ・コンポーネントで使用可能なWLSTコマンドについて説明しています。

- 『WebCenter WLSTコマンド・リファレンス』では、WebCenter Portal、WebCenter Content、WebCenter Information Rights Management (IRM)およびWebCenter Imaging Process Management (IPM)を含むWebCenterコンポーネントに使用できるWLSTコマンドについて説明しています。

- Oracle WebLogic Serverアプリケーションの開発のAntタスクを使用したWebLogic Serverドメインの構成と使用に関する項では、WebLogic Serverインスタンスの起動および停止とWebLogicドメインを構成するためのWebLogic Antタスクの使用について説明しています。

- Oracle WebLogic Serverへのアプリケーションのデプロイのデプロイメント・ツールに関する項では、アプリケーションおよびスタンドアロン・モジュールのデプロイ用にWebLogic Serverで提供されているいくつかのツールについて説明しています。

- 管理コンソール・オンライン・ヘルプでは、WebLogicドメインを管理およびモニタリングするためのWebベースのグラフィカル・ユーザー・インタフェースについて説明しています。

- 『構成ウィザードによるWebLogicドメインの作成』では、グラフィカル・ユーザー・インタフェースを使用したWebLogicドメインの作成または既存ドメインの拡張について説明しています。

- 「PackおよびUnpackコマンドを使用したテンプレートとドメインの作成」: 既存のWebLogicドメインをすばやく簡単に再作成するコマンドについて説明します。

- 『Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』: Java Management Extensions (JMX) APIを使用してWebLogic Serverリソースをモニターおよび変更する方法について説明します。

- 『SNMPによるOracle WebLogic Serverのモニタリング』: Simple Network Management Protocol (SNMP)を使用してWebLogicドメインをモニターする方法について説明します。

2 Oracle SOA SuiteのカスタムWLSTコマンド

この章では、Oracle SOA SuiteのWLSTコマンドについて説明します。これらのコマンドを使用すると、WLSTを使用してSOAコンポジット・アプリケーションを構成できます。

注意:

これらのコマンドを使用するには、SOA_HOME/common/binからWLSTを起動する必要があります。

WLSTには、オフライン・モードとオンライン・モードの両方があります。オフライン・コマンドは、管理サーバーに接続せずに使用できます。最初にWLSTを起動する際は、オフライン・モードになっています。オンライン・モード・コマンドを使用できるようにするには、connectコマンドを使用して管理サーバーに接続する必要があります。

この章の内容は次のとおりです。

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

- デプロイメント・コマンド

- SOAコンポジット・アプリケーションの管理コマンド

- 構成プラン管理コマンド

- タスク検証コマンド

- SOAコンポジット・アプリケーションのコンパイル・コマンド

- SOAコンポジット・アプリケーションのパッケージ化コマンド

- SOAコンポジット・アプリケーションのテスト・コマンド

- SOAコンポジット・アプリケーションのHTTPクライアントベースのエクスポートおよびインポート・コマンド

- SOAコンポジット・アプリケーションのMBeanベースのエクスポートおよびインポート・コマンド

- SOAコンポジット・アプリケーションのパーティション管理コマンド

- SOAコンポジット・アプリケーションのオフライン・デプロイメント管理コマンド

- SOAヘルス・チェック・コマンド

デプロイメント、構成プランおよびテスト・スイートの詳細は、Oracle SOA SuiteでのSOAアプリケーションの開発を参照してください。

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

WLSTコマンドは、表2-1に示されたカテゴリに分類されます。

表2-1 Oracle SOA Suiteのコマンド・カテゴリ

コマンド・カテゴリ

説明

デプロイメント・コマンド

SOAコンポジット・アプリケーションをデプロイまたはアンデプロイします。

SOAコンポジット・アプリケーションの管理コマンド

デプロイ済のSOAコンポジット・アプリケーションを起動、停止、アクティブ化、リタイア、デフォルト・リビジョン・バージョンの割当ておよび一覧表示します。

構成プラン管理コマンド

SOAコンポジット・アプリケーションに対して構成プランを添付、抽出、生成および検証します。

タスク検証コマンド

ヒューマン・ワークフロー・タスクを検証します。

SOAコンポジット・アプリケーションのコンパイル・コマンド

SOAコンポジット・アプリケーションをコンパイルします。

SOAコンポジット・アプリケーションのパッケージ化コマンド

SOAコンポジット・アプリケーションをデプロイするためにアーカイブ・ファイルにパッケージ化します。

SOAコンポジット・アプリケーションのテスト・コマンド

本番環境でのデプロイメントの前に、SOAコンポジット・アプリケーションをテストします。

SOAコンポジット・アプリケーションのHTTPクライアントベースのエクスポートおよびインポート・コマンド

HTTPクライアントに基づいて、SOAコンポジット・アプリケーションをエクスポートおよびインポートします。

SOAコンポジット・アプリケーションのMBeanベースのエクスポートおよびインポート・コマンド

サーバー・ベースのコンポジット・ストアMBean (CompositeStoreMXBean)上でSOAコンポジット・アプリケーションをエクスポートおよびインポートします。

SOAコンポジット・アプリケーションのパーティション管理コマンド

異なるリビジョンのSOAコンポジット・アプリケーションを別々のパーティションに論理的にグループ化します。

SOAコンポジット・アプリケーションのオフライン・デプロイメント管理コマンド

SOAコンポジット・アプリケーションと共有データのオフライン・デプロイメントを管理します。

2.2 デプロイメント・コマンド

SOAコンポジット・アプリケーションをデプロイおよびアンデプロイするには、表2-2に示されたデプロイメント・コマンドを使用します。

表2-2 WLST構成用のデプロイメント・コマンド

使用するコマンド

用途

使用するWLST

sca_deployComposite

SOAコンポジット・アプリケーションをデプロイします。

オフライン

sca_undeployComposite

SOAコンポジット・アプリケーションをアンデプロイします。

オフライン

2.2.1 sca_deployComposite

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オフライン

2.2.1.1 説明

Oracle WebLogic ServerにSOAコンポジット・アプリケーションをデプロイします。このコマンドは、アプリケーションのアーティファクト・ファイルをデプロイメント用にパッケージ化しません。SOAコンポジット・アプリケーションのパッケージ化の説明は、「SOAコンポジット・アプリケーションのパッケージ化コマンド」を参照してください。

2.2.1.2 構文

sca_deployComposite(serverURL, sarLocation, [overwrite], [user], [password],
[forceDefault], [configplan], [partition] [keepInstancesOnRedeploy])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL (たとえば、http://myhost10:7001)。

sarLocation

次のいずれかへの絶対パス。

- SOAアーカイブ(SAR)ファイル。
SARファイルは、sca_という接頭辞(たとえばsca_HelloWorld_rev1.0.jar)を必要とする特殊なJARファイルです。SARファイルはデプロイメント・コマンド(sca_deployComposite()など)でデプロイできますが、通常の.jarファイルは特殊なSARファイルとしては扱われません。

- 複数のSAR、メタデータ・アーカイブ(MAR)、またはその両方を含むZIPファイル。

overwrite

オプション。既存のSOAコンポジット・アプリケーションを上書きするかどうかを指定します。

- false (デフォルト): アプリケーションを上書きしません。

- true: アプリケーションを上書きします。

user

オプション。コンポジットのデプロイ実行者のサーブレットにアクセスするためのユーザー名(基本認証が構成されている場合)。

password

オプション。コンポジットのデプロイ実行者のサーブレットにアクセスするためのパスワード(基本認証が構成されている場合)。

forceDefault

オプション。新規コンポジットをデフォルトとして設定するかどうかを指定します。

- true (デフォルト): そのコンポジットをデフォルト・コンポジットにします。

- false: そのコンポジットをデフォルト・コンポジットにしません。

configplan

オプション。指定したSARファイル、またはZIPファイルに組み込まれているすべてのSARファイルに適用される構成プランの絶対パス。

partition

オプション。SOAコンポジット・アプリケーションをデプロイするパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、コンポジットはdefaultパーティションに自動的にデプロイされます。

keepInstancesOnRedeploy

オプション。インスタンスを再デプロイに保持するかどうかを指定します。デフォルト値はfalseです。この引数は、BPMがインストールされた場合に使用されます。

注意:

タスク・マップ属性(以前のフレックス・フィールド・マッピング)およびルール(例: 休暇ルール)などのヒューマン・ワークフロー・アーティファクトは、タスク定義のネームスペースに基づいて定義されます。そのため、ヒューマン・ワークフロー・タスクのあるSOAコンポジット・アプリケーションを複数のパーティションにデプロイする場合は、次の問題が発生します。

- タスク定義タイプが同じ場合は、あるパーティションで定義されたマップ属性は他のパーティションでも参照できます。

- あるパーティションのタスク定義で定義されたルールは、他のパーティションの同じ定義に適用できます。

2.2.1.3 例

次の例では、HelloWorldアプリケーションをデプロイします。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar")

次の例では、デフォルト・バージョンとしてHelloWorldアプリケーションをデプロイします。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar", true)

次の例では、基本認証が構成された場合、ユーザー名を必要とするHelloWorldアプリケーションをデプロイします。次に、このユーザー名のパスワードを指定するように求められます。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar", user="weblogic")
Password:

次の例では、HelloWorldアプリケーションをデプロイし、deployplan.xmlという構成プランを適用します。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar", forceDefault=false,
configplan="/tmp/deployplan.xml")

次の例では、複数のSARまたはMAR、あるいはその両方を含むHelloWorld ZIPファイルをデプロイします。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost:7001",
"/tmp/HelloWorld.zip")

次の例では、HelloWorldアプリケーションをmyPartitionパーティションにデプロイします。

wls:/mydomain/ServerConfig> sca_deployComposite("http://stadp10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar", partition="myPartition")

2.2.2 sca_undeployComposite

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オフライン

2.2.2.1 説明

現在デプロイされているSOAコンポジット・アプリケーションをアンデプロイします。

2.2.2.2 構文

sca_undeployComposite(serverURL, compositeName, revision, [user], [password], [partition])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL (たとえば、http://myhost10:7001)。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョンID。

user

オプション。コンポジットのデプロイ実行者のサーブレットにアクセスするためのユーザー名(基本認証が構成されている場合)。

password

オプション。コンポジットのデプロイ実行者のサーブレットにアクセスするためのパスワード(基本認証が構成されている場合)。

partition

オプション。SOAコンポジット・アプリケーションが置かれているパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。他のパーティションは検索されません。

2.2.2.3 例

次の例では、HelloWorldアプリケーションをアンデプロイします。

wls:/mydomain/ServerConfig> sca_undeployComposite("http://myhost10:7001",
"HelloWorld", "1.0")

次の例では、基本認証が構成された場合、ユーザー名を必要とするHelloWorldアプリケーションをアンデプロイします。次に、このユーザー名のパスワードを指定するように求められます。

wls:/mydomain/ServerConfig> sca_undeployComposite("http://myhost10:7001",
"HelloWorld", "1.0", user="weblogic")
Password:

次の例では、myPartitionパーティション内のHelloWorldアプリケーションをアンデプロイします。

wls:/mydomain/ServerConfig> sca_undeployComposite("http://stadp10:7001",
"HelloWorld", "1.0", partition='myPartition')

2.3 SOAコンポジット・アプリケーションの管理コマンド

デプロイ済のSOAコンポジット・アプリケーションを起動、停止、アクティブ化、リタイア、デフォルト・リビジョン・バージョンの割当ておよび一覧表示するには、表2-3に示された管理コマンドを使用します。

表2-3 WLST構成用のSOAコンポジット・アプリケーションの管理コマンド

使用するコマンド

用途

使用するWLST

sca_startComposite

以前に停止したSOAコンポジット・アプリケーションを起動します。

オフライン

sca_stopComposite

SOAコンポジット・アプリケーションを停止します。

オフライン

sca_activateComposite

以前にリタイアされたSOAコンポジット・アプリケーションをアクティブにします。

オフライン

sca_retireComposite

SOAコンポジット・アプリケーションをリタイアします。

オフライン

sca_assignDefaultComposite

デフォルト・リビジョン・バージョンをSOAコンポジット・アプリケーションに割り当てます。

オフライン

sca_listDeployedComposites

デプロイ済のSOAコンポジット・アプリケーションを一覧表示します。

オフライン

2.3.1 sca_startComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

2.3.1.1 説明

以前に停止したSOAコンポジット・アプリケーションを起動します。

2.3.1.2 構文

sca_startComposite(host, port, user, password, compositeName, revision, [label], [partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(例: myhost)。

port

Oracle WebLogic Serverのポート(例: 7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名に対応するパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

label

オプション。SOAコンポジット・アプリケーションのラベル。ラベルによって、アプリケーションに関連付けられているメタデータ・サービス(MDS)アーティファクトが識別されます。ラベルを指定しない場合は、最新のラベルが検索されます。

partition

オプション。SOAコンポジット・アプリケーションが置かれているパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。他のパーティションは検索されません。

2.3.1.3 例

次の例では、HelloWorldアプリケーションのリビジョン1.0を起動します。

wls:/mydomain/ServerConfig> sca_startComposite("myhost", "7001", "weblogic",
"welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartition内のHelloWorldアプリケーションのリビジョン1.0を起動します。

wls:/mydomain/ServerConfig> sca_startComposite("stadp10", "7001", "weblogic",
"weblogic", "HelloWorld", "1.0", partition="myPartition")

2.3.2 sca_stopComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

2.3.2.1 説明

現在実行しているSOAコンポジット・アプリケーションを停止します。

2.3.2.2 構文

sca_stopComposite(host, port, user, password, compositeName, revision, [label],
[partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(例: myhost)。

port

Oracle WebLogic Serverのポート(例: 7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名に対応するパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

label

オプション。SOAコンポジット・アプリケーションのラベル。ラベルによって、アプリケーションに関連付けられているMDSアーティファクトが識別されます。ラベルを指定しない場合は、最新のラベルが検索されます。

partition

オプション。SOAコンポジット・アプリケーションが置かれているパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。他のパーティションは検索されません。

2.3.2.3 例

次の例では、HelloWorldアプリケーションのリビジョン1.0を停止します。

wls:/mydomain/ServerConfig> sca_stopComposite("myhost", "7001", "weblogic",
"welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartition内のHelloWorldアプリケーションのリビジョン1.0を停止します。

wls:/mydomain/ServerConfig> sca_stopComposite("stadp10", "7001", "weblogic",
"weblogic", "HelloWorld", "1.0", partition="myPartition")

2.3.3 sca_activateComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

2.3.3.1 説明

リタイアされたSOAコンポジット・アプリケーションをアクティブにします。アクティブ化すると、新しいインスタンスを作成できます。

2.3.3.2 構文

sca_activateComposite(host, port, user, password, compositeName, revision, [label], [partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(例: myhost)。

port

Oracle WebLogic Serverのポート(例: 7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名に対応するパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

label

オプション。SOAコンポジット・アプリケーションのラベル。ラベルによって、アプリケーションに関連付けられているMDSアーティファクトが識別されます。ラベルを指定しない場合は、最新のラベルが検索されます。

partition

オプション。SOAコンポジット・アプリケーションが置かれているパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。他のパーティションは検索されません。

2.3.3.3 例

次の例では、HelloWorldアプリケーションのリビジョン1.0をアクティブ化します。

wls:/mydomain/ServerConfig> sca_activateComposite("myhost", "7001", "weblogic",
"welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartition内のHelloWorldアプリケーションのリビジョン1.0をアクティブ化します。

wls:/mydomain/ServerConfig> sca_activateComposite("stadp10", "7001", "weblogic",
"weblogic", "HelloWorld", "1.0", partition="myPartition")

2.3.4 sca_retireComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

2.3.4.1 説明

SOAコンポジット・アプリケーションをリタイアします。プロセスのライフ・サイクルがリタイア状態の場合、新しいインスタンスは作成できません。既存インスタンスは正常に完了できます。

2.3.4.2 構文

sca_retireComposite(host, port, user, password, compositeName, revision, [label],
[partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(例: myhost)。

port

Oracle WebLogic Serverのポート(例: 7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名に対応するパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

label

オプション。SOAコンポジット・アプリケーションのラベル。ラベルによって、アプリケーションに関連付けられているMDSアーティファクトが識別されます。ラベルを指定しない場合は、最新のラベルが検索されます。

partition

オプション。SOAコンポジット・アプリケーションが置かれているパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。他のパーティションは検索されません。

2.3.4.3 例

次の例では、HelloWorldアプリケーションのリビジョン1.0をリタイアします。

wls:/mydomain/ServerConfig> sca_retireComposite("myhost", "7001", "weblogic",
"welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartition内のHelloWorldアプリケーションのリビジョン1.0をリタイアします。

wls:/mydomain/ServerConfig> sca_retireComposite("stadp10", "7001", "weblogic",
"weblogic", "HelloWorld", "1.0", partition="myPartition")

2.3.5 sca_assignDefaultComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

2.3.5.1 説明

SOAコンポジット・アプリケーションのリビジョンをデフォルトのバージョンとして設定します。このリビジョンは、新しいリクエストを受信するとインスタンス化されます。

2.3.5.2 構文

sca_assignDefaultComposite(host, port, user, password, compositeName, revision, [partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(例: myhost)。

port

Oracle WebLogic Serverのポート(例: 7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名に対応するパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

partition

オプション。SOAコンポジット・アプリケーションが置かれているパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。他のパーティションは検索されません。

2.3.5.3 例

次の例では、HelloWorldアプリケーションのリビジョン1.0をデフォルト・バージョンとして設定します。

wls:/mydomain/ServerConfig> sca_assignDefaultComposite("myhost", "7001",
"weblogic", "welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartitionにあるHelloWorldアプリケーションのリビジョン1.0をデフォルト・バージョンとして設定します。

wls:/mydomain/ServerConfig> sca_assignDefaultComposite("stadp10", "7001",
"weblogic", "weblogic", "HelloWorld", "1.0", partition="myPartition")

2.3.6 sca_listDeployedComposites

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

2.3.6.1 説明

SOAプラットフォームにデプロイされたすべてのSOAコンポジット・アプリケーションを一覧表示します。

2.3.6.2 構文

sca_listDeployedComposites(host, port, user, password)

引数

定義

host

Oracle WebLogic Serverのホスト名(例: myhost)。

port

Oracle WebLogic Serverのポート(例: 7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名に対応するパスワード。

2.3.6.3 例

次の例では、サーバーmyhost上のデプロイされたすべてのSOAコンポジット・アプリケーションを示します。

wls:/mydomain/ServerConfig> sca_listDeployedComposites('myhost', '7001',
'weblogic', 'welcome1')

2.4 構成プラン管理コマンド

SOAコンポジット・アプリケーションに対して添付、抽出、生成および構成プランを検証するには、表2-4に示された構成プラン管理コマンドを使用します。

表2-4 WLST構成用の構成プラン管理コマンド

使用するコマンド

用途

使用するWLST

sca_attachPlan

SOAコンポジット・アプリケーションのJARファイルへ構成プラン・ファイルを添付します。

オフライン

sca_extractPlan

JARファイルにパッケージ化された構成プランを編集のために抽出します。

オフライン

sca_generatePlan

編集用に構成プランを生成します。

オフライン

sca_validatePlan

構成プランを検証します。

オフライン

2.4.1 sca_attachPlan

コマンド・カテゴリ: 構成プラン管理コマンド

WLSTでの使用: オフライン

2.4.1.1 説明

SOAコンポジット・アプリケーション・ファイルに構成プラン・ファイルを添付します。ファイルに既存のプランがある場合には、デフォルトでは上書きされません。

2.4.1.2 構文

sca_attachPlan(sar, configPlan, [overwrite], [verbose])

引数

定義

sar

SARファイルの絶対パス。

configPlan

構成プラン・ファイルの絶対パス。

overwrite

オプション。SARファイルの既存の構成プランを上書きするかどうかを指定します。

- false(デフォルト): プランは上書きされません。

- true: プランは上書きされます。

verbose

オプション。構成プランの添付についての詳細情報を出力するかどうかを指定します。

- true(デフォルト): 詳細な情報を出力します。

- false: 詳細な情報を出力しません。

2.4.1.3 例

次の例では、HelloWorldアプリケーションにconfigplan.xml構成プラン・ファイルを付加します。

wls:/mydomain/ServerConfig> sca_attachPlan("/tmp/sca_HelloWorld_rev1.0.jar",
"/tmp/configplan.xml")

次の例では、HelloWorldアプリケーションの既存の構成プランをconfigplan.xmlファイルで上書きます。

wls:/mydomain/ServerConfig> sca_attachPlan("/tmp/sca_HelloWorld_rev1.0.jar", "/tmp/configplan.xml", overwrite=true)

2.4.2 sca_extractPlan

コマンド・カテゴリ: 構成プラン管理コマンド

WLSTでの使用: オフライン

2.4.2.1 説明

編集のために、SOAコンポジット・アプリケーション・ファイルにパッケージ化された構成プランを抽出します。これはオプションの手順です。プランが存在しない場合、これはsca_generatePlanで新しいファイルの作成と同じです。

2.4.2.2 構文

sca_extractPlan(sar, configPlan, [overwrite], [verbose])

引数

定義

sar

SARファイルの絶対パス。

configPlan

抽出される構成プラン・ファイルへの絶対パス。

overwrite

オプション。configPlanで指定された構成ファイルが存在する場合、それを上書きするかどうかを指定します。

- false(デフォルト): プランは上書きされません。

- true: プランは上書きされます。

verbose

オプション。構成プランの抽出についての詳細情報を出力するかどうかを指定します。

- true(デフォルト): 詳細な情報を出力します。

- false: 詳細な情報を出力しません。

2.4.2.3 例

次の例では、HelloWorldアプリケーションから編集するためにconfigplan.xmlファイルを抽出します。

wls:/mydomain/ServerConfig> sca_extractPlan("/tmp/sca_HelloWorld_rev1.0.jar",
"/tmp/configplan.xml")

次の例では、HelloWorldアプリケーションから編集するためにconfigplan.xmlファイルを抽出します。このコマンドによって、既存のプランも上書されます。

wls:/mydomain/ServerConfig> sca_extractPlan("/tmp/sca_HelloWorld_rev1.0.jar",
"/tmp/configplan.xml", overwrite=true)

2.4.3 sca_generatePlan

コマンド・カテゴリ: 構成プラン管理コマンド

WLSTでの使用: オフライン

2.4.3.1 説明

編集用に構成プランを生成します。

2.4.3.2 構文

sca_generatePlan(configPlan, sar, composite, [overwrite], [verbose])

引数

定義

configPlan

生成される構成プラン・ファイルの絶対パス。

configPlanまたはsarのいずれかが必要です。両方を指定することはできません。

sar

SARファイルの絶対パス。

configPlanまたはsarのいずれかが必要です。両方を指定することはできません。

composite

展開された(解凍された) SARディレクトリにあるcomposite.xmlファイルの絶対パス。

overwrite

オプション。既存の構成プラン・ファイルを上書きするかどうかを指定します。

- false(デフォルト): プランは上書きされません。

- true: プランは上書きされます。

verbose

プラン生成についての詳細情報を出力するかどうかを指定します。

- true(デフォルト): 詳細な情報を出力します。

- false: 詳細な情報を出力しません。

2.4.3.3 例

次の例では、HelloWorldアプリケーションの構成プラン・ファイルmyplan.xmlを生成します。

wls:/mydomain/ServerConfig> sca_generatePlan("/tmp/myplan.xml",
sar="/tmp/sca_HelloWorld_rev1.0.jar")

次の例では、HelloWorldアプリケーションの構成プラン・ファイルmyplan2.xmlを生成します。myplan2.xmlファイルは既存のプランを上書きます。

wls:/mydomain/ServerConfig> sca_generatePlan("/tmp/myplan2.xml",
composite="/tmp/HelloWorld_rev1.0/composite.xml", overwrite=true)

2.4.4 sca_validatePlan

コマンド・カテゴリ: 構成プラン管理コマンド

WLSTでの使用: オフライン

2.4.4.1 説明

構成プランを検証します。このコマンドは、デプロイメント中に行われたすべての検索および置換による変更を識別します。このオプションは、デバッグの目的でのみ使用します。

2.4.4.2 構文

sca_validatePlan(reportFile, configPlan, [sar], [composite], [overwrite], [verbose])

引数

定義

reportFile

生成されるレポート・ファイルの絶対パス。検証結果はこのファイルに書き込まれます。

configPlan

構成プラン・ファイルの絶対パス。

sar

オプション。SARファイルの絶対パス。

composite

オプション。展開された(解凍された) SARディレクトリにあるcomposite.xmlファイルの絶対パス。

overwrite

オプション。既存の構成プラン・ファイルを上書きするかどうかを指定します。

- false(デフォルト): プランは上書きされません。

- true: プランは上書きされます。

verbose

オプション。構成プランの検証についての詳細情報を出力するかどうかを指定します。

- true(デフォルト): 詳細な情報を出力します。

- false: 詳細な情報を出力しません。

2.4.4.3 例

次の例では、HelloWorldアプリケーションの構成プラン・ファイルconfigplan.xmlを検証します。

wls:/mydomain/ServerConfig> sca_validatePlan("/tmp/myreport.xml",
"/tmp/configplan.xml", sar="/tmp/sca_HelloWorld_rev1.0.jar")

次の例では、HelloWorldアプリケーションの構成プラン・ファイルconfigplan.xmlを検証します。configplan.xmlプランは既存のプランを上書きます。

wls:/mydomain/ServerConfig> sca_validatePlan("/tmp/myreport.xml",
"/tmp/configplan.xml",composite="/tmp/HelloWorld_rev1.0/composite.xml", overwrite=true)

2.5 タスク検証コマンド

ヒューマン・ワークフロー・タスクを検証するには、表2-5に示されたタスク検証コマンドを使用します。

表2-5 WLST構成用のタスク検証コマンド

使用するコマンド

用途

使用するWLST

sca_validateTask

ヒューマン・ワークフロー・タスクを検証します。

オフライン

2.5.1 sca_validateTask

コマンド・カテゴリ: タスク検証コマンド

WLSTでの使用: オフライン

2.5.1.1 説明

人員のタスク・エディタに人員のタスクを設計するときに作成された.taskファイルにある人員のワークフロー・タスクを検証します。

2.5.1.2 構文

sca_validateTask(taskFile, outXml, [displayLevel])

引数

定義

taskFile

タスク定義ファイルの絶対パス(.task)。

outXml

出力XMLファイルへの絶対パス。

displayLevel

オプション。表示する情報レベル。値は、1、2または3です。デフォルト値は1です。

2.5.1.3 例

次の例では、人員のタスクのWFTaskDefinition.taskファイルを検証します。

wls:/mydomain/ServerConfig> sca_validateTask("/tmp/WFTaskDefinition.task",
"/tmp/out.xml", displayLevel=2)

2.6 SOAコンポジット・アプリケーションのコンパイル・コマンド

SOAコンポジット・アプリケーションをコンパイルするには、表2-6に示されたコンパイル・コマンドを使用します。

表2-6 WLST構成用のSOAコンポジット・アプリケーションのコンパイル・コマンド

使用するコマンド

用途

使用するWLST

sca_setProp

JVMシステム・プロパティを設定します。

オフライン

sca_compile

SOAコンポジット・アプリケーションをコンパイルします。

オフライン

2.6.1 sca_setProp

コマンド・カテゴリ: アプリケーション・コンパイル・コマンド

WLSTでの使用: オフライン

2.6.1.1 説明

JVMシステム・プロパティを設定します。このコマンドは、SSL上にsca_deployCompositeおよびsca_undeployCompositeを使用する前に、セキュア・ソケット・レイヤー(SSL)システム・プロパティも設定できます。

2.6.1.2 構文

sca_setProp(propName, propValue)

引数

定義

propName

プロパティ名。

propValue

プロパティ値。

2.6.1.3 例

次の例では、プロパティ名およびプロパティ値を設定します。

wls:/mydomain/ServerConfig> sca_setProp("oracle.home",
"/scratch/myusername/beahome/AS11gR1SOA")

2.6.2 sca_compile

コマンド・カテゴリ: アプリケーション・コンパイル・コマンド

WLSTでの使用: オフライン

2.6.2.1 説明

SOAコンポジット・アプリケーションをコンパイルします。

注意:

sca_compileコマンドは、ant-sca-compile.xmlスクリプトを検索するためにoracle.homeプロパティが必要です。これは一度設定する必要があります。scac_setPropコマンドまたはoracleHomeプロパティを使用して、値を設定できます。

2.6.2.2 構文

sca_compile(composite, [outXml], [error], [appHome], [displayLevel], [oracleHome])

引数

定義

composite

展開(解凍)されたSARディレクトリ内のコンポジット・ファイルの絶対パス。

outXml

オプション。出力XMLファイルの絶対パス。

error

オプション。エラー・ファイルの絶対パス。

appHome

オプション。アプリケーション・ホーム・ディレクトリの絶対パス。データを共有している場合、このプロパティは必須です。

displayLevel

オプション。表示する情報レベル。デフォルト値は1です。

oracleHome

オプション。oracle.homeプロパティ。

reportSchemaValidationErrors

オプション。スキーマ検証エラーがレポートされるかどうかを指定します。デフォルト値はfalseです。

2.6.2.3 例

次の例では、FirstCompositeアプリケーションをコンパイルします。

wls:/mydomain/ServerConfig> sca_compile("/tmp/FirstComposite_
rev1.0/composite.xml", displayLevel=2)

次の例では、FirstCompositeアプリケーションをコンパイルし、myout.xmlファイルに詳細をキャプチャします。エラーが発生する場合、error.outファイルにキャプチャします。

wls:/mydomain/ServerConfig> sca_compile("/tmp/FirstComposite_
rev1.0/composite.xml", outXml="/tmp/myout.xml", error="error.out")

次の例では、FirstCompositeアプリケーションをコンパイルします。ant-sca-compile.xmlスクリプトを検索するためにoracleHomeプロパティ設定します。

wls:/mydomain/ServerConfig> sca_compile("/tmp/FirstComposite_
rev1.0/composite.xml", displayLevel=2,
oracleHome="/scratch/myusername/beahome/AS11gR1SOA")

2.7 SOAコンポジット・アプリケーションのパッケージ化コマンド

SOAコンポジット・アプリケーションをコンポジットSARファイルにパッケージ化するには、表2-7に示されたパッケージ化コマンドを使用します。

表2-7 WLST構成用のSOAコンポジット・アプリケーションのパッケージ化コマンド

使用するコマンド

用途

使用するWLST

sca_package

SOAコンポジット・アプリケーション・ファイルをコンポジットSARファイルにパッケージ化します。

オフライン

2.7.1 sca_package

コマンド・カテゴリ: アプリケーション・パッケージ化コマンド

WLSTでの使用: オフライン

2.7.1.1 説明

SOAコンポジット・アプリケーション・ファイルをコンポジットSARファイルにパッケージ化します。このコマンドは、次の操作を実行します。

- ${compositeDir}にコンポジット・アーティファクトをコンパイルするためにsca_compileを呼び出します。

- ${compositeDir}/src内のソース・コードをコンパイルするためにjavacを呼び出します。

- ${compositeDir}/composite.xmlのリビジョンを置き換えます。

- ${compositeDir}/deployにsca_${compositeName}_rev${revision}.jarを作成するためにアーティファクトをパッケージ化します。

注意:

sca_packageコマンドは、ant-sca-package.xmlスクリプトを検索するためにoracle.homeが必要です。これは一度設定する必要があります。scac_setPropコマンドまたはoracleHomeプロパティを使用して、このプロパティを設定できます。

2.7.1.2 構文

sca_package(compositeDir, compositeName, revision, [appHome], [oracleHome])

引数

定義

compositeDir

コンポジット・アーティファクトが含まれるディレクトリの絶対パス。

compositeName

コンポジットの名前。

revision

コンポジットのリビジョンID。

appHome

オプション。アプリケーション・ホーム・ディレクトリの絶対パス。データを共有している場合、このプロパティは必須です。

oracleHome

オプション。oracle.homeプロパティ。

2.7.1.3 例

次の例では、OrderBookingCompositeアプリケーションをパッケージ化します。このアプリケーションでは共有データが使用されるので、appHomeプロパティを設定します。

wls:/mydomain/ServerConfig> sca_package("/tmp/app_data/OrderBookingComposite",
"OrderBookingComposite", "1.0", appHome="/tmp/app_data")

次の例では、HelloSOACompositeアプリケーションをパッケージ化します。

wls:/mydomain/ServerConfig> sca_package
("/tmp/HelloSOAApplication/HelloSOAComposite", "HelloSOAComposite", "1.0")

次の例では、HelloSOACompositeアプリケーションをパッケージ化します。ant-sca-compile.xmlスクリプトを検索するためにoracleHomeプロパティ設定します。

wls:/mydomain/ServerConfig> sca_package
("/tmp/HelloSOAApplication/HelloSOAComposite", "HelloSOAComposite", "1.0",
oracleHome="/scratch/myusername/beahome/AS11gR1SOA")

2.8 SOAコンポジット・アプリケーションのテスト・コマンド

SOAコンポジット・アプリケーションをテストするには、表2-8に示されたSOAコンポジット・アプリケーションのテスト・コマンドを使用します。

表2-8 WLST構成用のSOAコンポジット・アプリケーションのテスト・コマンド

使用するコマンド

用途

使用するWLST

sca_test

デプロイ済のSOAコンポジット・アプリケーションをテストします。

オフライン

2.8.1 sca_test

コマンド・カテゴリ: アプリケーション・テスト・コマンド

WLSTでの使用: オフライン

2.8.1.1 説明

本番環境にデプロイする前に、デプロイされるSOAコンポジット・アプリケーションをテストします。Oracle JDeveloperでテストのスイートを作成します。sca_testコマンドはant-sca-test.xmlを呼び出します。

2.8.1.2 構文

sca_test('compositeName', 'revision', 'testsuiteName', 'jndiPropFile',
[oracleHome='oracleHome'], [javaHome='javaHome'])

引数

定義

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョンID。

testsuiteName

テスト・スイートの名前。

jndiPropFile

JNDIプロパティ・ファイルの絶対パス。

oracleHome

オプション。oracle.homeシステム・プロパティ。

javaHome

オプション。java.passed.homeシステム・プロパティ。

2.8.1.3 例

次の例では、OrderBookingMainTestsuiteテスト・スイートを実行します。

wls:/mydomain/ServerConfig> sca_test('OrderBookingComposite', '1.0',
'OrderBookingMainTestsuite', '/tmp/tmp-jndi.properties',
oracleHome='/scratch/<user>/beahome/AS11gR1SOA/',
javaHome='/scratch/<user>/beahome/jdk160_05')

2.9 SOAコンポジット・アプリケーションのHTTPクライアントベースのエクスポートおよびインポート・コマンド

HTTPクライアントに基づいてSOAコンポジット・アプリケーションをエクスポートおよびインポートするには、表2-9に示されたSOAコンポジット・アプリケーション・コマンドを使用します。これらのコマンドを使用するには、SOAインフラストラクチャが実行している必要があります。

表2-9 WLST構成用のSOAコンポジット・アプリケーションのエクスポートおよびインポート・コマンド

使用するコマンド

用途

使用するWLST

sca_exportComposite

SOAコンポジット・アプリケーションをSARファイルにエクスポートします。

オフライン

sca_exportUpdates

SOAコンポジット・アプリケーションのデプロイメント後の変更をJARファイルにエクスポートします。

オフライン

sca_importUpdates

SOAコンポジット・アプリケーションのデプロイメント後の変更をインポートします。

オフライン

sca_exportSharedData

指定したパターンの共有データをJARファイルにエクスポートします。

オフライン

sca_removeSharedData

トップレベルの共有データ・フォルダを削除します。

オフライン

2.9.1 sca_exportComposite

コマンド・カテゴリ: アプリケーション・エクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

2.9.1.1 説明

SOAコンポジット・アプリケーションをSARファイルにエクスポートします。

2.9.1.2 構文

sca_exportComposite(serverURL, updateType, sarFile, compositeName, revision,
[user], [password], [partition])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

updateType

エクスポートするデプロイメント後の変更のタイプ。

- all: デプロイ後の変更をすべて含みます。

- property: プロパティのデプロイ後の変更のみを含みます(バインディング・コンポーネント・プロパティ、監査レベル設定やペイロード検証ステータスなどのコンポジット・プロパティ、およびポリシー・アタッチメント)。

- runtime: 実行時(ルール・ディクショナリおよびドメイン値マップ(DVM))およびメタデータのデプロイ後の変更のみを含みます。

- none: (プロパティの変更および実行時の変更も含めて)デプロイ後の変更を含まずに元のコンポジットをエクスポートします。

sarFile

生成するSARファイル(sca_で始まる.jarファイル)の絶対パス。

compositeName

エクスポートするコンポジットの名前。

revision

エクスポートするコンポジットのリビジョン。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が構成されている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が構成されている場合)。この引数には次の構文を使用します:

password='password'

partition

オプション。SOAコンポジット・アプリケーションが置かれているパーティションの名前。デフォルト値はdefaultです。

2.9.1.3 例

次の例では、デプロイメント後の変更を含めずにコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'none', '/tmp/sca_HelloWorld_rev1.0.jar', 'HelloWorld', '1.0')

次の例では、すべてのデプロイメント後の更新とともにコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'all', '/tmp/sca_HelloWorld_ rev1.0-all.jar', 'HelloWorld', '1.0')

次の例では、プロパティのデプロイメント後の更新とともにコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'property', '/tmp/sca_HelloWorld_ rev1.0-prop.jar', 'HelloWorld', '1.0')

次の例では、ランタイムまたはメタデータのデプロイメント後の更新とともにコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'runtime', '/tmp/sca_HelloWorld_ rev1.0-runtime.jar', 'HelloWorld', '1.0')

次の例では、デプロイ後の更新を含まずに、myPartitionパーティション内のコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'none', '/tmp/sca_HelloWorld_rev1.0.jar', 'HelloWorld', '1.0',
partition='myPartition')

2.9.2 sca_exportUpdates

コマンド・カテゴリ: アプリケーション・エクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

2.9.2.1 説明

SOAコンポジット・アプリケーションのデプロイメント後の変更をJARファイルにエクスポートします。

2.9.2.2 構文

sca_exportUpdates(serverURL, updateType, jarFile, compositeName, revision,
[user], [password], [partition])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

updateType

エクスポートするデプロイメント後の変更のタイプ。

- all: デプロイ後の変更をすべて含みます。

- property: プロパティのデプロイ後の変更のみを含みます(バインディング・コンポーネント・プロパティ、監査レベル設定やペイロード検証ステータスなどのコンポジット・プロパティ、およびポリシー・アタッチメント)。

- runtime: 実行時(ルール・ディクショナリおよびドメイン値マップ(DVM))およびメタデータのデプロイ後の変更のみを含みます。

jarFile

生成するJARファイルの絶対パス。sca_exportUpdates()では、標準のデプロイメント・コマンドを使用してインポートすることができない標準の.jarファイルが作成されます。インポートするには、sca_importUpdates()を使用する必要があります。

compositeName

エクスポートするコンポジットの名前。

revision

エクスポートするコンポジットのリビジョン。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が構成されている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が構成されている場合)。この引数には次の構文を使用します:

password='password'

partition

オプション。SOAコンポジット・アプリケーションが置かれているパーティションの名前。デフォルト値はdefaultです。

2.9.2.3 例

次の例では、すべてのデプロイメント後の更新をエクスポートします。

wls:/offline/mydomain/ServerConfig>  sca_exportUpdates('http://stabc:8001', 'all',
'/tmp/all-HelloWorld_rev1.0.jar','HelloWorld', '1.0')

次の例では、プロパティのデプロイメント後の更新をエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportUpdates('http://stabc:8001',
'property','/tmp/prop-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')

次の例では、ランタイムまたはメタデータのデプロイメント後の更新をエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportUpdates('http://stabc:8001',
'runtime','/tmp/runtime-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')

次の例では、パーティションmyPartition内のコンポジットのデプロイ後の変更をJARファイルにエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportUpdates('http://stabc:8001',
'runtime', '/tmp/runtime-HelloWorld_rev1.0.jar', 'HelloWorld', '1.0',
partition='myPartition')

2.9.3 sca_importUpdates

コマンド・カテゴリ: アプリケーション・エクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

2.9.3.1 説明

SOAコンポジット・アプリケーションのデプロイメント後の変更をインポートします。

2.9.3.2 構文

sca_importUpdates(serverURL, jarFile, compositeName, revision, [user],
[password])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

jarFile

デプロイメント後の変更が含まれるJARファイルの絶対パス。

compositeName

デプロイメント後の変更をインポートするコンポジットの名前。

revision

デプロイメント後の変更をインポートするコンポジットのリビジョン。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が構成されている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が構成されている場合)。この引数には次の構文を使用します:

password='password'

partition

オプション。SOAコンポジット・アプリケーションが置かれているパーティションの名前。デフォルト値はdefaultです。

2.9.3.3 例

次の例では、SOAコンポジット・アプリケーションのデプロイメント後の変更をインポートします。

wls:/offline/mydomain/ServerConfig> sca_importUpdates('http://stabc:8001',
'/tmp/all-HelloWorld_rev1.0.jar', 'HelloWorld', '1.0')

次の例では、パーティションmyPartition内のコンポジットのデプロイ後の変更をインポートします。

wls:/offline/mydomain/ServerConfig> sca_importUpdates('http://stabc:8001',
'/tmp/all-HelloWorld_rev1.0.jar', 'HelloWorld', '1.0', partition='myPartition')

2.9.4 sca_exportSharedData

コマンド・カテゴリ: アプリケーション・エクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

2.9.4.1 説明

指定したパターンの共有データをJARファイルにエクスポートします。

2.9.4.2 構文

sca_exportSharedData(serverURL, jarFile, pattern, [user], [password])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

jarFile

生成するJARファイルの絶対パス。

pattern

MDS転送APIによってサポートされているファイル・パターン。複数のパターンを指定する場合は、デリミタとしてセミコロン(;)を使用します。パターンでは、共有データ・ネームスペース/appsを除外します。次に例を示します。

/Project1/**;/Project2/**

この例では、/apps/Project1および/apps/Project2にあるすべてのドキュメントをエクスポートします。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が構成されている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が構成されている場合)。この引数には次の構文を使用します:

password='password'

2.9.4.3 例

次の例では、指定したパターンの共有データをJARファイルにエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportSharedData('http://stabc:8001',
'/tmp/MySharedData.jar', '/Project1/**')

2.9.5 sca_removeSharedData

コマンド・カテゴリ: アプリケーション・エクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

2.9.5.1 説明

サービス・エンジンにデプロイされたコンポジットがある場合でも、トップレベルの共有データ・フォルダを削除します。

2.9.5.2 構文

sca_removeSharedData(serverURL, folderName, [user], [password])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

folderName

削除するトップレベルの共有データ・フォルダの名前。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が構成されている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が構成されている場合)。この引数には次の構文を使用します:

password='password'

2.9.5.3 例

次の例では、最上位の共有データ・フォルダProject1を削除します。

sca_removeSharedData('http://stabc:8001', 'Project1')

2.10 SOAコンポジット・アプリケーションのMBeanベースのエクスポートおよびインポート・コマンド

サーバーベースのコンポジット・ストアMBean (CompositeStoreMXBean)にSOAコンポジット・アプリケーションをエクスポートおよびインポートするには、表2-10に示されたデプロイメント・コマンドを使用します。

表2-10 WLST構成用のSOAコンポジット・アプリケーションのエクスポートおよびインポート・コマンド

使用するコマンド

用途

使用するWLST

sca_exportCompositeMb

SOAコンポジット・アプリケーションをSARファイルにエクスポートします。

オンライン

sca_exportUpdatesMb

SOAコンポジット・アプリケーションのデプロイメント後の変更をJARファイルにエクスポートします。

オンライン

sca_importUpdatesMb

SOAコンポジット・アプリケーションのデプロイメント後の変更をインポートします。

オンライン

sca_exportSharedDataMb

指定したパターンの共有データをJARファイルにエクスポートします。

オンライン

このオプションを使用する場合、エクスポート・コマンドで生成されたファイルおよびインポート・コマンドで読み取られたファイルは、サーバーが実行しているホスト(Oracle WebLogic管理サーバーまたは管理対象SOAサーバー)にある必要があります。

コンポジット・ストアMBeanは、SOAサーバーのサーバー実行時MBeanとOracle WebLogic管理サーバーのドメイン実行時MBeanの両方として登録されます。そのため、SOAサーバーが停止している間も、インポートとエクスポートを続行することが可能になります。コンポジット・ストアMBeanの使用では、WLSTコマンドのみが提供されています。antコマンドはありません。

connect()コマンドを実行して、SOAサーバーまたはOracle WebLogic管理サーバーのいずれかに接続する必要があります。

wls:offline>connect('weblogic', 'password', 't3://stabc:8001')

SOAサーバーの停止中にドメイン実行時MBeanを使用する場合、domainRuntime()コマンドを実行する必要があります。

wls:offline>connect('weblogic', 'password', 't3://stabc:7001')
wls:/soainfra/serverConfig>domainRuntime()

2.10.1 sca_exportCompositeMb

コマンド・カテゴリ: アプリケーション・エクスポートおよびインポート・コマンド

WLSTでの使用: オンライン

2.10.1.1 説明

SOAコンポジット・アプリケーションをSARファイルにエクスポートします。

2.10.1.2 構文

sca_exportCompositeMb(updateType, sarFile, compositeName, revision)

引数

定義

updateType

エクスポートするデプロイメント後の変更のタイプ。

- all: デプロイ後の変更がすべて含まれます。

- property: プロパティの変更が含まれます(バインディング・コンポーネント・プロパティ、監査レベル設定やペイロード検証ステータスなどのコンポジット・プロパティ、およびポリシー・アタッチメント)。

- runtime: デプロイ後の実行時の変更が含まれます(ルール・ディクショナリおよびドメイン値マップ(DVM))。

sarFile

生成するSARファイルの絶対パス。

compositeName

エクスポートするコンポジットの名前。

revision

エクスポートするコンポジットのリビジョン。

2.10.1.3 例

この例では、デプロイメント後の変更を含めずにコンポジットをエクスポートします。

wls:/mydomain/ServerConfig> sca_exportCompositeMb('none', '/tmp/sca_HelloWorld_
rev1.0.jar', 'HelloWorld', '1.0')

この例では、すべてのデプロイメント後の更新とともにコンポジットをエクスポートします。

wls:/mydomain/ServerConfig> sca_exportCompositeMb('all', '/tmp/sca_HelloWorld_
rev1.0-all.jar', 'HelloWorld','1.0')

この例では、プロパティのデプロイメント後の更新とともにコンポジットをエクスポートします。

wls:/mydomain/ServerConfig> sca_exportCompositeMb('property', '/tmp/sca_
HelloWorld_rev1.0-prop.jar', HelloWorld', '1.0')

この例では、ランタイムまたはメタデータのデプロイメント後の更新とともにコンポジットをエクスポートします。

wls:/mydomain/ServerConfig> sca_exportCompositeMb('runtime', '/tmp/sca_HelloWorld_
rev1.0-runtime.jar','HelloWorld', '1.0')

2.10.2 sca_exportUpdatesMb

コマンド・カテゴリ: アプリケーション・エクスポートおよびインポート・コマンド

WLSTでの使用: オンライン

2.10.2.1 説明

SOAコンポジット・アプリケーションのデプロイメント後の変更をJARファイルにエクスポートします。

2.10.2.2 構文

sca_exportUpdatesMb(updateType, jarFile, compositeName, revision)

引数

定義

updateType

エクスポートするデプロイ後の変更のタイプ: all、propertyまたはruntime

jarFile

生成するJARファイルの絶対パス。

compositeName

エクスポートするコンポジットの名前。

revision

エクスポートするコンポジットのリビジョン。

2.10.2.3 例

次の例では、すべてのデプロイメント後の更新をエクスポートします。

wls:/mydomain/ServerConfig>  sca_exportUpdatesMb('all',
'/tmp/all-HelloWorld_rev1.0.jar','HelloWorld', '1.0')

次の例では、プロパティのデプロイメント後の更新をエクスポートします。

wls:/mydomain/ServerConfig> sca_exportUpdatesMB('property',
'/tmp/prop-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')

次の例では、ランタイムまたはメタデータのデプロイメント後の更新をエクスポートします。

wls:/mydomain/ServerConfig> sca_exportUpdatesMB('runtime',
'/tmp/runtime-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')

2.10.3 sca_importUpdatesMb

コマンド・カテゴリ: アプリケーション・エクスポートおよびインポート・コマンド

WLSTでの使用: オンライン

2.10.3.1 説明

SOAコンポジット・アプリケーションのデプロイメント後の変更をインポートします。

2.10.3.2 構文

sca_importUpdatesMb(jarFile, compositeName, revision)

引数

定義

jarFile

デプロイメント後の変更が含まれるJARファイルの絶対パス。

compositeName

デプロイメント後の変更をインポートするコンポジットの名前。

revision

デプロイメント後の変更をインポートするコンポジットのリビジョン。

2.10.3.3 例

次の例では、SOAコンポジット・アプリケーションのデプロイメント後の変更をインポートします。

wls:/mydomain/ServerConfig> sca_importUpdatesMb('/tmp/all-HelloWorld_rev1.0.jar',
'HelloWorld', '1.0')

2.10.4 sca_exportSharedDataMb

コマンド・カテゴリ: アプリケーション・エクスポートおよびインポート・コマンド

WLSTでの使用: オンライン

2.10.4.1 説明

指定したパターンの共有データをJARファイルにエクスポートします。

2.10.4.2 構文

sca_exportSharedDataMb(jarFile, pattern)

引数

定義

jarFile

生成するJARファイルの絶対パス。

pattern

MDS転送APIによってサポートされているファイル・パターン。複数のパターンを指定する場合は、デリミタとしてセミコロン(;)を使用します。パターンでは、共有データ・ネームスペース/appsを除外します。次に例を示します。

/Project1/**;/Project2/**

この例では、/apps/Project1および/apps/Project2にあるすべてのドキュメントをエクスポートします。

2.10.4.3 例

この例では、指定したパターンの共有データをJARファイルにエクスポートします。

wls:/mydomain/ServerConfig> sca_exportSharedDataMb('/tmp/MySharedData.jar',
'/Project1/**')

2.11 SOAコンポジット・アプリケーションのパーティション管理コマンド

パーティションを管理するには、表2-11に示されたデプロイメント・コマンドを使用します。パーティション化では、異なるリビジョンのSOAコンポジット・アプリケーションを別々のセクションに論理的にグループ化できます。このことは、Oracle BPEL Process Managerの10.1.xリリースのドメインの概念に似ています。

表2-11 WLST構成用のSOAコンポジット・アプリケーションのパーティション管理コマンド

使用するコマンド

用途

使用するWLST

sca_createPartition

パーティションを作成します。

オンライン

sca_deletePartition

パーティションを削除する前に、パーティション内のすべてのSOAコンポジット・アプリケーションをアンデプロイします。

オンライン

sca_startCompositesInPartition

パーティション内のすべてのSOAコンポジット・アプリケーションを起動します。

オンライン

sca_stopCompositesInPartition

パーティション内のすべてのSOAコンポジット・アプリケーションを停止します。

オンライン

sca_activateCompositesInPartition

パーティション内のすべてのSOAコンポジット・アプリケーションをアクティブにします。

オンライン

sca_retireCompositesInPartition

パーティション内のすべてのSOAコンポジット・アプリケーションをリタイアします。

オンライン

sca_listPartitions

SOAインフラストラクチャのすべてのパーティションを一覧表示します。

オンライン

sca_listCompositesInPartition

特定のパーティション内のすべてのコンポジットを一覧表示します。

オンライン

sca_createPartitionWMG

パーティションを作成し、それをワーク・マネージャ・グループに関連付けます。

オンライン

2.11.1 sca_createPartition

コマンド・カテゴリ: アプリケーション・パーティション管理コマンド

WLSTでの使用: オンライン

2.11.1.1 説明

パーティションを作成します。

2.11.1.2 構文

sca_createPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

2.11.1.3 例

この例では、myPartitionという名前のパーティションを作成します。

wls:/mydomain/ServerConfig> sca_createPartition('myPartition')

2.11.2 sca_deletePartition

コマンド・カテゴリ: アプリケーション・パーティション管理コマンド

WLSTでの使用: オンライン

2.11.2.1 説明

パーティションを削除する前に、パーティション内のすべてのコンポジットをアンデプロイします。

2.11.2.2 構文

sca_deletePartition(partitionName)

引数

定義

partitionName

パーティションの名前。

2.11.2.3 例

この例では、パーティションを削除する前に、myPartitionパーティション内のすべてのコンポジットをアンデプロイします。

wls:/mydomain/ServerConfig> sca_deletePartition('myPartition')

2.11.3 sca_startCompositesInPartition

コマンド・カテゴリ: アプリケーション・パーティション管理コマンド

WLSTでの使用: オンライン

2.11.3.1 説明

パーティション内のすべてのコンポジットを起動します。

2.11.3.2 構文

sca_startCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

2.11.3.3 例

この例では、myPartitionパーティション内のすべてのコンポジットを起動します。

wls:/mydomain/ServerConfig> sca_startCompositesInPartition('myPartition')

2.11.4 sca_stopCompositesInPartition

コマンド・カテゴリ: アプリケーション・パーティション管理コマンド

WLSTでの使用: オンライン

2.11.4.1 説明

パーティション内のすべてのコンポジットを停止します。

2.11.4.2 構文

sca_stopCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

2.11.4.3 例

この例では、myPartitionパーティション内のすべてのコンポジットを停止します。

wls:/mydomain/ServerConfig> sca_stopCompositesInPartition('myPartition')

2.11.5 sca_activateCompositesInPartition

コマンド・カテゴリ: アプリケーション・パーティション管理コマンド

WLSTでの使用: オンライン

2.11.5.1 説明

パーティション内のすべてのコンポジットをアクティブ化します。

2.11.5.2 構文

sca_activateCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

2.11.5.3 例

この例では、myPartitionパーティション内のすべてのコンポジットのアクティブにします。

wls:/mydomain/ServerConfig> sca_activateCompositesInPartition('myPartition')

2.11.6 sca_retireCompositesInPartition

コマンド・カテゴリ: アプリケーション・パーティション管理コマンド

WLSTでの使用: オンライン

2.11.6.1 説明

パーティション内のすべてのコンポジットをリタイアします。

2.11.6.2 構文

sca_retireCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

2.11.6.3 例

この例では、myPartitionパーティション内のすべてのコンポジットをリタイアします。

wls:/mydomain/ServerConfig> sca_retireCompositesInPartition('myPartition')

2.11.7 sca_listPartitions

コマンド・カテゴリ: アプリケーション・パーティション管理コマンド

WLSTでの使用: オンライン

2.11.7.1 説明

SOAインフラストラクチャのすべてのパーティションを一覧表示します。

2.11.7.2 構文

sca_listPartitions()

2.11.7.3 例

この例では、SOAインフラストラクチャのすべてのパーティションを一覧表示します。

wls:/mydomain/ServerConfig> sca_listPartitions()

2.11.8 sca_listCompositesInPartition

コマンド・カテゴリ: アプリケーション・パーティション管理コマンド

WLSTでの使用: オンライン

2.11.8.1 説明

パーティション内のすべてのコンポジットが一覧表示されます。

2.11.8.2 構文

sca_listCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

2.11.8.3 例

この例では、myPartitionパーティション内のすべてのコンポジットを一覧表示します。

sca_listCompositesInPartition(myPartition)

2.11.9 sca_createPartitionWMG

コマンド・カテゴリ: アプリケーション・パーティション管理コマンド

WLSTでの使用: オンライン

2.11.9.1 説明

パーティションを作成し、それをワーク・マネージャ・グループに関連付けます。ワーク・マネージャ・グループが存在しない場合には作成されます。

2.11.9.2 構文

sca_createPartitionWMG(partitionName, workmanagerGroupName,
workmanagerGroupDescription)

引数

定義

partitionName

作成するパーティションの名前。

workmanagerGroupName

使用するワーク・マネージャ・グループの名前。ワーク・マネージャ・グループが存在しない場合には作成されます。

workmanagerGroupDescription

ワーク・マネージャ・グループが作成される場合、その説明。

2.11.9.3 例

この例では、myPartitionという名前のパーティションを作成し、それをmyWMGという名前の新しいワーク・マネージャ・グループに関連付けます。このワーク・マネージャ・グループが作成されるため、説明が表示されます。

sca_createPartitionWMG('myPartition', 'myWMG', 'my new workmanagerGroup')

2.12 SOAコンポジット・アプリケーションのオフライン・デプロイメント管理コマンド

次のファイルにあるSOAコンポジット・アプリケーションと共有データのオフライン・デプロイメントを管理するには、表2-12に示されたデプロイメント・コマンドを使用します。

$domain/config/fmwconfig/composite-offline-deployments-default.xml

SOAサーバーを再起動すると、ファイルに登録されたSOAコンポジット・アプリケーションと共有データがデプロイされます。

表2-12 WLST構成用のSOAコンポジット・アプリケーションのオフライン・デプロイメント管理コマンド

使用するコマンド

用途

使用するWLST

sca_registerCompositeOfflineDeployment

SOAコンポジット・アプリケーションと共有データのオフライン・デプロイメントを登録します。

オフライン

sca_unregisterCompositeOfflineDeployment

SOAコンポジット・アプリケーションと共有データのオフライン・デプロイメントの登録を解除します。

オフライン

これらのWLSTコマンドを使用する際は、次のガイドラインに注意してください。

- 同じSOAコンポジット・アプリケーションが再度登録され、対応するSARファイルが同じ名前の場合、コンポジットは再デプロイされません。オフライン・デプロイメント中は、コンポジットは省略されます。これは、オフライン・デプロイメントではコンポジットの再デプロイメントをサポートしていないためです。

- SOAコンポジット・アプリケーションのJAR名に、接頭辞sca_が付いていることを確認してください。sca_registerCompositeOfflineDeploymentコマンドは、共有データ・デプロイメントまたはコンポジット・デプロイメントのいずれかを登録します。コンポジットSARファイルの名前は常にsca_*.jarになります。sca_で始まるJARファイルのみがコンポジットSARファイルとみなされます。sca_で開始しないJARファイルは、共有データ・ファイルとして扱われます。

- sca_registerCompositeOfflineDeploymentコマンドでSOAコンポジット・アプリケーションの新しいリビジョン(たとえば、sca_HelloWorld.jarのリビジョン2.0)を登録し、サーバーを再起動すると、以前のデフォルトのSOAコンポジット・アプリケーションのリビジョン(たとえば、sca_HelloWorld.jarのリビジョン1.0)はリタイアされます。Oracle SOA Composerなどのランタイム・ツールを使用して古い1.0リビジョンで実行されたランタイム変更は、新しい2.0リビジョンにマージされます。

構成ファイルを使用したオフライン・デプロイメントの詳細は、Oracle SOA SuiteでのSOAアプリケーションの開発のサーバーを実行しないSOAコンポジット・アプリケーションのデプロイに関する項を参照してください。

SARファイルの命名規則の詳細は、Oracle SOA SuiteでのSOAアプリケーションの開発のデプロイ済のサービス・アーカイブに関する項を参照してください。

2.12.1 sca_registerCompositeOfflineDeployment

コマンド・カテゴリ: アプリケーション・オフライン・デプロイメント管理コマンド

WLSTでの使用: オフライン

2.12.1.1 説明

composite-offline-deployments-default.xmlファイル内のSOAコンポジット・アプリケーションと共有データのオフライン・デプロイメントを登録します。登録をすると、SOAサーバーが再起動する際に、ファイルに一覧表示されたSOAコンポジット・アプリケーションおよび共有データをデプロイできるようになります。

2.12.1.2 構文

sca_registerCompositeOfflineDeployment(domainDir, fileLocation, partition)

引数

定義

domainDir

サーバー・ドメインへの絶対パス。

fileLocation

コンポジットSARファイルまたは共有データJARファイルの絶対パス。

default

コンポジットをデプロイするパーティション。この引数はオプションです。指定されない場合、defaultというデフォルトのパーティションが使用されます。

2.12.1.3 例

この例では、ドメイン・ディレクトリおよびsca_HelloWorld.jarコンポジットのファイルの場所を指定します。

wls:/mydomain/ServerConfig> sca_registerCompositeOfflineDeployment
('/scratch/aime1/fmwhome12/user_projects/domains/soainfra',
'/tmp/sca_HelloWorld.jar')

この例では、ドメイン・ディレクトリ、sca_App1.jarコンポジットのファイルの場所およびパーティションmyPartitionを指定します。

wls:/mydomain/ServerConfig> sca_registerCompositeOfflineDeployment
('/scratch/aime1/fmwhome12/user_projects/domains/soainfra','/tmp/sca_App1.jar', partition='myPartition')

この例では、ドメイン・ディレクトリおよびshareddata.jar共有データ・ファイルのファイルの場所を指定します。

wls:/mydomain/ServerConfig> sca_registerCompositeOfflineDeployment
('/scratch/aime1/fmwhome12/user_projects/domains/soainfra',
'/tmp/shareddata.jar')

2.12.2 sca_unregisterCompositeOfflineDeployment

コマンド・カテゴリ: アプリケーション・オフライン・デプロイメント管理コマンド

WLSTでの使用: オフライン

2.12.2.1 説明

サーバーの再起動中に処理されないように、SOAコンポジット・アプリケーションまたは共有データを$domain/config/fmwconfig/composite-offline-deployments-default.xmlファイルから登録解除(削除)します。コンポジットまたは共有データは、オフライン・デプロイメント処理中はチェックされません。これは、既存のSOAコンポジット・アプリケーションには影響しません。サーバーの再起動時に、コンポジットがアンデプロイまたはリタイアされることはありません。

2.12.2.2 構文

sca_unregisterCompositeOfflineDeployment(domainDir, fileLocation)

引数

定義

domainDir

サーバー・ドメインへの絶対パス。

fileLocation

コンポジットSARファイルまたは共有データJARファイルの絶対パス。

2.12.2.3 例

この例では、ドメイン・ディレクトリおよびsca_HelloWorld.jar SARファイルを指定します。

wls:/mydomain/ServerConfig> sca_unregisterCompositeOfflineDeployment
('/scratch/aime1/fmwhome12/user_projects/domains/soainfra','/tmp/sca_HelloWorld.jar')

この例では、ドメイン・ディレクトリおよびshareddata.jar共有データ・ファイルを指定します。

wls:/mydomain/ServerConfig> sca_unregisterCompositeOfflineDeployment('/scratch/aime1/fmwhome12/
user_projects/domains/soainfra','/tmp/shareddata.jar')

2.13 SOAヘルス・チェック・コマンド

SOAヘルス・チェック・フレームワークにより、一連のヘルスチェックおよびヘルスチェック・カテゴリが提供され、システムのヘルスをモニターできます。チェックには、メモリー・チェック、データソース・チェック、SOAアプリケーション・ターゲット・チェック、BPEL関連チェックなどが含まれます。

SOAヘルス・チェックを構成、実行するには、SOAヘルス・チェック・コマンドを使用します(表2-13のリストを参照)。

表2-13 SOAヘルス・チェック・コマンド

使用するコマンド

用途

使用するWLST

executeHealthCheckAndGenerateReport

ヘルス・チェックを実行して、レポートを取得します。

オンライン

executeHealthCheckCategoryAndGenerateReport

ヘルス・チェック・カテゴリを実行して、レポートを取得します。

オンライン

executeHealthChecksAndGenerateReport

指定されたヘルス・チェックを実行して、レポートを取得します。

オンライン

getUnsuccessfulHCRequestIds

指定された時間間隔で、成功しなかったすべての実行のIDを取得します。

オンライン

getUnsuccessfulHCRequestResultReport

指定された不成功のヘルス・チェック実行IDに対応するレポートを取得します。

オンライン

listHealthChecks

すべての登録済ヘルス・チェックをリストします。

オンライン

listHealthChecksInCategory

指定されたカテゴリのすべてのヘルス・チェックをリストします。

オンライン

listHealthCheckCategories

すべてのヘルス・チェック・カテゴリをリストします。

オンライン

deleteAllHCRequestResults

すべてのヘルス・チェック・リクエスト結果を削除します。

オンライン

deleteHCRequestResults

指定された時間間隔の間に収集されたヘルス・チェック・リクエスト結果を削除します。

オンライン

getUnsuccessfulHCResultReport

フィルタ基準と一致する成功しなかったヘルス・チェック実行の結果レポートを取得します。

オンライン

getHCParameter

ヘルス・チェック・パラメータの現在の値を取得します。

オンライン

setHCParameter

その値をヘルス・チェック・パラメータに設定します。

オンライン

resetHCParameter

ヘルス・チェック・パラメータをデフォルト値にリセットします。

オンライン

getHCParameters

ヘルス・チェック・パラメータと値のリストを取得します。

オンライン

enableHCStartupRun

ヘルス・チェック起動実行を有効化または無効化します。

オンライン

setHCStartupRunCategory

ヘルス・チェック起動実行に使用されるカテゴリを変更します。

オンライン

getHCStartupRun

ヘルス・チェック起動実行の詳細を取得します。

オンライン

createHCPeriodicRun

ヘルス・チェック定期実行を、指定された名前と設定で作成します。

オンライン

enableHCPeriodicRun

ヘルス・チェック定期実行を有効化または無効化します。

オンライン

setHCPeriodicRunInterval

定期実行の間隔を変更します。

オンライン

setHCPeriodicRunSchedule

定期実行のスケジュールを変更します。

オンライン

setHCPeriodicRunCategory

定期実行のカテゴリを指定されたカテゴリに変更します。

オンライン

getHCPeriodicRun

指定された定期実行の設定を取得します。

オンライン

getHCPeriodicRuns

すべてのヘルス・チェック定期実行の詳細を取得します。

オンライン

removeHCPeriodicRun

ヘルス・チェック定期実行を削除します。

オンライン

getDisabledHealthChecks

無効化されたヘルス・チェックのリストを取得します。

オンライン

addDisabledHealthCheck

ヘルス・チェックを無効化します。

オンライン

removeDisabledHealthCheck

無効化されたヘルス・チェックを再有効化します。

オンライン

2.13.1 executeHealthCheckAndGenerateReport

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定されたヘルス・チェックを実行して、実行のレポートを取得します。

構文

executeHealthCheckAndGenerateReport(hcName, fileName)

引数

定義

hcName

実行するヘルス・チェックの名前。

fileName

出力レポートを格納するために使用されるファイルの名前とパス。

例2-1 例

次の例は、DatasourceCheckヘルス・チェックを実行して、結果を/tmp/myfileに格納します。

wls:/mydomain/ServerConfig> executeHealthCheckAndGenerateReport('DatasourceCheck',
'/tmp/myfile')

2.13.2 executeHealthCheckCategoryAndGenerateReport

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定されたヘルス・チェック・カテゴリを実行して、実行のレポートを取得します。

構文

executeHealthCheckCategoryAndGenerateReport(categoryName, fileName)

引数

定義

categoryName

実行するヘルス・チェック・カテゴリの名前。

fileName

出力レポートを格納するために使用されるファイルの名前とパス。

例2-2 例

次の例は、Startupヘルス・チェックを実行して、結果を/tmp/myfileに格納します。

wls:/mydomain/ServerConfig> executeHealthCheckCategoryAndGenerateReport('Startup',
'/tmp/myfile')

2.13.3 executeHealthChecksAndGenerateReport

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定されたヘルス・チェックを実行して、実行のレポートを取得します。

構文

executeHealthChecksAndGenerateReport(hcNames, fileName)

引数

定義

hcNames

実行するヘルス・チェックの名前。

fileName

出力レポートを格納するために使用されるファイルの名前とパス。

例2-3 例

wls:/mydomain/ServerConfig>
executeHealthChecksAndGenerateReport(['DatasourceCheck', 'SOALibraryCheck'],
'/tmp/myfile')

2.13.4 getUnsuccessfulHCRequestIds

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定された時間間隔で、成功しなかったすべての実行のIDを取得します。

構文

getUnsuccessfulHCRequestIds(startTime, endTime)

引数

定義

startTime

時間間隔の開始時刻。

endTime

時間間隔の終了時刻。

例2-4 例

次の例は、2014年6月17日の午後1時00分から午後3時00分までの間の、成功しなかったすべての実行のIDを取得します。

wls:/mydomain/ServerConfig> getUnsuccessfulHCRequestIds('Jun 17, 2014 1:00:00 PM',
'Jun 17, 2014 3:00:00 PM')

2.13.5 getUnsuccessfulHCRequestResultReport

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定された不成功のヘルス・チェック実行IDに対応するレポートを取得します。

構文

getUnsuccessfulHCRequestResultReport(id, fileName)

引数

定義

id

ヘルス・チェック実行ID。

fileName

出力レポートを格納するために使用されるファイルの名前とパス。

例2-5 例

次の例は、実行ID2に対応するレポートを取得して、/tmp/myfileに格納します。

wls:/mydomain/ServerConfig> getUnsuccessfulHCRequestResultReport('2',
'/tmp/myfile')

2.13.6 listHealthChecks

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

すべての登録済ヘルス・チェックをリストします。

構文

listHealthChecks()

例2-6 例

次の例は、登録済ヘルス・チェックをリストします。

wls:/mydomain/ServerConfig> listHealthChecks()

Successfully executed the command. Registered health checks  are:
-------------------------------------------------------------------
[DatasourceCheck]
[SOAAppCheck]
[JDBCPoolsCheck]
[SOALibraryCheck]
[BPELAsyncRequestCheck]
[BPELComponentInstanceCheck]
[EDNMessageCheck]
[ServiceCheck]
[MemoryCheck]
-------------------------------------------------------------------

2.13.7 listHealthChecksInCategory

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定されたカテゴリのすべてのヘルス・チェックをリストします。

構文

listHealthChecksInCategory(categoryName)

引数

定義

categoryName

ヘルス・チェック・カテゴリの名前。

例2-7 例

次の例は、Startupカテゴリにある、すべてのヘルス・チェックをリストします。

wls:/mydomain/ServerConfig> listHealthChecksInCategory('Startup')

Successfully executed the command. Registered health checks in the given category are:
---------------------------------------------------------------------------------
---
[DatasourceCheck]
[SOAAppCheck]
[JDBCPoolsCheck]
[SOALibraryCheck]
[ServiceCheck]
[MemoryCheck]
---------------------------------------------------------------------------------
---

2.13.8 listHealthCheckCategories

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

すべてのヘルス・チェック・カテゴリをリストします。

構文

listHealthCheckCategories()

例2-8 例

次の例は、ヘルス・チェック・カテゴリをリストします。

wls:/mydomain/ServerConfig> listHealthCheckCategories()

Successfully executed the command. Registered health check categories  are:
-----------------------------------------------------------------------------
[Startup]
[Quick]
[Intermediate]
[Extensive]
[Config]
-----------------------------------------------------------------------------

2.13.9 deleteAllHCRequestResults

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

すべてのヘルス・チェック・リクエスト結果を削除します。

構文

deleteAllHCRequestResults()

例2-9 例

次の例は、すべてのヘルス・チェック・リクエスト結果を削除します。

wls:/mydomain/ServerConfig> deleteAllHCRequestResults()

Successfully executed the command.

2.13.10 deleteHCRequestResults

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定された時間間隔の間に収集されたヘルス・チェック・リクエスト結果を削除します。

構文

deleteHCRequestResults(startTime, endTime)

引数

定義

startTime

時間間隔の開始時刻。

endTime

時間間隔の終了時刻。

例2-10 例

次の例は、2014年6月17日の午後1時00分から午後3時00分までの間のヘルス・チェック・リクエスト結果を削除します。

wls:/mydomain/ServerConfig> deleteHCRequestResults('Jun 17, 2014 1:00:00 PM',
'Jun 17, 2014 3:00:00 PM')

2.13.11 getUnsuccessfulHCResultReport

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定されたフィルタ基準と一致する、成功しなかったヘルス・チェック実行の結果レポートを取得します。

stateNamesが渡されなかった場合、すべての状態が使用されます。hcNameが渡されない場合、すべてのヘルス・チェックが対象になります。fileNameが渡されない場合、hcResultReport.htmlと呼ばれるレポートが、現在の作業ディレクトリに生成されます。

構文

getUnsuccessfulHCResultReport(startTime, endTime, stateNames=[], hcName=None, fileName='hcResultReport.html')

引数

定義

startTime

時間間隔の開始時刻。

endTime

時間間隔の終了時刻。

stateNames

オプション。状態名(たとえば、['Success'])

hcName

オプション。成功しなかった結果レポートが取得されるヘルス・チェックの名前。

fileName

オプション。出力レポートが格納されるファイルの名前とパス。

例2-11 例

wls:/mydomain/ServerConfig> getUnsuccessfulHCResultReport('Jan 1, 1970 0:00:00
AM', 'Jul 22, 2014 8:00:00 PM', ['Success'], 'DatasourceCheck',
'/tmp/myfile')

2.13.12 getHCParameter

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定されたヘルス・チェック・パラメータの現在の値を取得します。

構文

getHCParameter(paramName)

引数

定義

paramName

確認するヘルス・チェック・パラメータの名前。

例2-12 例

wls:/mydomain/ServerConfig> getHCParameter("MemoryCheck.memThreshold")

Health Check Parameter:
----------------------------
Name  : MemoryCheck.memThreshold
Value : 25

2.13.13 setHCParameter

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

ヘルス・チェック・パラメータを指定された値に設定します。このコマンドは、ヘルス・チェック・パラメータのデフォルト値をオーバーライドします。

構文

setHCParameter(paramName, paramValue)

引数

定義

paramName

更新するヘルス・チェック・パラメータの名前。

paramValue

ヘルス・チェック・パラメータの新しい値。

例2-13 例

wls:/mydomain/ServerConfig> setHCParameter("MemoryCheck.memThreshold", "35")

2.13.14 resetHCParameter

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定されたヘルス・チェック・パラメータをデフォルト値にリセットします。

構文

resetHCParameter(paramName)

引数

定義

paramName

更新するヘルス・チェック・パラメータの名前。

例2-14 例

wls:/mydomain/ServerConfig> resetHCParameter("MemoryCheck.memThreshold")

2.13.15 getHCParameters

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

ヘルス・チェック・パラメータと値のリストを取得します。

構文

getHCParameters()

例2-15 例

wls:/mydomain/ServerConfig> getHCParameters()

Successfully executed the command. Health check parameters are:
----------------------------------------------------------------
JDBCPoolsCheck.ConnectionMaxMillis=2000
EDNMessageCheck.pendingMsgOaooCount=5000
EDNMessageCheck.pendingMsgCount=2000
BPELAsyncRequestCheck.pendingAsyncReqCount=1000
BPELComponentInstanceCheck.faultInstanceCount=500
BPELComponentInstanceCheck.openInstanceCount=1000
JDBCPoolsCheck.TestMaxMillis=1000
MemoryCheck.memThreshold=35
----------------------------------------------------------------

2.13.16 enableHCStartupRun

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

ヘルス・チェック起動実行を有効化または無効化します。

構文

enableHCStartupRun(enabledFlag)

引数

定義

enabledFlag

ヘルス・チェック起動実行を有効化または無効化するために使用されるブール値(trueまたはfalse)。

例2-16 例

次の例は、起動実行を有効化します。

wls:/mydomain/ServerConfig> enableHCStartupRun(true)

2.13.17 setHCStartupRunCategory

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

ヘルス・チェック起動実行に使用されるカテゴリを変更します。

構文

setHCStartupRunCategory(categoryName)

引数

定義

categoryName

起動実行に使用されるヘルス・チェック・カテゴリの名前。

例2-17 例

次の例は、起動実行カテゴリを「クイック」に設定します。

wls:/mydomain/ServerConfig> setHCStartupRunCategory('Quick')

2.13.18 getHCStartupRun

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

ヘルス・チェック起動実行の詳細を取得します。詳細には、起動実行ヘルス・チェック・カテゴリと、実行のステータス(「有効」またはdisabled)が含まれます。

構文

getHCStartupRun()

例2-18 例

wls:/mydomain/ServerConfig> getHCStartupRun()

Startup Run
-----------------------------
Category Name : Startup
Enabled       : true

2.13.19 createHCPeriodicRun

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

ヘルス・チェック定期実行を、指定された名前と設定で作成します。

構文

createHCPeriodicRun(name, enabledFlag, interval, minuteOfHour, hourOfDay,

dayOfWeek, categoryName)

引数

定義

name

定期実行の名前。

enabledFlag

定期実行が有効化されるか無効化されるかを決定するブール値(trueまたはfalse)。

interval

2回の定期実行の間隔(時間間隔。単位は分)。

minuteOfHour

最初の実行を開始する時刻の分。値-1は即時を表します。

hourOfDay

最初の実行を開始する時刻の時。値-1は即時を表します。

dayOfWeek

最初の実行を開始する曜日。値-1は即時を表します。

categoryName

定期実行に使用されるヘルス・チェック・カテゴリの名前。

例2-19 例

wls:/mydomain/ServerConfig> createHCPeriodicRun('myrun', true, 30, 0, -1, -1,
'Intermediate')

2.13.20 enableHCPeriodicRun

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

ヘルス・チェック定期実行を有効化または無効化します。

構文

enableHCPeriodicRun(name, enabledFlag)

引数

定義

name

有効化または無効化する定期実行の名前。

enabledFlag

定期実行が有効化されるか無効化されるかを決定するブール値(trueまたはfalse)。

例2-20 例

次の例は、定期ヘルス・チェックmyrunを有効化します。

wls:/mydomain/ServerConfig> enableHCPeriodicRun('myrun', true)

2.13.21 setHCPeriodicRunInterval

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定された定期実行の間隔を変更します。

構文

setHCPeriodicRunInterval(name, interval)

引数

定義

name

ヘルス・チェック定期実行の名前。

interval

指定された定期実行の、継起する実行との間の時間間隔(単位は分)。

例2-21 例

次の例は、定期ヘルス・チェックmyrunの間隔を2時間に設定します。

wls:/mydomain/ServerConfig> setHCPeriodicRunInterval('myrun', 120)

2.13.22 setHCPeriodicRunSchedule

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定された定期実行のスケジュールを変更します。

構文

setHCPeriodicRunSchedule(name, minuteOfHour, hourOfDay, dayOfWeek)

引数

定義

name

ヘルス・チェック定期実行の名前。

minuteOfHour

最初の実行を開始する時刻の分。値-1は即時を表します。

hourOfDay

最初の実行を開始する時刻の時。値-1は即時を表します。

dayOfWeek

最初の実行を開始する曜日。値-1は即時を表します。

例2-22 例

wls:/mydomain/ServerConfig> setHCPeriodicRunSchedule('hourly', 0, -1, -1)

2.13.23 setHCPeriodicRunCategory

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

定期実行のカテゴリを指定されたカテゴリに変更します。

構文

setHCPeriodicRunCategory(name, categoryName)

引数

定義

name

ヘルス・チェック定期実行の名前。

categoryName

定期実行に使用されるヘルス・チェック・カテゴリの名前。

例2-23 例

wls:/mydomain/ServerConfig> setHCPeriodicRunCategory('myrun', 'Extensive')

2.13.24 getHCPeriodicRun

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定された定期実行に関する詳細(カテゴリ、スケジュールおよび有効なステータスなど)を取得します。

Syntax

getHCPeriodicRun(name)

引数

定義

name

ヘルス・チェック定期実行の名前。

例2-24 例

wls:/mydomain/ServerConfig> getHCPeriodicRun('myrun')

Periodic Run
-----------------------------
Name           : myrun
Category Name  : Extensive
Enabled        : false
Interval       : 2
Day of week    : -1
Hour of day    : -1
Minute of hour : 0

2.13.25 getHCPeriodicRuns

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

すべてのヘルス・チェック定期実行の詳細を取得します。

構文

getHCPeriodicRuns()

例2-25 例

wls:/mydomain/ServerConfig> getHCPeriodicRuns()

Periodic Run Table
-----------------------------
PeriodicRun: frequently, enabled=false, interval=60, minuteOfHour=7, hourOfDay=-1,
dayOfWeek=-1, category=Quick
PeriodicRun: daily, enabled=false, interval=1440, minuteOfHour=15, hourOfDay=5,
dayOfWeek=-1, category=Intermediate
PeriodicRun: weekly, enabled=false, interval=10080, minuteOfHour=30, hourOfDay=3,
dayOfWeek=1, category=Extensive
PeriodicRun: myrun, enabled=false, interval=2, minuteOfHour=0, hourOfDay=-1,
dayOfWeek=-1, category=Extensive
PeriodicRun: myrun2, enabled=false, interval=2, minuteOfHour=0, hourOfDay=-1,
dayOfWeek=-1, category=Intermediate
PeriodicRun: myrun3, enabled=false, interval=2, minuteOfHour=0, hourOfDay=-1,
dayOfWeek=-1, category=Intermediate
PeriodicRun: myrun4, enabled=false, interval=30, minuteOfHour=0, hourOfDay=-1,
dayOfWeek=-1, category=Intermediate

2.13.26 removeHCPeriodicRun

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定されたヘルス・チェック定期実行を削除します。

構文

removeHCPeriodicRun(name)

引数

定義

name

削除するヘルス・チェック定期実行の名前。

例2-26 例

wls:/mydomain/ServerConfig> removeHCPeriodicRun('myrun')

2.13.27 getDisabledHealthChecks

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

無効化されたヘルス・チェックのリストを取得します。

構文

getDisabledHealthChecks()

例2-27 例

wls:/mydomain/ServerConfig> getDisabledHealthChecks()

2.13.28 addDisabledHealthCheck

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

指定されたヘルス・チェックを無効化します。

構文

addDisabledHealthCheck(hcName)

引数

定義

hcName

無効化するヘルス・チェックの名前。

例2-28 例

wls:/mydomain/ServerConfig> addDisabledHealthCheck('DatasourceCheck')

2.13.29 removeDisabledHealthCheck

コマンド・カテゴリ: SOAヘルス・チェック・コマンド

説明

WLSTでの使用: オンライン

無効化したヘルス・チェックを再有効化します。

構文

removeDisabledHealthCheck(hcName)

引数

定義

hcName

有効化するヘルス・チェックの名前。

例2-29 例

wls:/mydomain/ServerConfig> removeDisabledHealthCheck('DatasourceCheck')

3 Oracle Business Process ManagementのカスタムWLSTコマンド

この章では、Oracle Business Process ManagementのカスタムWLSTコマンドのリストを示し、説明します。

3.1 BPMLifecycleAdminコマンド・グループ

表3-1では、プロジェクトのライフサイクル管理用のBPMLifecycleAdminコマンドを一覧して説明しています。

表3-1 プロジェクトのライフサイクル管理用のBPMLifecycleAdminコマンド

使用するコマンド

用途

使用するWLST

create_public_share

公開共有の作成

オフライン

unlock_public_share

公開共有のロック解除

オフライン

export_public_share

公開共有のファイル・システムへのエクスポート

オフライン

delete_public_share

公開共有の削除

オフライン

publish_template

テンプレートのMDSへの公開

オフライン

export_template

ファイル・システムへのテンプレートのエクスポート

オフライン

delete_template

MDSからのテンプレートの削除

オフライン

3.1.1 create_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

3.1.1.1 説明

テンプレートから公開共有を作成するにはこのコマンドを使用します。テンプレートはMDSに存在している必要があります。

3.1.1.2 Syntax

create_public_share(composerUser, composerPassword, connectionURL, templateName, publicshareId, mdsconfigLocation, [Override], [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

templateName

MDS内のテンプレートの名前

publicshareId

作成する公開共有の名前

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

projectLocation

公開共有が作成される場所のパス。パスが存在しない場合には作成されます。ルートは、'/'です。

Override

MDSに同じ名前の公開共有がある場合、公開共有をオーバーライドできます。このコマンドを実行した際、テンプレートは上書きされません。

oracleHome

オプション。使用するOracleホーム。

3.1.1.3 例

次の例では、Sample_PublicShareという名前の公開共有を作成します。これは、Sample_Templateという名前のテンプレートに基づいています。公開共有の名前はSample_PublicShareであり、mds-config.xmlファイルの場所は/tmp/mds-config.xmlです。

create_public_share('user_name', 'password', 'host:port','Sample_Template', 'Sample_PublicShare','/tmp/mds-config.xml')

次の例では、Sample_PublicShareという名前の公開共有を作成します。これは、MDS内に存在するSample_Templateという名前のテンプレートに基づいています。テンプレートではなく、公開共有がオーバーライドされます。mds-config.xmlファイルの場所は/tmp/mds-config.xmlです。

create_public_share('user_name', 'password', 'host:port','Sample_Template', 'Sample_PublicShare','/tmp/mds-config.xml','true')"

3.1.2 unlock_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

3.1.2.1 説明

このコマンドを使用して、公開共有をロック解除します。たとえば、Antタスクcreate_public_shareコマンドを使用してプロジェクトを作成する場合、そのプロジェクトはロックされた状態で作成されます。その後、unlock_public_shareコマンドを使用してそれをロック解除できます。

ロックは、Oracle Business Process Composerの「プロジェクトの作成」ページにある「共有の有効化」チェック・ボックスを選択するか、選択を解除することによっても設定できます。

また、これはユーザーがBusiness Process Composerからプロジェクトを公開する際にも解放されます。

公開共有はMDSに存在している必要があります。

3.1.2.2 構文

unlock_public_share(composerUser, composerPassword, connectionURL, publicshareId, mdsconfigLocation, [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

publicshareId

ロック解除する公開共有の名前

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

oracleHome

オプション。使用するOracleホーム

3.1.2.3 例

次の例では、Sample_PublicShareという名前の公開共有をロック解除します。mds-config.xmlファイルの場所は/tmp/mds-config.xmlです。

unlock_public_share('user_name', 'password', 'host:port','Sample_PublicShare', '/tmp/mds-config.xml')

3.1.3 export_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

3.1.3.1 説明

公開共有をMDSからファイル・システムにエクスポートするにはこのコマンドを使用します。

3.1.3.2 構文

export_public_share(composerUser, composerPassword, connectionURL, publicshareId,fsLocation, mdsconfigLocation, [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

publicshareId

エクスポートする公開共有の名前

fsLocation

プロジェクトがダウンロードされるファイル・システムの場所

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

oracleHome

オプション。使用するOracleホーム

3.1.3.3 例

次の例では、公開共有名としてSample_PublicShareを、ファイル・システムの場所として/tmpを、mds-config.xmlファイルの場所として/tmp/mds-config.xmlを指定します。

export_public_share('user_name', 'password', 'host:port','Sample_PublicShare','/tmp', '/tmp/mds-config.xml')

3.1.4 delete_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

3.1.4.1 説明

MDSから公開共有を削除するにはこのコマンドを使用します。このコマンドを実行するには、公開共有がロックされていないことが必要です。

3.1.4.2 構文

delete_public_share(composerUser, composerPassword, connectionURL, publicshareId, mdsconfigLocation, [releaseLock], [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

publicshareId

削除する公開共有の名前

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

releaseLock

オプション。公開共有がロックされている場合、このロックは解除でき、削除操作を完了できます。この属性は、trueとfalseのいずれかに設定できます。指定しない場合、デフォルト値はfalseです。

oracleHome

オプション。使用するOracleホーム

3.1.4.3 例

次の例では、削除する公開共有の名前および場所を指定します。

delete_public_share('Sample_PublicShare','/tmp/mds-config.xml')

次の例では、削除する公開共有の名前および場所を指定し、公開共有がロックされている場合でも公開共有は削除されるよう指定しています。

delete_public_share('user_name', 'password', 'host:port','Sample_PublicShare','/tmp/mds-config.xml','true')

3.1.5 publish_template

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

3.1.5.1 説明

テンプレートをファイル・システムからMDSに公開するにはこのコマンドを使用します。

3.1.5.2 構文

publish_template(composerUser, composerPassword, connectionURL, templateName,fsLocation, mdsconfigLocation, [Override], [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

templateName

公開するテンプレートの名前

fsLocation

テンプレート・プロジェクトのファイル・システムの場所

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

projectLocation

公開共有が作成される場所のパス。パスが存在しない場合には作成されます。ルートは、'/'です。

Override

MDS内でテンプレートを公開する際、この属性を使用すると同じ名前の既存のテンプレートをオーバーライドできます。「true」または「false」のいずれかの値になります。指定されない場合、デフォルト値は「false」です。

oracleHome

オプション。使用するOracleホーム

3.1.5.3 例

次の例では、Sample_Template_Name_MDSという名前のテンプレートをルート・フォルダに公開します。

f('user_name', 'password', 'host:port','Sample_Template','/tmp/MyTemplate','/', '/tmp/mds-config.xml')

次の例では、Sample_Template_Name_MDSという名前のテンプレートを '/WorkingOn/'フォルダに公開します。

publish_template('user_name', 'password', 'host:port','Sample_Template','/tmp/MyTemplate','/WorkingOn', '/tmp/mds-config.xml')

3.1.6 export_template

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

3.1.6.1 説明

テンプレートをMDSからファイル・システムにエクスポートするにはこのコマンドを使用します。

3.1.6.2 構文

export_template(composerUser, composerPassword, connectionURL, templateName, fsLocation, mdsconfigLocation, [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

templateName

エクスポートするテンプレートの名前

fsLocation

プロジェクトがダウンロードされるファイル・システムの場所

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

oracleHome

オプション。使用するOracleホーム

3.1.6.3 例

次の例では、テンプレート名としてSample_Templateを、ファイル・システムの場所として/tmpを、mds-config.xmlファイルの場所として/tmp/mds-config.xmlを指定します。

export_template('user_name', 'password', 'host:port','Sample_Template','/tmp','/tmp/mds-config.xml')

3.1.7 delete_template

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

3.1.7.1 説明

MDSからテンプレートを削除するにはこのコマンドを使用します。

3.1.7.2 構文

delete_template(composerUser, composerPassword, connectionURL, templateName,mdsconfigLocation, [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

templateName

削除するテンプレートの名前

fsLocation

テンプレート・プロジェクトのファイル・システムの場所

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

projectLocation

公開共有が作成される場所のパス。パスが存在しない場合には作成されます。ルートは、'/'です。

oracleHome

オプション。使用するOracleホーム

3.1.7.3 例

次の例では、Sample_templateという名前のテンプレートをMDSから削除します。

delete_template('weblogic', 'welcome1', 'host:port','/Sample_template','/tmp/mds-config.xml')

4 Oracle Enterprise SchedulerのカスタムWLSTコマンド

Oracle Enterprise Schedulerジョブを管理するには、Oracle Enterprise Scheduler (ESS)コマンドを使用します。シェル・スクリプトと同様に便利な多くのコマンドによって実行が簡単になります。ネイティブ・コマンドについては「Oracle Enterprise Schedulerのカスタム・ネイティブ・コマンド」、シェル・スクリプトについては「Oracle Enterprise Schedulerの便利なスクリプト」で説明します。

注意:

Oracle Enterprise SchedulerのカスタムWLSTコマンドを使用するには、Oracle共通ホームからWLSTスクリプトを起動する必要があります。Oracle Fusion Middlewareの管理のカスタムWLSTコマンドの使用に関する項を参照してください。

この章の内容は次のとおりです。

- ネイティブ呼出し

- 「Oracle Enterprise Schedulerのカスタム・ネイティブ・コマンド」

- Oracle Enterprise Schedulerのバッチ削除リクエスト

- 作業割当てコマンド

- Oracle Enterprise Schedulerの診断ダンプ

- 「Oracle Enterprise Schedulerの便利なスクリプト」

4.1 ネイティブ呼出し

次の手順に、この章で説明するWLSTネイティブ・コマンドを実行する方法を示します。これらのコマンドの多くに便利なシェル・スクリプトを使用でき、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されています。

1. 次のディレクトリに移動します。

$ORACLE_HOME/common/bin

2. 次のJARアーカイブをクラス・パスに配置します。

- MW_HOME/oracle_common/modules/oracle.jmx_11.1.1/jmxframework.jar

- MW_HOME/WLS_HOME/lib/weblogic.jar

- MW_HOME/ORACLE_HOME/ess/lib/ess-admin.jar

3. 次のコマンドのいずれかを実行します。

- wlst.sh (Linux)

- wlst.cmd (Windows)

4. WLS管理サーバーに接続します。次に例を示します。

connect('weblogic', 'weblogic1', 't3://hostabc:7001')

5. WLSTコマンドを呼び出します。

4.1.1 プリント文の有効化および無効化

Oracle Enterprise Schedulerのプリント出力は、次のように明示的に有効または無効にできます。対話形式の使用では、プリントを有効にする必要があります。デフォルトでは、Oracle Enterprise Schedulerのプリントは有効になっています。

- enableESSPrint() — Oracle Enterprise SchedulerのWLSTコマンドのプリント出力を有効にします。

- disableESSPrint() — Oracle Enterprise SchedulerのWLSTコマンドのプリント出力を無効にします。

4.1.2 ヘルプの利用

WLSTコンソールでは、次のように入力して使用可能なOracle Enterprise Schedulerのネイティブ・コマンドのリストを取得できます。

wls:/offline> help('OracleScheduler')

コマンドの使用方法の情報を取得するには、help('command_name')と入力します。次に例を示します。

wls:/offline> help('manageSchedulerRuntimeConfig')

4.2 「Oracle Enterprise Schedulerのカスタム・ネイティブ・コマンド」

Oracle Enterprise Schedulerのサーバー、構成、ジョブ・リクエストおよびログを管理するには、表4-1に示されたOracle Enterprise Schedulerコマンドを使用してください。3列目の「オンライン」とは、実行中の管理サーバーに接続している場合にのみ、そのコマンドが使用できることを意味します。「オフライン」とは、実行中のサーバーに接続していない場合にのみ、そのコマンドが使用できることを意味します。

表4-1 Oracle Enterprise Scheduling Serviceの基本コマンド

使用するコマンド

用途

使用するWLST

manageSchedulerRuntimeConfig

様々な構成パラメータを追加、変更、削除および表示します。

オンライン

getSchedulerRequestContent

リクエストの実行完了後にリクエストに対するログおよび出力データ・ファイルを取得します。

オンライン

querySchedulerRequests

ホスティング・アプリケーションの名前、状態、実行の経過時間に基づいて、リクエストを検索および一覧表示します。

オンライン

manageSchedulerRequest

リクエストの状態を手動で、取消し、リカバリまたは完了します。

オンライン

manageSchedulerServer

サーバーで実行中のOracle Enterprise Schedulerアプリケーションを起動、停止およびステータスの取得をします。

オンライン

submitSchedulerRequest

Oracle Enterprise Schedulerへの実行のジョブ・リクエストを発行します。

オンライン

manageSchedulerJobDefn

Oracle Enterprise Schedulerのジョブ定義を管理(表示、作成、削除、カスタマイズ、更新)します。

オンライン

manageSchedulerSchedule

Oracle Enterprise Schedulerのスケジュール定義を管理(表示、作成、削除、カスタマイズ、更新)します。

オンライン

4.2.1 「構成パラメータの管理(追加/削除/修正/取得)」

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.2.1.1 説明

様々な構成パラメータを追加、変更、削除および表示します。

4.2.1.2 構文

manageSchedulerRuntimeConfig(app,type,[operation],[name],[val])

引数

定義

app

ランタイム構成を管理するホスティング・アプリケーションの名前です。

type

プロパティのタイプです。APPまたはESSのいずれかが可能です。

operation

オプション。実行する操作。次のうちの1つ。

- 追加(add)

- 変更(mod)

- 削除(del)

- 取得(get)

- すべて取得(getall)

name

(getall操作用のオプション)構成パラメータの名前です。

val

(del/get/getall操作用のオプション)パラメータに対して設定する値です。

4.2.1.3 例

- ENVパラメータfooを値"bar"とともに追加

manageSchedulerRuntimeConfig("myapp", "APP", operation="add", name="foo", val="bar")

- ENVパラメータfooの値の取得

manageSchedulerRuntimeConfig("myapp", "APP", operation="get", name="foo")

- すべてのENVパラメータのリストの取得

manageSchedulerRuntimeConfig("myapp", "APP", operation="getall") manageSchedulerRuntimeConfig("myapp", "APP")

- ENVパラメータfooの値の"barone"への変更

manageSchedulerRuntimeConfig("myapp", "APP", operation="mod", name="foo", val="barone")

- ENVパラメータfooの削除

manageSchedulerRuntimeConfig("myapp", "APP", operation="del", name="foo")

- タイプESSのすべてのパラメータの表示

manageSchedulerRuntimeConfig("myapp", "ESS")

4.2.1.4 関連シェル・スクリプト

essManageRuntimeConfig

4.2.2 「リクエストのログおよび出力コンテンツの取得」

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.2.2.1 説明

リクエストの実行完了後にリクエストに対するログおよび出力データ・ファイルを取得します。

4.2.2.2 構文

getSchedulerRequestContent(requestId,contentType,[logLines], [outDir])

引数

定義

requestId

リクエストID

contentType

処理するコンテンツのタイプ。次のいずれかが可能です。

- LOG

- OUTPUT

- BINARY_OUTPUT

- TEXT_OUTPUT

このコマンドは、デフォルトではBINARY_OUTPUTおよびTEXT_OUTPUTの両方をチェックします。

logLines

オプション。リクエスト・ログから読み取られる行数です。デフォルト値は1000です。

outDir

オプション。出力ファイルをダンプするディレクトリの絶対パスです。デフォルトでは、このコマンドは現在のディレクトリを使用します。

4.2.2.3 例

- リクエストID 123のリクエスト・ログの取得

getSchedulerRequestContent(123, "LOG")

- リクエスト123のすべての出力を取得

getSchedulerRequestContent(123, "OUTPUT")

- リクエスト123のすべての出力を取得し、それをディレクトリ/tmpに保存

getSchedulerRequestContent(123, "OUTPUT", outDir="/tmp")

- リクエスト123のすべてのテキスト出力を取得し、それをディレクトリ/tmpに保存

getSchedulerRequestContent(123, "TEXT_OUTPUT", outDir="/tmp")

- リクエスト123のすべてのバイナリ出力を取得し、それをディレクトリ/tmpに保存

getSchedulerRequestContent(123, "BINARY_OUTPUT", outDir="/tmp")

- リクエストID 123のリクエスト・ログの最初の100行を取得

getSchedulerRequestContent(123, "LOG", logLines=100)

4.2.2.4 関連シェル・スクリプト

essGetOutputContent

4.2.3 リクエストの検索および一覧表示

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.2.3.1 説明

ホスティング・アプリケーションの名前、状態、実行の経過時間に基づいて、リクエストを検索および一覧表示します。このコマンドは、長時間実行しているリクエストの検出に使用できます。

4.2.3.2 構文

querySchedulerRequests([app],[state],[days],[hours],[minutes])

引数

定義

app

オプション。ホスティング・アプリケーションの名前です

state

オプション。リクエスト状態を指定します。次のいずれかです。

- WAIT

- READY

- RUNNING

- COMPLETED

- BLOCKED

- HOLD

- CANCELLING

- EXPIRED

- CANCELLED

- ERROR

- WARNING

- SUCCEEDED

- PAUSED

- PENDING_VALIDATION

- VALIDATION_FAILED

- SCHEDULE_ENDED

- FINISHED

- ERROR_AUTO_RETRY

- ERROR_MANUAL_RECOVERY

デフォルトで、このコマンドはRUNNINGを指定します。

days

オプション。日数を指定します。

hours

オプション。時間数を指定します。

minutes

オプション。時間数を指定します。

4.2.3.3 例

- RUNNING状態のすべてのリクエストの取得

querySchedulerRequests()
or
querySchedulerRequests(state="RUNNING")

- 取り消されたすべてのリクエストの取得

querySchedulerRequests(state="CANCELLED")

- 実行してから2日を過ぎているすべてのリクエストの取得

querySchedulerRequests(days=2)

- 実行してから10時間を過ぎているすべてのリクエストの取得

querySchedulerRequests(hours=10)

- アプリケーションmyappに対して実行しているすべてのリクエストの取得

querySchedulerRequests(appName="myapp")

4.2.3.4 シェル・スクリプト

essQueryRequests

4.2.4 リクエストの管理

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.2.4.1 説明

手動によるリクエストの取消し、リカバリ、完了またはリクエストの詳細を取得します。

4.2.4.2 構文

manageSchedulerRequest(requestId,operation,[asyncStatus], [statusMessage])

引数

定義

requestid

リクエストIDの指定

operation

次の操作のどれを実行するかを指定します。

- CANCEL

- RECOVER

- COMPLETE

- GETDETAIL

asyncStatus

COMPLETE操作に必要です。指定されたリクエストに対して設定するステータスを指定します。次のいずれかを指定する必要があります。

- SUCCESS

- PAUSE

- WARNING

- ERROR

- CANCEL

- UPDATE

- BIZ_ERROR

- ERROR_MANUAL_RECOVERY

statusMessage

COMPLETE操作に必要です。操作を説明する限定的なステータス・メッセージを指定します

4.2.4.3 例

- リクエスト123の取消し

manageSchedulerRequest(123, "CANCEL")

- リクエスト123のリカバリ

manageSchedulerRequest(123, "RECOVER")

- リクエスト123の完了

manageSchedulerRequest(123, "COMPLETE", asyncStatus="ERROR", statusMessage="Completed by Admin")

4.2.4.4 関連シェル・スクリプト

essManageRequests

4.2.5 「Oracle Enterprise Schedulerサーバーの管理」

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.2.5.1 説明

サーバーで実行中のOracle Enterprise Schedulerアプリケーションの起動、停止またはステータスを取得します。Oracle Enterprise Schedulerアプリケーションを起動すると、Oracle Enterprise Schedulerプロセッサ・スレッドが起動され、リクエスト処理を開始できます。Oracle Enterprise Schedulerアプリケーションを停止すると、Oracle Enterprise Schedulerプロセッサが停止または休止され、新しいリクエストが処理されなくなります。

4.2.5.2 構文

manageSchedulerServer(operation)

引数

定義

operation

次の操作のどれを実行するかを指定します。

- START

- STOP

- STATUS

4.2.5.3 例

- Oracle Enterprise Schedulerの停止

manageSchedulerServer("STOP")

- Oracle Enterprise Schedulerプロセッサの現在の状態の取得

manageSchedulerServer("STATUS")

4.2.5.4 関連シェル・スクリプト

essManageServer

4.2.6 「Oracle Enterprise Schedulerへのジョブ・リクエストの発行」

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.2.6.1 説明

Oracle Enterprise Schedulerへの実行のジョブ・リクエストを発行します。

4.2.6.2 構文

submitSchedulerRequest(appName,[jobName],[schMeth],[note], [schName],[RschName],[schDesc],[o_time],[begin_time], [frequency],[freqNum],[count],[end_time],[month],[week],[day], [date],[reqParams])

注意:

ジョブ定義は事前定義する必要がありますが、スケジュールはこのコマンドを使用してアドホック方式で定義できます。

引数

定義

appName

ジョブ用のホスティング・アプリケーションの名前です。

jobName

現在のリクエストに使用されるジョブ定義の名前です。(パッケージ名を含む)パス名は完全修飾される必要があります。完全修飾されていない場合、コマンドはデフォルト・パッケージ/oracle/apps/ess/customを使用します。

schMeth

オプション。次のスケジュール方法のどれを使用するかを指定します。

- IMMEDIATE (I) - 他のパラメータは不要です。これはデフォルトの方法で、schMeth引数が指定されない場合に使用されます。

- ONCE (O) - この方法が使用された場合、o_time引数が必要です。

- SCHEDULE (S) - この方法が使用された場合、schName引数が必要です。

- RECURRING (R) - この方法が使用された場合、RschNameおよびfrequency引数が必要です。
引数schDesc、begin_time、freqNum、count、end_time、month、week、day、dateおよびfrequencyは、Recurring(R)方法の場合のみ有効です。「frequency」値に基づいたパラメータの組み合せは次のとおりです。

オプションSECOND| MINUTE | HOUR | DAY | WEEKのいずれかとともにRecurring (R)方法を使用した場合、引数freqNum、begin_time、[count | end_time]を使用する必要があります。

MONTHオプションとともに繰返し(R)方法を使用した場合、引数[{week day} | date] begin_time [count | end_time]を使用する必要があります。

YEARオプションとともに繰返し(R)方法を使用する場合、引数 [month ({week day} | date)] begin_time [count | end_time]を使用する必要があります。

繰返し(R)方法を使用する際は、スケジュールは今後の使用のためMDSに格納され、記憶域の場所は指定されたスケジュール名に基づきます。

例は、「例」を参照してください。

note

オプション。ジョブ・リクエストの簡単な説明を指定します。

schName

オプション。事前定義済のスケジュール定義の名前を指定します。(パッケージ名を含む)パス名は完全修飾される必要があります。完全修飾されていない場合、コマンドはデフォルト・パッケージ/oracle/apps/ess/customを使用します。

RschName

オプション。繰返し(R)オプションをschMeth引数に使用してスケジュールを定義する場合、スケジュールの名前を指定します。

schDesc

オプション。アドホック・スケジュールを説明する文字列値を指定します。デフォルトでは、この値は"Custom Ad-Hoc Schedule"です。

o_time

オプション。「ワンタイム」実行の時間を指定します。形式は、HH:MM:SS:DD:MM:YYYYです。

begin_time

オプション。繰返しスケジュールの開始時間を指定します。形式は、HH:MM:SS:DD:MM:YYYYです。

frequency

オプション。繰返しスケジュールの頻度を指定します。有効な値は、SECOND、MINUTE、HOUR、DAY、WEEK、MONTH、YEARです。

freqNum

オプション。繰返しスケジュールの繰返し間隔を指定する整数値です。デフォルト値は「1」です。

count

オプション。リクエストの繰返しの最大数を指定します。

end_time

オプション。繰返しスケジュールの終了時間を指定します。形式は、HH:MM:SS:DD:MM:YYYYです。

month

オプション。frequencyがYEARLYと指定された場合、何月かを指定します。有効な値は1-12です。

week

オプション。ある月の週を指定します。有効な値は1-6、LASTです。

day

オプション。曜日を指定します。有効な値は1-7で、「1」は月曜日を表します。

date

オプション。月の特定の日を指定します。有効な値は1-31、LASTです

reqParams

オプション。ディクショナリとして指定された他のリクエスト・パラメータまたはプロパティを指定します。

4.2.6.3 例

これらの例では次の変数が使用されています。

変数

値

HOSTING_APP

EssDemoApp

SCHEDULE_NAME

/oracle/apps/ess/custom/MySch

JOB_DEF_NAME

/oracle/apps/ess/demopackage/BasicJavaJob

- 即時ジョブ実行のリクエストの発行(ワンタイムのみ)

submitSchedulerRequest(HOSTING_APP, JOB_DEF_NAME)

- 指定された時間にワンタイム・ジョブ実行のリクエストを発行

submitSchedulerRequest(HOSTING_APP, JOB_DEF_NAME, schMeth='O',  o_time='21:10:30:03:05:2012')

- 繰返しスケジュールでジョブ・リクエストを発行。この繰返しは、2012年5月3日の時刻21:10:30から始めて、3回繰り返されるまで実行されます。追加のリクエスト・パラメータは、reqName =testおよびPRIORITY= 10です。この繰返しは、今後の使用のためにMDSリポジトリにも保持されます。

submitSchedulerRequest(HOSTING_APP, JOB_DEF_NAME, schMeth='R', RschName=SCHEDULE_NAME, frequency='MINUTE', freqNum=2, count=3, begin_time='21:10:30:03:05:2012', reqParams={'reqName':'test','PRIORITY':'10'})

- 事前定義済のスケジュールを使用してジョブ・リクエストを発行

submitSchedulerRequest(HOSTING_APP, JOB_DEF_NAME, schMeth='S',  schName=SCHEDULE_NAME)

- 月の繰返しスケジュールでジョブ・リクエストを発行。リクエストの説明は、「Request with monthly schedule」です。繰返しスケジュール名および説明は、それぞれRschNameおよびschDescを使用して指定されます。

submitSchedulerRequest(HOSTING_APP, JOB_DEF_NAME, note='Request with monthly schedule', schMeth='R', RschName=SCHEDULE_NAME+'1', schDesc='Monthly_schedule', frequency='MONTH', freqNum=2, begin_time='21:10:30:03:05:2012', week=5, day=4, end_time='21:10:30:04:05:2013')

- 1年ごとに繰返すスケジュールでジョブ・リクエストを発行。リクエストの説明は、「Request with yearly schedule」です。繰返しスケジュール名および説明は、それぞれRschNameおよびschDescによって指定されます。
2012年5月3日の21:10:30から始めて、5月の最終日(31日)に実行され、3年ごとに5回繰り返し実行されます。

submitSchedulerRequest(HOSTING_APP, JOB_DEF_NAME,note='Request with yearly schedule',schMeth='R',RschName=SCHEDULE_NAME+'2', schDesc='Yearly_schedule', frequency='YEAR',freqNum=3,begin_time='21:10:30:03:05:2012',month=5, date='LAST',count=5)

- 1時間ごとに繰返すスケジュールでジョブ・リクエストを発行。このスケジュールはMDSに格納されます。この繰返しは、現在の時刻に始めて、1時間ごとに繰り返されるように設定されます。

submitSchedulerRequest(HOSTING_APP, JOB_DEF_NAME,schMeth='R', RschName=SCHEDULE_NAME,schDesc='HOURLY_schedule',frequency='HOUR')

4.2.6.4 関連シェル・スクリプト

essSubmitRequest

4.2.7 「Oracle Enterprise Schedulerのジョブ定義の管理」

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.2.7.1 説明

Oracle Enterprise Schedulerのジョブ定義を管理(表示、作成、削除、カスタマイズ、更新)します。

operationがSHOWに設定された場合およびjobNameが指定された場合、コマンドはこの特定のジョブ定義の詳細を返します。それ以外の場合、コマンドはアプリケーションの一部であるすべてのジョブ定義のリストを表示します。

operationがCREATEに設定された場合、コマンドは新しく作成されたジョブ定義のMetadataObjectIDを返します。

operationがDELETE、CUSTOMIZEまたはUPDATEに設定された場合、コマンドは操作の成功または失敗に応じて0または-1を返します。

4.2.7.2 構文

manageSchedulerJobDefn(operation,appName,[jobName],[jobType], [desc],[props])

引数

定義

operation

ジョブで次の操作のどれを実行するかを指定します。

- SHOW (S)
特定のアプリケーションの一部であるジョブ定義のリストを表示します。ジョブ名が指定された場合、そのジョブ定義のみの詳細を表示します。

この操作が使用された場合、appName引数が必要となり、jobNameがオプションになります。

- CREATE (N)
MDS内の(パラメータとして指定された)関連するアプリケーションのネームスペースに新しいジョブ定義を作成します。

この操作が使用される場合、appName、jobNameおよびjobType引数が必要となり、descおよびpropsがオプションとなります。

- DELETE (D)
指定されたジョブ定義をMDSから削除します。

この操作が使用される場合、appNameおよびjobName引数が必要になります。

- CUSTOMIZE (C)
既存のジョブ定義のカスタマイズ可能なプロパティを変更します。使用可能なカスタマイズ可能なプロパティは次のとおりです。SYS_retries、SYS_priority、SYS_requestCategory、SYS_request_timeout、enableTrace、enableTimeStatistics。

この操作が使用される場合、appName、jobNameおよびprops引数が必要になります。

- UPDATE (U)
既存のジョブ定義を指定されたプロパティ値で更新します(オーバーライドされない場合は既存のパラメータを保持します)。

この操作が使用される場合、appName、jobName、およびdescとpropsのいずれかまたは両方の引数が必要になります。

appName

ジョブのホスティング・アプリケーションの論理名を指定します。

jobName

オプション。ジョブ定義の名前を指定します。作成、削除または更新の操作では、デフォルト・パッケージ/oracle/apps/ess/custom/が指定された名前の前に付加されます。

jobType

オプション。新しいジョブ定義の作成に使用されるジョブ・タイプの名前を指定します。名前にパッケージが含まれない場合、デフォルト値/oracle/as/ess/core/の接頭辞が名前に付加されます。

desc

オプション。新しいジョブ定義の説明を指定します。

props

オプション。ディクショナリとして指定された他のリクエスト・パラメータまたはプロパティを指定します。

注意:

- ジョブ定義の作成、削除および更新では、jobName引数の値を(パッケージ名を含む)完全修飾名とすることができますが、デフォルト・パッケージ/oracle/apps/ess/customが常に接頭辞として付加されます。

- 前の注意で示されているように、/oracle/apps/ess/customネームスペースにあるジョブ定義のみを作成、削除、または更新でき、事前パッケージ済ジョブ定義は変更できません。

- jobType引数に完全修飾パス名を指定しない場合、デフォルト・パッケージ(/oracle/as/ess/core/)の接頭辞が名前に付加されます。

4.2.7.3 例

これらの例では次の変数が使用されています。

変数

値

HOSTING_APP

EssNativeHostingApp

JOB_DEF_PREDEF

/oracle/apps/ess/TestJob

JOB_DEF_NAME

TestJob_wlst

JOB_TYPE_NAME

JavaJobType

JOB_DESC

My WLST Test Defn

PARAMS

'SYS_retries':1,'myParam':'xyz'

- HOSTING_APPのネームスペースにあるすべてのジョブ定義の表示

manageSchedulerJobDefn('SHOW',HOSTING_APP)

- HOSTING_APPのジョブ定義(JOB_DEF_PREDEF)部分の詳細表示

manageSchedulerJobDefn('SHOW',HOSTING_APP,jobName=JOB_DEF_PREDEF)

- 新しいジョブ定義/oracle/apps/ess/custom/TestJob_wlstをHOSTING_APPのネームスペースに/oracle/as/ess/core/JavaJobTypeのjobType値で作成

manageSchedulerJobDefn('CREATE',HOSTING_APP,jobName=JOB_DEF_NAME, jobType=JOB_TYPE_NAME)

- /oracle/apps/ess/custom/TestJob_wlstという名前の新しいジョブ定義をHOSTING_APPネームスペースにjobType /oracle/as/ess/core/JavaJobTypeおよびJOB_DESCの値の説明とともに作成

manageSchedulerJobDefn('CREATE',HOSTING_APP,jobName=JOB_DEF_NAME,jobType=JOB_TYPE_NAME,desc=JOB_DESC)

- /oracle/apps/ess/custom/TestJob_wlstという名前の新しいジョブ定義をHOSTING_APPネームスペースにjobType /oracle/as/ess/core/JavaJobTypeで、JOB_DESCおよびPARAMSで定義された説明およびパラメータとともに作成

manageSchedulerJobDefn('CREATE',HOSTING_APP,jobName=JOB_DEF_NAME,jobType=JOB_TYPE_NAME,desc=JOB_DESC,props=PARAMS)

- ジョブ定義/oracle/apps/ess/custom/JOB_DEF_NAMEを新しい説明JOB_DESCで更新

manageSchedulerJobDefn('UPDATE',HOSTING_APP,jobName=JOB_DEF_NAME,desc=JOB_DESC)

- ジョブ定義/oracle/apps/ess/custom/JOB_DEF_NAMEをプロパティPARAMSで更新

manageSchedulerJobDefn('UPDATE',HOSTING_APP,jobName=JOB_DEF_NAME,props=PARAMS)

- HOSTING_APPのジョブ定義/oracle/apps/ess/custom/JOB_DEF_NAMEを削除

manageSchedulerJobDefn('DELETE',HOSTING_APP,jobName=JOB_DEF_NAME)

- HOSTING_APPの事前パッケージ済ジョブ定義JOB_DEF_PREDEFをカスタマイズ可能なプロパティSYS_retriesおよびSYS_priorityを使用してカスタマイズ

manageSchedulerJobDefn('CUSTOMIZE',HOSTING_APP,jobName=JOB_DEF_PREDEF,props={'SYS_retries':2,'SYS_priority':3})

4.2.7.4 関連シェル・スクリプト

essManageJobDefn

4.2.8 「Oracle Enterprise Schedulerのスケジュール定義の管理」

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.2.8.1 説明

Oracle Enterprise Schedulerのスケジュール定義を管理(表示、作成、削除、カスタマイズ、更新)します。

operationがSHOWに設定された場合およびschNameが指定された場合、コマンドはこの特定のスケジュール定義の詳細を表示します。それ以外の場合、コマンドはアプリケーションの一部であるすべてのスケジュール定義のリストを表示します。コマンドは、操作が成功したか失敗したかに応じて0または-1を返します。

operationがCREATEに設定された場合、コマンドは新しく作成されたスケジュール定義のMetadataObjectIDを返します。

operationがDELETEまたはUPDATEに設定された場合、コマンドは操作が成功したか失敗したかに応じて0または-1を返します。

4.2.8.2 構文

manageSchedulerSchedule(operation,appName,[schName],[schDesc], [begin_time],[frequency],[interval],[count],[end_time],[month], [week],[day],[date])

引数

定義

operation

ジョブで次の操作のどれを実行するかを指定します。

- SHOW (S)
特定のアプリケーションの一部であるスケジュール定義のリストを表示します。

この操作が使用された場合、appName引数が必要となり、schNameがオプションになります。

- CREATE (C)
MDS内の(パラメータとして指定された)関連するアプリケーションのネームスペースに新しいスケジュール定義を作成します。

このオプションが使用される場合、appName、schNameおよびfrequency引数が必要となり、schDescがオプションとなります。

- DELETE (D)
指定されたジョブ定義をMDSから削除します。

この操作が使用される場合、appNameおよびschName引数が必要になります。

- UPDATE (U)
既存のスケジュール定義を指定されたプロパティ値で更新します(オーバーライドされない場合は既存のパラメータを保持します)。

この操作が使用される場合、appName、schName、およびschDescとfrequencyのいずれかまたは両方の引数が必要になります。

appName

ジョブのホスティング・アプリケーションの論理名を指定します。

schName

オプション。スケジュール定義の名前を指定します。作成、削除および更新の操作では、/oracle/apps/ess/custom/という名前のデフォルト・パッケージが、指定された名前の前に付加されます。

schDesc

オプション。定義の作成または更新時にスケジュール定義の説明を指定します。

begin_time

オプション。繰返しイベントの開始時間を指定します。形式は、HH:MM:SS:DD:MM:YYYYです。

frequency

オプション。繰返しの頻度。有効な値は、SECOND、MINUTE、HOUR、DAY、WEEK、MONTH、YEARです。

オプションSECOND、MINUTE、HOUR、DAY、WEEKのいずれかを使用する場合、引数interval、begin_time、[count | end_time]を使用する必要があります。

MONTHオプションを使用した場合、引数[(week day) | date] [begin_time ] [count | end_time]を使用する必要があります。

YEARオプションを使用した場合、引数[month ({week day} | date)] [begin_time] [count | end_time]を使用する必要があります。

interval

オプション。frequencyオプションで使用する繰返し間隔を指定します。これは整数値で、デフォルト値は1です。

count

オプション。リクエストの繰返しの最大数を指定します。この値は、整数になります。

end_time

オプション。繰返しの終了時間を指定します。形式: HH:MM:SS:DD:MM:YYYY

month

オプション。frequencyがYEARに設定された場合、何月かを指定します。有効な値は1-12です。

week

オプション。ある月の週を指定します。有効な値は1-6およびLASTです。

day

オプション。曜日を指定します。有効な値は1-7で、1は月曜日を表します。

date

オプション。月の日にちを指定します。有効な値は1-31およびLASTです。

4.2.8.3 例

これらの例では次の変数が使用されています。

変数

値

HOSTING_APP

EssNativeHostingApp

PREDEF_SCHEDULE

/oracle/apps/ess/demo/seeded/MyPredefinedSch

SCHEDULE_NAME

MyWlstSchedule

SCH_DESC

Description for WLST test schedule

- HOSTING_APPのネームスペースにあるすべてのスケジュール定義の表示

manageSchedulerSchedule('SHOW',HOSTING_APP)

- HOSTING_APPのスケジュール定義PREDEF_SCHEDULEの詳細表示

manageSchedulerSchedule('SHOW',HOSTING_APP,schName=PREDEF_SCHEDULE)

- /oracle/apps/ess/custom/MyWlstScheduleという名前の新しい繰返しスケジュール定義をHOSTING_APPのネームスペースに説明SCH_DESCとともに作成。繰返しスケジュールは次のとおり。

- 2分ごとに実行

- 2012年5月3日の21:10:30に開始

- 3回の反復で完了

manageSchedulerSchedule('CREATE',HOSTING_APP,schName=SCHEDULE_NAME, schDesc=SCH_DESC,frequency='MINUTE',interval=2,count=3, begin_time='21:10:30:03:05:12')

- /oracle/apps/ess/custom/MyWlstScheduleという名前の新しい繰返しスケジュール定義をHOSTING_APPのネームスペースに作成。繰返しスケジュールは次のとおり。

- 2か月ごとに5週目(該当する場合)の木曜日に実行

- 2012年5月3日の21:10:30に開始

- 2013年5月4日の21:10:30まで継続

manageSchedulerSchedule('CREATE',HOSTING_APP,schName=SCHEDULE_NAME, frequency='MONTH',interval=2, begin_time='21:10:30:03:05:12', week=5, day=4, end_time='21:10:30:04:05:13')

- /oracle/apps/ess/custom/MyWlstScheduleという名前の新しい繰返しスケジュール定義をHOSTING_APPのネームスペースに作成。繰返しスケジュールは次のとおり。

- 3年ごとに5月の最終日(5月31日)に実行

- 2012年5月3日の21:10:30に開始

- 5回の反復で完了

manageSchedulerSchedule('CREATE',HOSTING_APP,schName=SCHEDULE_NAME, frequency='YEAR',interval=3,begin_time='21:10:30:03:05:12',month=5,date='LAST',count=5)

- /oracle/apps/ess/custom/MyWlstScheduleという名前の新しい繰返しスケジュール定義をHOSTING_APPのネームスペースに作成。この繰返しスケジュールは、今から始めて、1時間ごとに実行します。

manageSchedulerSchedule('CREATE',HOSTING_APP,schName=SCHEDULE_NAME, frequency='HOUR')

- /oracle/apps/ess/custom/SCHEDULE_NAMEという名前のスケジュール定義を説明SCH_DESCで更新します。繰返しスケジュールは変更されません。

manageSchedulerSchedule('UPDATE',HOSTING_APP,schName=SCHEDULE_NAME,schDesc=SCH_DESC)

- /oracle/apps/ess/custom/SCHEDULE_NAMEという名前のスケジュール定義を次の新しい繰返しスケジュールで更新します。1分ごとに実行されます。

manageSchedulerSchedule('UPDATE',HOSTING_APP,schName=SCHEDULE_NAME, frequency='MINUTE')

- /oracle/apps/ess/custom/SCHEDULE_NAMEという名前のHOSTING_APPスケジュール定義を削除。

manageSchedulerSchedule('DELETE',HOSTING_APP,schName=SCHEDULE_NAME)

4.2.8.4 関連シェル・スクリプト

essManageSchedule

4.3 Oracle Enterprise Schedulerのバッチ削除リクエスト

ジョブ・リクエスト・データは、Oracle Enterprise Schedulerランタイム・ストアの表にレコードとして保存されます。これらのジョブ・リクエスト・レコードは、データベース管理者がSQLパージ・スクリプトを使用してデータベースから物理的にパージするまで、ランタイム・ストアから削除されません。リクエストは、物理的にパージする前に、論理的に削除する必要があります。Oracle Enterprise Schedulerでは、リクエストを削除するには、ユーザーが特定のリクエストに対して削除操作を行う方法と、Oracle Enterprise Schedulerの管理者がバッチ削除リクエストを発行する方法の2つの方法があります。

バッチ削除機能では、Oracle Enterprise Schedulerの管理者はリクエストを一括で削除できます。Oracle Enterprise Schedulerの管理者は削除基準のセットを定義し、Oracle Enterprise SchedulerランタイムMBeanインタフェースを使用してバッチ削除リクエストを発行します。バッチ・ジョブの削除基準は、アプリケーション・リクエスト・パラメータの形式で指定されます。発行されたバッチ削除リクエストは、Oracle Enterprise Schedulerによって提供されるJava実行可能ファイル用の事前定義済ジョブ定義を使用します。バッチ削除ジョブ定義メタデータは、ESSAPPメタデータ・リポジトリで定義されます。

バッチ削除ジョブの実行時、ジョブは完了した絶対的な親とインスタンス親のどちらのリクエストがそのバッチ削除リクエストに対して指定された削除基準を満たしているかを判断し、それらのリクエストに対するリクエスト階層を削除します。バッチ削除ジョブは、ESSAPPのコンテキストで実行されます。

4.3.1 batchDeleteSchedulerRequestコマンド

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.3.1.1 説明

バッチ削除ジョブのリクエストを発行します。(MDS内の)事前定義済のスケジュールを使用するか、ワンタイム実行時間を指定できます。これらのどちらも指定されない場合、リクエストはただちに開始されます。リクエスト・パラメータは削除基準の指定に使用します。

バッチ削除ジョブの実行時、ジョブは完了した絶対的な親とインスタンス親のどちらのリクエストがそのバッチ削除リクエストに対して指定された削除基準を満たしているかを判断します。バッチ削除ジョブは、それらのリクエストに対するリクエスト階層を削除します。

4.3.1.2 構文

batchDeleteSchedulerRequests([desc],[schId],[start],[end], [params])

引数

定義

desc

オプション。バッチ削除リクエストの説明を指定します。

schId

オプション。使用する(事前定義済の)スケジュールの完全修飾名を指定します。何も指定されない場合、デフォルト・パッケージは/oracle/as/ess/essapp/custom/です。

start

オプション。リクエストを開始する時間を指定します。形式: HH:MM:SS:DD:MM:YYYY

end

オプション。リクエストを終了する時間。形式: HH:MM:SS:DD:MM:YYYY

params

オプション。ディクショナリとして指定されたリクエスト・パラメータ。パラメータの詳細は「バッチ削除パラメータ」で説明しています。

4.3.1.2.1 バッチ削除パラメータ

バッチ削除ジョブは、アプリケーション・リクエスト・パラメータを使用してバッチ削除基準およびその削除ジョブの基本結果情報を指定します。クラスoracle.as.scheduler.job.BatchDeleteProperty.javaは、バッチ削除パラメータの定数を定義します。削除基準パラメータは、次の2つの表で説明します。

パラメータ

データ型

定数

CriteriaApplication

String

BatchDeleteProperty.CRITERIA_APPLICATION

CriteriaProduct

String

BatchDeleteProperty.CRITERIA_PRODUCT

CriteriaJobDefn

String

BatchDeleteProperty.CRITERIA_JOBDEFN

CriteriaJobExecType

String

BatchDeleteProperty.CRITERIA_JOBEXECTYPE

CriteriaSubmitUser

String

BatchDeleteProperty.CRITERIA_SUBMIT_USER

CriteriaMinimumAge

Integer

BatchDeleteProperty.CRITERIA_MINIMUM_AGE

CriteriaRetentionAgeSuccess

Integer

BatchDeleteProperty.CRITERIA_RETENTION_AGE_SUCCESS

CriteriaRetentionAgeError

Integer

BatchDeleteProperty.CRITERIA_RETENTION_AGE_ERROR

CriteriaProcessLimit

Integer

BatchDeleteProperty.CRITERIA_RETENTION_AGE_WARNING

CriteriaRetentionAgeCancel

Integer

BatchDeleteProperty.CRITERIA_RETENTION_AGE_CANCEL

CriteriaProcessLimit

Long

BatchDeleteProperty.CRITERIA_PROCESS_LIMIT

パラメータ

デフォルト値

説明

CriteriaApplication

null(なし)

リクエストが削除されるアプリケーションを指定します。NULLの場合、このパラメータは無視され、削除基準の一部として使用されません。

CriteriaProduct

null(なし)

リクエストが削除される製品を指定します。NULLの場合、このパラメータは無視され、削除基準の一部として使用されません。

CriteriaJobDefn

null(なし)

リクエストが削除されるジョブ定義MetadataObjectIdの文字列表現を指定します。NULLの場合、このパラメータは無視され、削除基準の一部として使用されません。

CriteriaJobExecType

null(なし)

リクエストが削除されるジョブ実行タイプの文字列表現を指定します。NULLの場合、このパラメータは無視され、削除基準の一部として使用されません。

CriteriaSubmitUser

null(なし)

リクエストが削除される発行ユーザーを指定します。NULLの場合、このパラメータは無視され、削除基準の一部として使用されません。

CriteriaMinimumAge

null(なし)

完了したリクエストが削除できるようになるまでの最小日数を指定します。

CriteriaRetentionAgeSuccess

null(なし)

正常に完了したリクエストが削除できるようになるまでの最小日数を指定します。このパラメータ値がNULLの場合、CriteriaMinimumAgeの値が使用されます。

CriteriaRetentionAgeError

null(なし)

失敗で完了したリクエストが削除できるようになるまでの最小日数を指定します。このパラメータ値がNULLの場合、CriteriaMinimumAgeの値が使用されます。

CriteriaProcessLimit

null(なし)

警告が出て完了したリクエストが削除できるようになるまでの最小日数を指定します。このパラメータ値がNULLの場合、CriteriaMinimumAgeの値が使用されます。

CriteriaRetentionAgeCancel

null(なし)

取り消されたリクエストが削除できるようになるまでの最小日数を指定します。このパラメータ値がNULLの場合、CriteriaMinimumAgeの値が使用されます。

CriteriaProcessLimit

null(なし)

バッチ削除ジョブにより処理されるリクエストの最大数を指定します。NULLまたはゼロ(0)の場合、制限はありません。デフォルト値は0(ゼロ)です。

4.3.1.3 例

- すべてのパージ可能リクエストの削除

batchDeleteSchedulerRequests()

- アプリケーションESS_NATIVE_HOSTING_APP_LOGICAL_NAMEのすべてのパージ可能リクエストの削除

batchDeleteSchedulerRequests(desc='My purge for ESS NativeApp',params={'CriteriaApplication':'ESS_NATIVE_HOSTING_APP_LOGICAL_NAME'})

- ジョブ定義が/oracle/apps/ess/custom/MyDefのアプリケーションESS_NATIVE_HOSTING_APP_LOGICAL_NAMEのすべてのパージ可能リクエストの削除

batchDeleteSchedulerRequests(desc='My purge for ESS NativeApp',params={'CriteriaApplication':'ESS_NATIVE_HOSTING_APP_LOGICAL_NAME','CriteriaJobDefn':'JobDefinition://oracle/apps/ess/custom/MyDef'})

- ジョブ・タイプがJAVA_TYPEのアプリケーションESS_NATIVE_HOSTING_APP_LOGICAL_NAMEのすべてのパージ可能リクエストの削除

batchDeleteSchedulerRequests(desc='My purge for ESS NativeApp', params={'CriteriaApplication':'ESS_NATIVE_HOSTING_APP_LOGICAL_NAME', 'CriteriaJobExecType':'JAVA_TYPE'})

- スケジュール/oracle/as/ess/essapp/custom/WeeklySchを使用したバッチ削除ジョブ・リクエストの発行

batchDeleteSchedulerRequests(desc='Purge using WeekSch',schId='/oracle/as/ess/essapp/custom/WeeklySch')

4.3.1.4 関連シェル・スクリプト

essBatchDeleteRequests

4.4 作業割当てコマンド

表4-2に、Oracle Enterprise Schedulerで作業割当て用に用意されているWLSTコマンドを示します。

表4-2 Oracle Enterprise Schedulerの作業割当てコマンド

コマンド

説明

addProcessorBinding

作業割当てのバインド

createWorkshift

カスタム稼働シフトの作成

deleteWorkAssignment

作業割当てメタデータの削除

deleteWorkshift

稼働シフト・メタデータの削除

queryProcessorBindings

すべてのプロセッサ・バインドの問合せ

queryWorkAssignments

作業割当てメタデータの問合せ

queryWorkSchedules

作業割当てのスケジュール・メタデータの問合せ

queryWorkshifts

稼働シフト・メタデータの問合せ

removeProcessorBinding

プロセッサ・バインドの削除

updateWorkshift

稼働シフト・リソースの更新

4.4.1 addProcessorBinding

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.1.1 説明

作業割当てを現在のOracle Enterprise Schedulerプロセッサにバインドします。

4.4.1.2 構文

addProcessorBinding(workAssignmentName,server=serverName, [isExclusive=None][scope])

引数

定義

workAssignmentName

バインドする作業割当ての名前を指定します。

server

バインドするサーバーの名前を指定します。

isExclusive

オプション。バインディングが排他的(true)であるかどうかを指定します。デフォルト値はfalseです。

scope

オプション。server、groupまたはglobalが可能です。デフォルト値はserverです。

- serverは指定されたサーバーにバインドします。

- groupは指定されたサーバーの処理グループにバインドします。

- globalは分離グループ内のすべての現在および今後のサーバーにグローバルにバインドします。

4.4.1.3 例

- 作業割当てをプロセッサにバインド

addProcessorBinding('mypkg/MyTestWA', server='ess_server1')

- 作業割当てを排他モードでプロセッサにバインド

addProcessorBinding('SimpleApp', server='ess_server1', isExclusive='true')

- 作業割当てをグローバルにプロセッサにバインド

addProcessorBinding('SimpleApp',server='ess_server1',scope='global')

4.4.2 createWorkshift

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.2.1 説明

時間枠とその枠の間に使用されるリソースを指定するカスタム稼働シフトを作成します。

4.4.2.2 構文

createWorkshift(workshiftName,alloc=allocation, plsqlLimit=limit,asyncJavaLimit=limit,[description=None], [schedName=None],[duration=None])

引数

定義

workshiftName

作成する稼働シフトの名前を指定します。

alloc

各サーバー・インスタンスに割り当てることができるスレッドの最大数を指定します。

plsqlLimit

分離グループ内でアクティブにできるPL/SQLジョブの最大数を指定します。無制限を指定するには-1を使用します。

asyncJavaLimit

分離グループ内でアクティブにできる非同期Javaジョブ数を指定します。無制限を指定するには-1を使用します。

description

オプション。稼働シフトの説明を指定します。

schedName

オプション。稼働シフトに使用するスケジュールの名前を指定します。

- スケジュール名が指定された場合、duration引数が必要です。

- スケジュール名が指定されない場合、稼働シフトは24x7です。

duration

スケジュールを実行するたびに稼働シフトがアクティブになる時間(分)を指定します。schedName引数が使用される場合に必要です。

4.4.2.3 例

- 特定のカスタム・パッケージにおいての24x7稼働シフトの作成

createWorkshift('mypkg/SampleWorkshift', alloc=5, plsqlLimit=15, asyncJavaLimit=10)

4.4.3 deleteWorkAssignment

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.3.1 説明

カスタム・ネームスペース内のOracle Enterprise Schedulerの作業割当てを削除します。

注意:

バインドされた作業割当ては削除できません。

4.4.3.2 構文

deleteWorkAssignment(workAssignmentName)

引数

定義

workAssignmentName

削除するカスタム作業割当ての名前を指定します。

4.4.3.3 例

- カスタム作業割当ての削除

deleteWorkAssignment('MyTestWA')

4.4.4 deleteWorkshift

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.4.1 説明

カスタム・ネームスペース内のOracle Enterprise Schedulerの稼働シフトを削除します。

注意:

オンボード・テナントに使用されている稼働シフトまたはバインドされた作業割当ては削除できません。

4.4.4.2 構文

deleteWorkshift(workshiftName)

引数

定義

workshiftName

削除するカスタム稼働シフトの名前を指定します。

4.4.4.3 例

- カスタム稼働シフトの削除

deleteWorkshift('mypkg/TenantWorkshift1')

4.4.5 queryProcessorBindings

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.5.1 説明

プロセッサ・バインドを取得します。

4.4.5.2 構文

queryProcessorBindings(server=serverName)

引数

定義

server

問合せするサーバーの名前を指定します。

4.4.5.3 例

- すべてのバインドの取得

queryProcessorBindings(server='ess_server1')

4.4.6 queryWorkAssignments

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.6.1 説明

すべてのカスタムおよび内部作業割当てを取得します。作業割当てIDを出力します。詳細には、稼働シフトIDおよび特殊化が含まれます。

4.4.6.2 構文

queryWorkAssignments([name=None],[package=None],[options=None])

引数

定義

name

オプション。作業割当て名を指定します。

package

オプション。作業割当てパッケージを指定します。

options

オプション。次の1つ以上のオプションのカンマ区切りのリスト

- nameLike
指定された名前を含む名前の問合せ。

- pkgLike
指定されたパッケージを含むパッケージの問合せ。

- details
追加の詳細を出力。

4.4.6.3 例

- すべての作業割当ての出力

queryWorkAssignments()

- 名前に「Simple」が含まれる作業割当ての詳細の出力

queryWorkAssignments(name='Simple', options='nameLike,details')

4.4.7 queryWorkSchedules

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.7.1 説明

作業割当てのすべてのスケジュールを取得し、スケジュールIDを出力します。詳細には、繰返し、除外、包含が含まれます。

4.4.7.2 構文

queryWorkSchedules([name=None],[package=None],[options=None])

引数

定義

name

オプション。スケジュール名を指定します。

package

オプション。パッケージ名を指定します。

options

オプション。次の1つ以上のオプションのカンマ区切りのリスト

- nameLike
指定された名前を含む名前の問合せ。

- pkgLike
指定されたパッケージを含むパッケージの問合せ。

- details
追加の詳細を出力。

4.4.7.3 例

- すべてのスケジュールの取得

queryWorkSchedules()

- 毎時スケジュールの詳細の取得

queryWorkSchedules(name='Hourly', options='details')

4.4.8 queryWorkshifts

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.8.1 説明

すべての稼働シフトを取得し、稼働シフトIDを出力します。詳細には、スレッド割当ておよび非同期制限が含まれます。

4.4.8.2 構文

queryWorkshifts([name=None], [package=None], [options=None])

引数

定義

name

オプション。稼働シフト名を指定します。

package

オプション。稼働シフト・パッケージを指定します。

options

オプション。次の1つ以上のオプションのカンマ区切りのリスト

- nameLike
指定された名前を含む名前の問合せ。

- pkgLike
指定されたパッケージを含むパッケージの問合せ。

- details
追加の詳細を出力。

4.4.8.3 例

- すべての稼働シフトの取得

queryWorkshifts()

- パッケージに「test」が含まれる稼働シフトを取得し、その詳細を出力

queryWorkshifts(package='test', options='pkgLike,details')

4.4.9 removeProcessorBinding

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.9.1 説明

ローカルまたはグローバルのプロセッサ・バインドを削除します。

4.4.9.2 構文

removeProcessorBinding(workAssignmentName, server=serverName)

引数

定義

workAssignmentName

バインド解除する作業割当ての名前を指定します。

server

バインド解除するサーバーの名前を指定します。

4.4.9.3 例

- バインドの削除

removeProcessorBinding('mypkg/MyTestWA', server='ess_server1')

4.4.10 updateWorkshift

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オンライン

4.4.10.1 説明

カスタム稼働シフトの非同期制限およびスレッド割当てを更新します。

4.4.10.2 構文

updateWorkshift(workshiftName,[alloc=None],[plsqlLimit=None], [asyncJavaLimit=None])

引数

定義

workshiftName

更新する稼働シフト名を指定します。

alloc

オプション。最大のローカル・スレッド割当てを指定します。

plsqlLimit

オプション。分離グループ内でアクティブにできるPL/SQLジョブの最大数を指定します。無制限を指定するには-1を使用します。

asyncJavaLimit

オプション。分離グループ内でアクティブにできる非同期Javaジョブの最大数を指定します。無制限を指定するには-1を使用します。

注意:

オプションの引数を1つ以上指定する必要があります。

4.4.10.3 例

- 稼働シフトmypkg/SampleWorkshiftのPL/SQL制限を更新します。

updateWorkshift('mypkg/SampleWorkshift', plsqlLimit=20)

- 稼働シフトmypkg/SampleWorkshiftの両方の非同期制限を更新します。

updateWorkshift('mypkg/SampleWorkshift', plsqlLimit=25, asyncJavaLimit=50)

4.5 Oracle Enterprise Schedulerの診断ダンプ

Oracle Enterprise Schedulerには、問題の診断を容易にする診断ダンプのセットがあります。これらのダンプはOracle Diagnostics Framework上に構築されます。Oracle Enterprise Schedulerの問題は、通常、リクエストが開始されない場合または想定どおりに完了しない場合に明らかになります。そのようなシナリオにおいて、ユーザーはOracle Enterprise Schedulerの診断ダンプを手動で作成し、そのダンプの情報を使用して問題の診断に役立てることができます。すべてのOracle Enterprise Scheduler診断ダンプを簡単に作成する1つの方法としては、WLSTXXXを使用したXXX Oracle Enterprise Schedulerのインシデントの作成の説明に示すとおり、特定のメッセージIDを持つインシデントを作成する方法があります。

Oracle Enterprise Schedulerの診断ダンプ関連のコマンドは次のとおりです。これらは、「ダンプ・コマンド」で説明されています。

- executeDump

- listDumps

- describeDump

ダンプの動作は、コマンドに対してダンプ名を引数として指定して制御します。有効なダンプ名は、表4-3に示され、使用例は「ダンプ例」に記載されています。

表4-3 Oracle Enterprise Schedulerの診断ダンプ

ダンプ名

説明

ess.applications

分離グループ内の各サーバー上のすべての登録されたOracle Enterprise Schedulerアプリケーションをダンプします。複数のサーバーで登録されたアプリケーションは、このダンプに複数回出現します。

特定のサーバー上のアプリケーションについては、どのバージョンが登録されているか、アプリケーションがアクティブかどうか、および最後にアクティブ化されたのはいつかをチェックできます。

ess.bindings

バインド・モードを含む、このインスタンスへの現在のおよび非アクティブのプロセッサ・バインドをダンプします。完了した非アクティブのバインドには期限切れスケジュールがあり、再度アクティブにできません。完了していない非アクティブのバインドについては、ダンプでは次にアクティブになる稼働シフトとそれがいつアクティブになるかが示されます。このダンプではすべての完了したバインドが示されます。

ess.processor

このインスタンスの現在のプロセッサ情報をダンプします。

プロセッサの状態とアクティブのスレッド数、および有効化されデプロイされたアプリケーションのリストをダンプします。アクティブのスレッド数は、非アクティブ化されたリソースを含むすべてのリソースにわたって使用されているスレッド数です。作業割当ての詳細は、ダンプess.workallocを参照してください。

アプリケーションがリクエストを処理していない場合、プロセッサが実行中であり、アプリケーションがサーバーにデプロイされて有効になっていることを確認してください。

ess.requests

非ターミナル状態の処理グループ内のすべてのリクエストについての詳細情報をダンプします。コアおよび拡張システムのプロパティおよびCPパラメータを含みます。

ess.servers

分離グループ内のすべてのアクティブのサーバーについての、最後のチェックインなどのサーバー情報をダンプします。各サーバーは一定の間隔(デフォルトは1分)でチェックインする必要があります。

1分を過ぎてもサーバーがチェックインしていない場合、問題があることが考えられます。サーバーがしばらくの期間チェックインしなかった場合、Oracle Enterprise Schedulerは、サーバーがダウンし、そのサーバー上で処理されていたリクエストがフェイルオーバーしたとみなすことがあります。

ess.workalloc

最大リソースおよび現在の割当てを含む作業割当てについての詳細情報をダンプします。whereClauseは、作業割当ての効果的な特殊化を示し、これは排他モードでバインドされた作業割当てに相当します。

このダンプではすべての完了したバインドを示さない場合があります。バインドが完了したかどうかを確認するには、ess.bindingsを使用してください。

バインドがない場合、ダンプにはデフォルトの作業割当てについての情報が示されます。

ess.workunits

このプロセス・グループのすべての作業ユニットをダンプします。

4.5.1 ダンプ・コマンド

次の例では、WLSTを起動し、サーバーに接続する方法を示します。

$MW_HOME/oracle_common/common/bin/wlst.sh
...
Initializing WebLogic Scripting Tool (WLST) ...

Welcome to WebLogic Server Administration Scripting Shell

Type help() for help on available commands

wls:/offline> connect('weblogic','welcome1','localhost:7001')
Connecting to t3://localhost:7001 with userid weblogic ...
Successfully connected to Admin Server 'AdminServer' that belongs to domain 'base_domain'.

Warning: An insecure protocol was used to connect to the
server. To ensure on-the-wire security, the SSL port or
Admin port should be used instead.

wls:/base_domain/serverConfig>

注意:

管理サーバーまたは管理対象サーバーに接続できます。ただし、管理サーバーに接続する場合、各ダンプ・コマンドで使用する管理対象サーバーを指定する必要があります。例:

executeDump(name="ess.applications", appName="ESSAPP",server='ess_server1')

WLSTが起動され、サーバーに接続されると、次の項で説明するexecuteDump、listDumps、describeDumpコマンドを使用できるようになります。

4.5.1.1 executeDump

executeDumpコマンドは、ダンプ名およびアプリケーション名に基づいて診断ダンプを作成します。

4.5.1.1.1 構文

executeDump(name="dump_name",appName="app_name", [server="server_name"])

引数

定義

name

表4-3に示されたダンプ名。

appName

アプリケーションの名前。

server

オプション。管理サーバーまたは管理対象サーバーに接続できます。管理サーバーに接続する場合、server引数を使用して各ダンプ・コマンドで使用する管理対象サーバー名を指定する必要があります。

4.5.1.2 listDumps

listDumpsコマンドは指定されたアプリケーションで使用可能なダンプを一覧表示します。

4.5.1.2.1 構文

listDumps(appName="app_name")

引数

定義

appName

アプリケーションの名前。

4.5.1.3 describeDump

特定のダンプ・タイプのヘルプを一覧表示します。

4.5.1.3.1 構文

describeDump(name="dump_name")

引数

定義

name

表4-3に示されたダンプ名。

4.5.2 ダンプ例

次の例では、表4-3に一覧表示された診断ダンプの使用方法を示します。

- 分離グループ内の各サーバー上のすべての登録されたアプリケーションをダンプします。2台以上のサーバーで登録されたアプリケーションは、このダンプに複数回出現します。特定のサーバー上のアプリケーションについては、どのバージョンが登録されているか、アプリケーションがアクティブかどうか、および最後にアクティブ化されたのはいつかをチェックできます。
executeDump(name="ess.applications",appName="ESSAPP")

- バインド・モードを含む、このインスタンスに対するプロセッサ・バインドをダンプします。完了した非アクティブのバインドには期限切れスケジュールがあり、再度アクティブにできません。完了していない非アクティブのバインドについては、ダンプでは次にアクティブになる稼働シフトと、それがいつアクティブになるかが示されます。このダンプではすべての完了したバインドが示されます。
executeDump(name="ess.bindings",appName="ESSAPP")

- プロセッサの状態とアクティブのスレッド数、および有効化されデプロイされたアプリケーションのリストをダンプします。アクティブのスレッド数は、非アクティブ化されたリソースを含むすべてのリソースにわたって使用されているスレッド数です。作業割当ての詳細は、表4-3のess.workallocの項目を参照してください。
アプリケーションがリクエストを処理していない場合、プロセッサが実行中であり、アプリケーションがサーバーにデプロイされて有効になっていることを確認してください。

executeDump(name="ess.processor",appName="ESSAPP")

- 非ターミナル状態の処理グループ内のすべてのリクエストについての詳細情報をダンプします。コアおよび拡張システムのプロパティおよびCPパラメータを含みます。
executeDump(name="ess.requests",appName="ESSAPP")

- 分離グループ内のすべてのアクティブのサーバーをダンプします。各サーバーは一定の間隔(デフォルトは1分)でチェックインする必要があります。1分を過ぎてもサーバーがチェックインしない場合、問題があることが考えられます。サーバーがしばらくの期間チェックインしなかった場合、ESSは、サーバーがダウンし、そのサーバー上で処理されていたリクエストがフェイルオーバーしたとみなすことがあります。
executeDump(name="ess.servers",appName="ESSAPP")

- 最大リソースおよび現在の割当てを含む作業割当てについての詳細情報をダンプします。whereClause情報は、作業割当ての効果的な特殊化を示し、これは排他モードでバインドされた作業割当てに相当します。
このダンプではすべての完了したバインドを示さない場合があります。バインドが完了したかどうかを確認するには、ess.bindingsダンプを使用します。バインドがない場合、ダンプにはデフォルトの作業割当てについての情報が示されます。

executeDump(name="ess.workalloc",appName="ESSAPP")

- プロセス・グループ内のすべての作業ユニットをダンプします。
executeDump(name="ess.workunits",appName="ESSAPP")

4.5.3 Oracle Enterprise Schedulerのインシデントの作成

Oracle Enterprise Schedulerには、メッセージIDESS-99999を使用して、すべてのOracle Enterprise Scheduler診断ダンプでインシデントを作成する便利な方法があります。次に例を示します。

createIncident(messageId="ESS-99999",appName="ESSAPP", description="ESS incident with all dumps")

インシデント・ファイルはADRHomeディレクトリに配置され、listADRHOmes()コマンドを使用してそれらを一覧表示できます。

Oracle Enterprise Schedulerは次のパスを使用します。

ADRBase = ${MW_HOME}/user_projects/domains/base_domain/servers/SERVER/adr

ADRHome = ${ADRBase}/diag/ofm/base_domain/SERVER

4.6 「Oracle Enterprise Schedulerの便利なスクリプト」

実行を簡単にするため、ネイティブのWLSTコマンドを呼び出すラッパー・シェル・スクリプト(Linux/Unixでは.sh、Windowsでは.cmd)が用意されています。このスクリプトは、wlst.shを使用してWLSTネイティブ・コマンドを呼び出す前に、CLASSPATHなどの環境プロパティを設定します。これらのすべてのスクリプトは、$ORACLE_HOME/binディレクトリにあります。

.shおよび.cmdコマンドは、WLSサーバーに接続してから対応するWLSTコマンドを実行します。デフォルトでは、サーバー接続の詳細は、コマンドを実行しているユーザーのHOMEディレクトリ(通常、Linux/Unixでは/home/UserId、WindowsではC:\Documents and Settings\UserId)にあるserver.propertiesという名前のファイルから読み取られます。デフォルトのファイルは、代替ファイルを指定するか、コマンド行で明示的な値(ホスト、ポート、ユーザー名、パスワード)を提供することによってオーバーライドできます。コマンド行で指定されたホスト、ポート、ユーザー名およびパスワードの値は、ファイル内の対応する値よりも優先されます。

接続の詳細は、server.propertiesファイルまたはコマンド行で指定された代替ファイルにおいて、次の構文で指定される必要があります。

ADMIN_SERVER_HOST=host.example.com
ADMIN_SERVER_PORT=7001
ADMIN_USER_NAME=weblogic
ADMIN_PASSWORD=weblogic1
ESS_SERVER_NAME=ess_server1

管理性チェックリストの要件を順守するため、シェル・スクリプト起動時のコマンド行引数にパスワードを指定することはできません。パスワードは、server.propertiesファイルの一部とするか、対話形式で入力できます。次のいずれかの方法を使用して、対話型のパスワード発行を自動化できます。

- WLS管理者パスワードをファイルに書き込み、それを使用してコマンドに入力をリダイレクトします。次に例を示します。
sh essManageRuntimeConfig.sh .... < input.txt

- コマンドが終了した後に「<<EOF」を使用します。EOFは、実際のパスワード以外の任意の一意の文字列とすることができます。次の行にパスワードを記述し、その次の行にEOF(または<<の後に使用した任意の終端文字列)を続けます。次に例を示します。

sh essManageRuntimeConfig.sh ... <<EOF
wls_admin_password
EOF

4.6.1 essManageRuntimeConfig

Oracle Enterprise Schedulerのランタイム構成パラメータを管理します。サーバー接続パラメータは、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されているファイルを使用して指定します。ただし、コマンド行で明示的に指定するか、-fオプションを使用して代替ファイルを指定してデフォルト値をオーバーライドできます。WLSの管理サーバー・パスワードは、ファイル内で指定するか、対話形式で入力する必要があります。

4.6.1.1 構文

essManageRuntimeConfig.sh [-a | -m | -d] -A appname -t parameter_type [-n name] [-v value] [-f filename] [-H hostname] [-P port] [-u user] [-s server_name] [-h]

4.6.1.2 オプション

次の表に、コマンドオプションを一覧表示して説明します。

オプション

説明

-a, --add

構成パラメータを追加します

-m, --mod

構成パラメータを変更します

-d, --del

構成パラメータを削除します。

-A, --app appname

ホスティング・アプリケーションの名前を指定します。

-t, --type parameter_type

構成パラメータのタイプを指定します。有効なタイプは、次のとおりです。

- ESS - Oracle Enterprise Schedulerのパラメータ

- APP - ユーザー定義のパラメータ

-n, --name name

構成パラメータの名前を指定します。

-v, --val value

構成パラメータの値を指定します。

-f, --file filename

サーバー接続パラメータを含むファイルの名前を指定します。指定されない場合、デフォルトのファイル$HOME/server.propertiesが使用されます。

-H, --host hostname

WLSサーバーのホスト名またはIPアドレスを指定します。

-P, --port port

接続するポート番号を指定します。

-u, --user username

ユーザー名を指定します。

-s, --serv server_name

ESSAPPが実行されているサーバーの名前を指定します。

-h

コマンドの使用方法を表示します。

4.6.1.3 関連ファイル

このコマンドで次のファイルが使用されます。

server.properties: サーバー接続情報が含まれます

4.6.1.4 終了値

このコマンドは次の可能な値で終了します。

- 0: 正常終了

- -1: エラー

4.6.1.5 例

- アプリケーションmyappに対するユーザー定義パラメータfooを値barとともに追加

essManageRuntimeConfig.sh -a -A myapp -t APP -n foo -v bar

- アプリケーションmyappに対するユーザー定義パラメータfooの値の取得

essManageRuntimeConfig.sh -A myapp -t APP -n foo

- アプリケーションmyappに対するすべてのユーザー定義パラメータのリストの取得

essManageRuntimeConfig.sh -A myapp -t APP

- アプリケーションmyappに対するユーザー定義パラメータfooの値のbaroneへの変更

essManageRuntimeConfig.sh -m -A myapp -t APP -n foo -v barone

- アプリケーションmyappに対するユーザー定義パラメータfooの削除

essManageRuntimeConfig.sh -d -t APP -A myapp -n foo

- myapp用のすべてのESSパラメータの表示

essManageRuntimeConfig.sh -t ESS -A myapp

4.6.1.6 関連ネイティブ・コマンド

「構成パラメータの管理(追加/削除/修正/取得)」

4.6.2 essGetOutputContent

すべての指定されたリクエストIDに対して、コンテンツ・ストアからリクエスト・ログおよび出力データ・ファイルを取得します。サーバー接続パラメータは、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されているファイルを使用して指定します。ただし、コマンド行で明示的に指定するか、-fオプションを使用して代替ファイルを指定してデフォルト値をオーバーライドできます。WLSの管理サーバー・パスワードは、ファイル内で指定するか、対話形式で入力する必要があります。

4.6.2.1 構文

essGetOutputContent.sh [-t content_type] [-d dir] [-n lines] [-x disp] [-f filename] [-H hostname] [-P port] [-u user] [-s server_name] [-h] requestId1

4.6.2.2 オプション

次の表に、コマンドオプションを一覧表示して説明します。

オプション

説明

-t, --content type

取得するコンテンツ・タイプを次の中から1つ指定します。

- LOG

- OUTPUT

- TEXT_OUTPUT

- BINARY_OUTPUT

このオプションが指定されない場合、ログおよび出力コンテンツの両方が取得されます。

-d, --outDir dir

コンテンツが格納されるディレクトリを指定します。デフォルトは、現行のディレクトリです。

-n, --logLines lines

取得するログの行数を指定します。デフォルトは1000です。

-x, --logDisplay disp

ログの行が表示される場所を指定します。有効な値はCONSOLEまたはFILEです。デフォルトはFILEです。

-f, --file filename

サーバー接続パラメータを含むファイルの名前を指定します。指定されない場合、デフォルトのファイル$HOME/server.propertiesが使用されます。

-H, --host hostname

WLSサーバーのホスト名またはIPアドレスを指定します。

-P, --port port

接続するポート番号を指定します。

-u, --user username

ユーザー名を指定します。

-s, --serv server_name

ESSAPPが実行されているサーバーの名前を指定します。

-h

コマンドの使用方法を表示します。

4.6.2.3 関連ファイル

このコマンドで次のファイルが使用されます。

server.properties: サーバー接続情報が含まれます

4.6.2.4 終了値

このコマンドは次の可能な値で終了します。

- 0: 正常終了

- -1: エラー

4.6.2.5 例

- リクエストID 123のリクエスト・ログの取得

essGetOutputContent.sh -t LOG 123

- リクエスト123のすべての出力を取得

essGetOutputContent.sh -t OUTPUT 123

- リクエスト123のすべての出力を取得し、それをディレクトリ/tmpに保存

essGetOutputContent.sh -t OUTPUT -d "/tmp" 123

- リクエストID 123のリクエスト・ログの最初の100行を取得

essGetOutputContent.sh -t LOG -n 100 123

- リクエスト123および124のリクエスト・ログおよび出力データを取得し、それを/tmpに保存

essGetOutputContent.sh -d "/tmp" 123 124

4.6.2.6 関連ネイティブ・コマンド

「リクエストのログおよび出力コンテンツの取得」

4.6.3 essQueryRequests

ホスティング・アプリケーションの名前、状態、実行の経過時間に基づいて、リクエストを検索および一覧表示します。このコマンドは、長時間実行しているリクエストの検出に使用できます。サーバー接続パラメータは、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されているファイルを使用して指定します。ただし、コマンド行で明示的に指定するか、-fオプションを使用して代替ファイルを指定してデフォルト値をオーバーライドできます。WLSの管理サーバー・パスワードは、ファイル内で指定するか、対話形式で入力する必要があります。

4.6.3.1 構文

essQueryRequests.sh [-a app_name] [-S state] [-d days] [-n hours] [-m minutes] [-f filename] [-H hostname] [-P port] [-u user] [-s server_name] [-h]

4.6.3.2 オプション

次の表に、コマンドオプションを一覧表示して説明します。

オプション

説明

-a, --appName app_name

ホスティング・アプリケーション名を指定します。

-S, --state state

リクエスト状態を次の中から1つ指定します。

- WAIT

- READY

- RUNNING

- COMPLETED

- BLOCKED

- HOLD

- CANCELLING

- EXPIRED

- CANCELLED

- ERROR

- WARNING

- SUCCEEDED

- PAUSED

- PENDING_VALIDATION

- VALIDATION_FAILED

- SCHEDULE_ENDED

- FINISHED

- ERROR_AUTO_RETRY

- ERROR_MANUAL_RECOVERY

-d, --days days

実行時間を日数で指定します。

-n, --hours hours

実行時間を時間単位で指定します。

-m, --minutes minutes

実行時間を分単位で指定します。

-f, --file filename

サーバー接続パラメータを含むファイルの名前を指定します。指定されない場合、デフォルトのファイル$HOME/server.propertiesが使用されます。

-H, --host hostname

WLSサーバーのホスト名またはIPアドレスを指定します。

-P, --port port

接続するポート番号を指定します。

-u, --user username

ユーザー名を指定します。

-s, --serv server_name

ESSAPPが実行されているサーバーの名前を指定します。

-h

コマンドの使用方法を表示します。

4.6.3.3 関連ファイル

このコマンドで次のファイルが使用されます。

server.properties: サーバー接続情報が含まれます

4.6.3.4 終了値

このコマンドは次の可能な値で終了します。

- 0: 正常終了

- -1: エラー

4.6.3.5 例

- 実行中のすべてのリクエストの取得

essQueryRequests.sh -S RUNNING

- 取り消されたすべてのリクエストの取得

eessQueryRequests.sh -S CANCELLED

- 実行してから2日を過ぎているすべてのリクエストの取得

essQueryRequests.sh -d 2

- 実行してから10時間を過ぎているすべてのリクエストの取得

essQueryRequests.sh -n 10

- アプリケーションmyappに対して実行しているすべてのリクエストの取得

essQueryRequests.sh -a myapp

- アプリケーションmyappに対するCANCELLING状態のすべてのリクエストの取得

essQueryRequests.sh -a myapp -S CANCELLING

- アプリケーションmyappに対して2.5日を過ぎても実行しているすべてのリクエストの取得

essQueryRequests.sh -a myapp -d 2 -n 12

4.6.3.6 関連ネイティブ・コマンド

リクエストの検索および一覧表示

4.6.4 essManageRequests

リクエストIDで指定された1つ以上のリクエストを取消し、リカバリまたは完了します。サーバー接続パラメータは、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されているファイルを使用して指定します。ただし、コマンド行で明示的に指定するか、-fオプションを使用して代替ファイルを指定してデフォルト値をオーバーライドできます。WLSの管理サーバー・パスワードは、ファイル内で指定するか、対話形式で入力する必要があります。

4.6.4.1 構文

essManageRequests.sh [-c] [-r] [-C] [-g] [-S status] [-M message] [-f filename] [-H hostname] [-P port] [-u user] [-s server_name] [-h] requestId1

4.6.4.2 オプション

次の表に、コマンドオプションを一覧表示して説明します。

オプション

説明

-c, --cancel

リクエストを取り消します。

-r, --recover

リクエストをリカバリします

-C, --complete

リクエストを完了したものとしてマークします。

-g, --getdetail

リクエストの詳細を取得します。

-S, --asyncStatus status

リクエストを完了としてマークする場合、最終処理ステータスを次の中から1つ指定します。

- SUCCESS

- PAUSE

- WARNING

- ERROR

- CANCEL

- UPDATE

- BIZ_ERROR

- ERROR_MANUAL_RECOVERY

-M, --statusMessage message

リクエストを完了としてマークする場合、操作を説明する限定的なメッセージを指定します。

-f, --file filename

サーバー接続パラメータを含むファイルの名前を指定します。指定されない場合、デフォルトのファイル$HOME/server.propertiesが使用されます。

-H, --host hostname

WLSサーバーのホスト名またはIPアドレスを指定します。

-P, --port port

接続するポート番号を指定します。

-u, --user username

ユーザー名を指定します。

-s, --serv server_name

ESSAPPが実行されているサーバーの名前を指定します。

-h

コマンドの使用方法を表示します。

4.6.4.3 関連ファイル

このコマンドで次のファイルが使用されます。

server.properties: サーバー接続情報が含まれます

4.6.4.4 終了値

このコマンドは次の可能な値で終了します。

- 0: 正常終了

- -1: エラー

4.6.4.5 例

- リクエスト123および124の取消し

essManageRequests.sh -c 123 124

- リクエスト123のリカバリ

essManageRequests.sh -r 123

- リクエスト123の完了

essManageRequests.sh -C -S ERROR -M "Completed by Admin" 123

4.6.4.6 関連ネイティブ・コマンド

「リクエストの管理」

4.6.5 essManageServer

サーバーで実行中のOracle Enterprise Schedulerアプリケーションの起動、停止およびステータスの取得を行います。Oracle Enterprise Schedulerアプリケーションを起動すると、Oracle Enterprise Schedulerプロセッサ・スレッドが起動され、リクエスト処理を開始できるようになります。Oracle Enterprise Schedulerアプリケーションを停止すると、Oracle Enterprise Schedulerプロセッサが停止または休止され、新しいリクエストが処理されなくなります。サーバー接続パラメータは、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されているファイルを使用して指定します。ただし、コマンド行で明示的に指定するか、-fオプションを使用して代替ファイルを指定してデフォルト値をオーバーライドできます。WLSの管理サーバー・パスワードは、ファイル内で指定するか、対話形式で入力する必要があります。

4.6.5.1 構文

essManageServer.sh [-start] [stop] [-status] [-f filename] [-H hostname] [-P port] [-u user] [-s server_name] [-h]

4.6.5.2 オプション

次の表に、コマンドオプションを一覧表示して説明します。

オプション

説明

-n, --start

Oracle Enterprise Schedulerのプロセッサ・スレッドを起動します。

-x, --stop

Oracle Enterprise Schedulerのプロセッサ・スレッドを停止します。

-S, --status

Oracle Enterprise Schedulerのプロセッサ・スレッドの現在の状態を表示します。

-f, --file filename

サーバー接続パラメータを含むファイルの名前を指定します。指定されない場合、デフォルトのファイル$HOME/server.propertiesが使用されます。

-H, --host hostname

WLSサーバーのホスト名またはIPアドレスを指定します。

-P, --port port

接続するポート番号を指定します。

-u, --user username

ユーザー名を指定します。

-s, --serv server_name

ESSAPPが実行されているサーバーの名前を指定します。

-h

コマンドの使用方法を表示します。

4.6.5.3 関連ファイル

このコマンドで次のファイルが使用されます。

server.properties: サーバー接続情報が含まれます

4.6.5.4 終了値

このコマンドは次の可能な値で終了します。

- 0: 正常終了

- -1: エラー

4.6.5.5 例

- Oracle Enterprise Schedulerのプロセッサを停止します。

essManageServer.sh --stop

- Oracle Enterprise Schedulerプロセッサの現在の状態の取得

essManageServer.sh --status

4.6.5.6 関連ネイティブ・コマンド

「Oracle Enterprise Schedulerサーバーの管理」

4.6.6 essSubmitRequest

ESSAPPに実行のジョブ・リクエストを発行します。ジョブ定義はMDSにあるとみなされます。ユーザーは、次の4つの方法でジョブ実行スケジュールを指定できます。

- 即時: ジョブは即時のワンタイム実行をするように計画されます。

- 一度: ジョブは、ユーザーに指定された固定時間に一度実行するようにスケジュールされます。

- スケジュール: (MDSの)事前定義済のスケジュール名が提供され、ジョブはそのスケジュールで実行します。

- 繰返し: このコマンドで関連する引数を指定することで、スケジュールをアドホック方式で作成できます。このスケジュールはリクエスト発行に使用され、今後の使用のためにMDSに格納されます。記憶域の場所は、指定されたスケジュール名に基づきます。

スケジュール方法が指定されない場合、即時実行が使用されます。

注意:

ジョブ定義は事前定義する必要がありますが、スケジュールはこのコマンドを使用してアドホック方式で定義できます。

jobNameおよびschNameオプションは、パッケージ名を含む完全修飾名である必要があります。完全修飾されていない場合、パッケージ/oracle/apps/ess/customが使用されます。

サーバー接続パラメータは、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されているファイルを使用して指定します。ただし、コマンド行で明示的に指定するか、-fオプションを使用して代替ファイルを指定してデフォルト値をオーバーライドできます。WLSの管理サーバー・パスワードは、ファイル内で指定するか、対話形式で入力する必要があります。

4.6.6.1 構文

essSubmitRequest.sh appName jobName [-n reqNote] [-I | -O time | -R params | -S schName] [-f filename] [-H hostname] [-P port] [-u user] [-s server_name] [-h] [prop=value ]

4.6.6.2 オプション

次の表に、コマンドオプションを一覧表示して説明します。

オプション

説明

appName

ジョブのホスティング・アプリケーションの名前を指定します。

jobName

現在のリクエストに使用されるジョブ定義の名前を指定します。

-n, --note reqNote

ジョブ・リクエストの簡単な説明を指定します

-S, --schName schName

事前定義済のスケジュール定義の名前を指定します。

-A, --RschName name

スケジュールを-Rオプションを使用して定義した場合、スケジュールの名前を指定します。

-C, --schDesc desc

定義されているアドホック・スケジュールの説明を指定します。デフォルト値は「Custom Ad-Hoc Schedule」です。

-I, --immediate

ジョブがすぐに実行されるように指定します。他のスケジュールが指定されない場合、これがデフォルトとして使用されます。

-O, --o_time time

ワンタイム実行の時間を指定します。形式: HH:MM:SS:DD:MM:YYYY。

-R, --recurring

スケジュールの繰返しを指定します。

-b, --begin_time time

繰返しスケジュールの開始時間を指定します。形式: HH:MM:SS:DD:MM:YYYY。

-F, --frequency value

繰返しの頻度を指定します。有効な値: [SECOND,MINUTE,HOUR,DAY,WEEK,MONTH,YEAR]

-N, --freqNum num

繰返しの頻度の間隔を示す整数値を指定します。

-c, --count num

繰返しの最大数を整数値で指定します。

-e, --end_time time

繰返しの終了時間を指定します。形式: HH:MM:SS:DD:MM:YYYY。

-m, --month month

頻度がYEARに設定された場合、何月かを定義します。有効な値は[1-12]です。

-w, --week week

ある月の週を指定します。有効な値は[1-6, LAST]です。

-d, --day day

曜日を指定します。有効な値は[1-7]で、1は月曜日を表します。

-D, --date date

月の特定の日を指定します。有効な値は[1-31, LAST]です。

prop=value

prop1=val1 prop2=val2などと指定された他のリクエスト・パラメータまたはプロパティを指定します。これらの値はコマンドにおいて最後のオプションとして追加する必要があります。

-f, --file filename

サーバー接続パラメータを含むファイルの名前を指定します。指定されない場合、デフォルトのファイル$HOME/server.propertiesが使用されます。

-H, --host hostname

WLSサーバーのホスト名またはIPアドレスを指定します。

-P, --port port

接続するポート番号を指定します。

-u, --user username

ユーザー名を指定します。

-s, --serv server_name

ESSAPPが実行されているサーバーの名前を指定します。

-h

コマンドの使用方法を表示します。

4.6.6.3 関連ファイル

このコマンドで次のファイルが使用されます。

server.properties: サーバー接続情報が含まれます

4.6.6.4 終了値

このコマンドは次の可能な値で終了します。

- 0: 正常終了

- -1: エラー

4.6.6.5 例

次の値は例のすべてに対して適用されます。

HOSTING_APP = EssDemoApp

SCHEDULE_NAME= /oracle/apps/ess/custom/MySch

JOB_DEF_NAME= /oracle/apps/ess/demopackage/BasicJavaJob

また、サーバー接続プロパティは~/server.propertiesファイルで定義されます。

注意:

[prop-value ...]値は、コマンドにおいて最後のオプションとして追加する必要があります。

- 即時ジョブ実行のリクエストを発行(ワンタイムのみ)

essSubmitRequest.sh HOSTING_APP JOB_DEF_NAME

- 指定された時間にワンタイム・ジョブ実行のリクエストを発行。

essSubmitRequest.sh HOSTING_APP JOB_DEF_NAME -O 21:10:30:03:05:2012

- 繰返しスケジュールでジョブ・リクエストを発行。この繰返しは次のように定義されます。

- 実行は2分ごとに繰り返し

- 2012年5月3日の21:10:30に開始

- 3回の反復で完了

- 追加のリクエスト・パラメータは、eqName=testおよびPRIORITY=10です。この繰返しは、今後の使用のためにMDSリポジトリに保持されます。

essSubmitRequest.sh HOSTING_APP JOB_DEF_NAME -R -A SCHEDULE_NAME -F MINUTE -N 2 -c 3 -b 21:10:30:03:05:2012 reqName=test PRIORITY=10

- 事前定義済のスケジュールを使用してジョブ・リクエストを発行

essSubmitRequest.sh HOSTING_APP JOB_DEF_NAME -S SCHEDULE_NAME

- 月の繰返しスケジュールでジョブ・リクエストを発行。リクエストの説明は、「Request with monthly schedule」です。繰返しスケジュール名および説明は、-Aおよび-C オプションによって指定されます。この繰返しは、2012年5月3日の21:10:30から2013年5月4日の21:10:30まで、2か月ごとに5週目(ある場合)の木曜日に実行されます。

essSubmitRequest.sh HOSTING_APP JOB_DEF_NAME -n "Request with monthly schedule" -R -A SCHEDULE_NAME -C Monthly_schedule -F MONTH -N 2 -b 21:10:30:03:05:2012 -w 5 -d 4 -e 21:10:30:04:05:2013

- 1年ごとに繰返すスケジュールでジョブ・リクエストを発行。リクエストの説明は、「Request with yearly schedule」です。繰返しスケジュール名および説明は、-Aおよび-Cオプションによって指定されます。この繰返しは、2012年5月3日の21:10:30に始めて、3年ごとに5月の最終日に実行され、5回繰り返されます。

essSubmitRequest.sh HOSTING_APP JOB_DEF_NAME -n "Request with yearly schedule" -R -A SCHEDULE_NAME-C "Yearly_schedule" -F YEAR -N 3 -b 21:10:30:03:05:2012 -m 5 -D LAST -c 5

- 1時間ごとに繰返すスケジュールでジョブ・リクエストを発行。この繰返しは、現在の時刻に始めて、1時間ごとに実行されます。

essQueryRequests.sh -a myapp -d 2 -n 12

4.6.6.6 関連ネイティブ・コマンド

「Oracle Enterprise Schedulerへのジョブ・リクエストの発行」

4.6.7 essManageJobDefn

Oracle Enterprise Schedulerのジョブ定義を管理(表示、作成、削除、カスタマイズ、更新)します。

showオプション(-S)は、特定のアプリケーションの一部であるジョブ定義のリストを表示します。ジョブ名が指定された場合、このジョブ定義の詳細のみを表示します。createオプション(-N)は、MDSの関連するアプリケーション(パラメータとして指定)のネームスペースに新しいジョブ定義を作成します。deleteオプション(-D)は、MDSからジョブ定義を削除します。customizeオプション(-C)は、既存のジョブ定義のカスタマイズ可能なプロパティを変更します。updateオプション(-U)は、既存のジョブ定義を希望のプロパティ値で更新します(オーバーライドされない場合は既存のパラメータを保持します)。

注意:

- ジョブ定義の作成、削除および更新では、デフォルトのパッケージ・パス/oracle/apps/ess/custom/が常に指定されたジョブ名の前に付加されます。

- /oracle/apps/ess/customネームスペースにあるジョブ定義のみを作成、削除、または更新できます。つまり、事前パッケージ済のジョブ定義は変更できません。

- 顧客ネームスペース/oracle/apps/ess/customにあるジョブ定義はカスタマイズできません。それらの定義を変更するには更新オプションを使用してください。

- jobTypeの指定では、完全修飾名を指定しない場合、デフォルト・パッケージ/oracle/as/ess/core/の接頭辞が名前に付加されます。

サーバー接続パラメータは、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されているファイルを使用して指定します。ただし、コマンド行で明示的に指定するか、-fオプションを使用して代替ファイルを指定してデフォルト値をオーバーライドできます。WLSの管理サーバー・パスワードは、ファイル内で指定するか、対話形式で入力する必要があります。

4.6.7.1 構文

essManageJobDefn.sh appName [-j jobName] [-t jobType] [-d desc] -S | -N | -D | -C | -U [-f filename] [-H hostname] [-P port] [-u user] [-s server_name] [-h] [prop=value ]

4.6.7.2 オプション

次の表に、コマンドオプションを一覧表示して説明します。

オプション

説明

appName

ジョブ用のホスティング・アプリケーションの論理名を指定します。

-j, --jobName jobDefn

ジョブ定義の名前を指定します。作成、削除および更新の操作では、デフォルト・パッケージ/oracle/apps/ess/custom/が指定された名前の前に付加されます。

-t, --jobType jobType

ジョブ定義の作成に使用される事前定義済のジョブ・タイプの名前を指定します。名前にパッケージ・パスが含まれない場合、名前の前にパス/oracle/as/ess/core/が付加されます。

-d, --desc description

ジョブ定義の説明を指定します。

-S, --show

特定のアプリケーションの一部であるジョブ定義のリストを表示します。ジョブ名が指定された場合、そのジョブ定義のみの詳細を表示します。appNameおよび-jとともに使用されます。

-N, --create

新しいジョブ定義を作成します。appName、-j、-t、-dおよびprop=valueとともに使用されます。

-D, --delete

既存のジョブ定義を削除します。appNameおよび-jとともに使用されます。

-C, --customize

ジョブ定義のカスタマイズ可能なプロパティを変更します。プロパティは次のとおりです。

- SYS_retries

- SYS_priority

- SYS_requestCategory

- SYS_request_timeout

- enableTrace

- enableTimeStatistics

appName、-jオプション、prop=valueとともに使用されます。

-U, --update

既存のジョブ定義を更新します。このオプションは現在の定義を新しいものと置き換え、オーバーライドされない場合は既存のパラメータを保持します。appName、-j、および-dまたはprop=valueのいずれかとともに使用されます。

prop=value

prop1=val1 prop2=val2などと指定された他のリクエスト・パラメータまたはプロパティを指定します。

-f, --file filename

サーバー接続パラメータを含むファイルの名前を指定します。指定されない場合、デフォルトのファイル$HOME/server.propertiesが使用されます。

-H, --host hostname

WLSサーバーのホスト名またはIPアドレスを指定します。

-P, --port port

接続するポート番号を指定します。

-u, --user username

ユーザー名を指定します。

-s, --serv server_name

ESSAPPが実行されているサーバーの名前を指定します。

-h

コマンドの使用方法を表示します。

4.6.7.3 関連ファイル

このコマンドで次のファイルが使用されます。

server.properties: サーバー接続情報が含まれます

4.6.7.4 終了値

このコマンドは次の可能な値で終了します。

- 0: 正常終了

- -1: エラー

4.6.7.5 例

次の値は例のすべてに対して適用されます。

HOSTING_APP = ESS_NATIVE_HOSTING_APP_LOGICAL_NAME

JOB_DEF_PREDEF= /oracle/apps/ess/TestJob

JOB_DEF_NAME = TestJob_wlst

JOB_TYPE_NAME = JavaJobType

JOB_DESC = My WLST Test Defn

また、サーバー接続プロパティは~/server.propertiesファイルで定義されます。

- HOSTING_APPのネームスペースにあるすべてのジョブ定義の表示

essManageJobDefn.sh HOSTING_APP -S

- HOSTING_APPのジョブ定義JOB_DEF_PREDEF部分の詳細表示

essManageJobDefn.sh HOSTING_APP -S -j JOB_DEF_PREDEF

- /oracle/apps/ess/custom/TestJob_wlstという名前の新しいジョブ定義をHOSTING_APPのネームスペースにジョブ・タイプ/oracle/as/ess/core/JavaJobTypeで作成

essManageJobDefn.sh HOSTING_APP -N -j JOB_DEF_NAME -t JOB_TYPE_NAME

- /oracle/apps/ess/custom/TestJob_wlstという名前の新しいジョブ定義をHOSTING_APPのネームスペースにジョブ・タイプ/oracle/as/ess/core/JavaJobTypeおよび説明JOB_DESCで作成

essManageJobDefn.sh HOSTING_APP -N -j JOB_DEF_NAME -t JOB_TYPE_NAME -d JOB_DESC

- /oracle/apps/ess/custom/TestJob_wlstという名前の新しいジョブ定義をHOSTING_APPのネームスペースにジョブ・タイプ/oracle/as/ess/core/JavaJobTypeおよび説明JOB_DESC、プロパティSYS_retriesおよびmyParamで作成

essManageJobDefn.sh HOSTING_APP -N -j JOB_DEF_NAME -t JOB_TYPE_NAME -d JOB_DESC SYS_retries=1 myParam=xyz

- ジョブ定義/oracle/apps/ess/custom+JOB_DEF_NAMEを新しい説明JOB_DESCで更新

essManageJobDefn.sh HOSTING_APP -U -j JOB_DEF_NAME -d JOB_DESC

- ジョブ定義/oracle/apps/ess/custom+JOB_DEF_NAMEをプロパティSYS_retriesおよびmyParamで更新

essManageJobDefn.sh HOSTING_APP -U -j JOB_DEF_NAME SYS_retries=1 myParam=xyz

- HOSTING_APPのジョブ定義/oracle/apps/ess/custom+JOB_DEF_NAMEを削除

essManageJobDefn.sh HOSTING_APP -D -j JOB_DEF_NAME

- HOSTING_APPの事前パッケージ済ジョブ定義JOB_DEF_PREDEFをカスタマイズ可能なプロパティSYS_retriesおよびSYS_priorityを使用してカスタマイズ

essManageJobDefn.sh HOSTING_APP -C -j JOB_DEF_PREDEF SYS_retries=2 SYS_priority=3

4.6.7.6 関連ネイティブ・コマンド

「Oracle Enterprise Schedulerのジョブ定義の管理」

4.6.8 essManageSchedule

Oracle Enterprise Schedulerのスケジュール定義を管理(表示、作成、削除、カスタマイズおよび更新)。

showオプション(-S)は、特定のアプリケーションの一部であるスケジュール定義のリストを表示します。スケジュール名が指定された場合、そのスケジュール定義の詳細を表示します。

createオプション(-C)は、MDS内の(パラメータとして指定された)関連するアプリケーションのネームスペースに新しいスケジュール定義を作成します。

deleteオプション(-D)は、MDSから指定されたスケジュール定義を削除します。

updateオプション(-U)は、既存のスケジュール定義を、指定されたプロパティ値で更新します(オーバーライドされない場合は既存のパラメータを保持します)。

サーバー接続パラメータは、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されているファイルを使用して指定します。ただし、コマンド行で明示的に指定するか、-fオプションを使用して代替ファイルを指定してデフォルト値をオーバーライドできます。WLSの管理サーバー・パスワードは、ファイル内で指定するか、対話形式で入力する必要があります。

注意:

デフォルトのパッケージ名/oracle/apps/ess/custom/が常に、-nオプションで指定されたスケジュール名の前に付加されます。

4.6.8.1 構文

essManageSchedule.sh appName [-n schName] [-d desc] -S | -C | -D | -U -F value [-I interval] [-b begin_time] [-c count | -e end_time][-f filename] [-H hostname] [-P port] [-u user] [-s server_name]

4.6.8.2 オプション

次の表に、コマンドオプションを一覧表示して説明します。

オプション

説明

appName

ホスティング・アプリケーションの論理名を指定します。

-n, --schName schName

スケジュール定義の名前を指定します。作成、削除および更新の操作では、デフォルト・パッケージ/oracle/apps/ess/custom/が指定された名前の前に付加されます。

-d, --schDesc description

スケジュール定義の説明を指定します。

-S, --show

特定のアプリケーションの一部であるスケジュール定義のリストを表示します。スケジュール名が指定された場合、そのスケジュール定義のみの詳細を表示します。appName、-nおよび-dとともに使用されます。

-C, --create

新しいスケジュール定義を作成します。appName、-j、-t、-dおよびprop=valueとともに使用されます。

-D, --delete

既存のスケジュール定義を削除します。appNameおよび-nとともに使用されます。

-U, --update

既存のスケジュール定義を更新します。このオプションは現在の定義を新しいものと置き換え、オーバーライドされない場合は既存のパラメータを保持します。appName、-n、および-dまたは-Fのいずれかとともに使用されます。

-b, --begin_time time

繰返しの開始時間を指定します。形式: HH:MM:SS:DD:MM:YYYY

-F, --frequency value

繰返しの頻度を指定します。有効な値: SECOND、MINUTE、HOUR、DAY、WEEK、MONTH、YEAR

有効なオプション:

-F value [-I interval] [-b begin_time] [-c count | -e end_time] (valueがSECOND、MINUTE、HOUR、DAY、WEEKの場合で、それ以外の場合は次のいずれか)

-F MONTH [{-w week -d day} | {-D date}] [-b begin_time] [-c count | -e end_time]

-F YEAR [-m month ({-w week -d day} | {-D date})] [-b begin_time] [-c count | -e end_time]

-I, --interval num

-Fオプションの繰返し間隔として使用する整数値を指定します。

-c, --count num

繰返しの最大数を整数値で指定します。

-e, --end_time time

繰返しの終了時間を指定します。形式: HH:MM:SS:DD:MM:YYYY。

-m, --month month

頻度がYEARに設定された場合、何月かを定義します。有効な値は[1-12]です。

-f, --file filename

サーバー接続パラメータを含むファイルの名前を指定します。指定されない場合、デフォルトのファイル$HOME/server.propertiesが使用されます。

-H, --host hostname

WLSサーバーのホスト名またはIPアドレスを指定します。

-P, --port port

接続するポート番号を指定します。

-u, --user username

ユーザー名を指定します。

-s, --serv server_name

ESSAPPが実行されているサーバーの名前を指定します。

-h

コマンドの使用方法を表示します。

4.6.8.3 関連ファイル

このコマンドで次のファイルが使用されます。

server.properties: サーバー接続情報が含まれます

4.6.8.4 終了値

このコマンドは次の可能な値で終了します。

- 0: 正常終了

- -1: エラー

4.6.8.5 例

次の値は例のすべてに対して適用されます。

HOSTING_APP = ESS_NATIVE_HOSTING_APP_LOGICAL_NAME

PREDEF_SCHEDULE = /oracle/apps/ess/demo/seeded/MyPredefinedSch

SCHEDULE_NAME = MyWlstSchedule

SCH_DESC = Description for WLST test schedule

また、サーバー接続プロパティは~/server.propertiesファイルで定義されます。

- HOSTING_APPのネームスペースにあるすべてのスケジュール定義の表示

essManageSchedule.sh HOSTING_APP -S

- HOSTING_APPのスケジュール定義PREDEF_SCHEDULEの詳細表示

essManageSchedule.sh HOSTING_APP -S -n PREDEF_SCHEDULE

- /oracle/apps/ess/custom/MyWlstScheduleという名前の新しい繰返しスケジュール定義をHOSTING_APPのネームスペースに説明SCH_DESCとともに作成。この繰返しは、2012年5月3日の21:10:30に始めて、2分ごとに実行され、3回繰り返されます。

essManageSchedule.sh HOSTING_APP -C -n SCHEDULE_NAME -d SCH_DESC -F MINUTE -I 2 -c 3 -b 21:10:30:03:05:12

- /oracle/apps/ess/custom/MyWlstScheduleという名前の新しい繰返しスケジュール定義をHOSTING_APPのネームスペースに作成。この繰返しは、2012年5月3日の21:10:30から2013年5月4日の21:10:30まで、2か月ごとに5週目(ある場合)の木曜日に実行されます。

essManageSchedule.sh HOSTING_APP -C -n SCHEDULE_NAME -F MONTH -I 2 -b 21:10:30:03:05:12 -w 5 -x 4 -e 21:10:30:04:05:13

- /oracle/apps/ess/custom/MyWlstScheduleという名前の新しい繰返しスケジュール定義をHOSTING_APPのネームスペースに作成。この繰返しは、2012年5月3日の21:10:30に始めて、5月の最終日に実行され、3年ごとに5回繰り返されます。

essManageSchedule.sh HOSTING_APP -C -n SCHEDULE_NAME -F YEAR -I 3 -b 21:10:30:03:05:12 -m 5 -y LAST -c 5

- /oracle/apps/ess/custom/MyWlstScheduleという名前の新しい繰返しスケジュール定義をHOSTING_APPのネームスペースに作成。この繰返しは、現在の時刻から始めて、1時間ごとに実行されます。

essManageSchedule.sh HOSTING_APP -C -n SCHEDULE_NAME -F HOUR

- スケジュール定義/oracle/apps/ess/custom+SCHEDULE_NAMEを新しい説明SCH_DESCで更新します。繰返しは変更はされません。

essManageSchedule.sh HOSTING_APP -U -n SCHEDULE_NAME -d SCH_DESC

- スケジュール定義/oracle/apps/ess/custom+SCHEDULE_NAMEを、1分ごとに実行される次の新しい繰返しで更新します。

essManageSchedule.sh HOSTING_APP -U -n SCHEDULE_NAME -F MINUTE

- HOSTING_APPのスケジュール定義/oracle/apps/ess/custom+SCHEDULE_NAMEを削除

essManageSchedule.sh HOSTING_APP -D -n SCHEDULE_NAME

4.6.8.6 関連ネイティブ・コマンド

「Oracle Enterprise Schedulerのスケジュール定義の管理」

4.6.9 essBatchDeleteRequests

バッチ削除ジョブのリクエストを発行します。(MDS内の)事前定義済のスケジュールを使用するか、ワンタイム実行時間を指定できます。これらのどちらも指定されない場合、リクエストはただちに開始されます。

リクエスト・パラメータは削除基準の指定に使用します。バッチ削除ジョブの実行時、ジョブは完了した絶対的な親とインスタンス親のどちらのリクエストがそのバッチ削除リクエストに対して指定された削除基準を満たしているかを判断し、それらのリクエストに対するリクエスト階層を削除します。

有効なバッチ削除パラメータの一覧および説明は、「バッチ削除パラメータ」を参照してください。

サーバー接続パラメータは、「Oracle Enterprise Schedulerの便利なスクリプト」で説明されているファイルを使用して指定します。ただし、コマンド行で明示的に指定するか、-fオプションを使用して代替ファイルを指定してデフォルト値をオーバーライドできます。WLSの管理サーバー・パスワードは、ファイル内で指定するか、対話形式で入力する必要があります。

4.6.9.1 構文

essBatchDeleteRequests.sh [-d desc] [-S schId] [-b beginTime] [-e endTime] [-f filename] [-H hostname] [-P port] [-u user] [-s server_name] [-h] [prop=value ]

4.6.9.2 オプション

次の表に、コマンドオプションを一覧表示して説明します。

オプション

説明

-d, --desc desc

バッチ削除リクエストの説明を指定します。

-S, --schId schId

使用するスケジュールの完全修飾名を指定します。デフォルト・パッケージ(パッケージが指定されない場合に使用)は/oracle/as/ess/essapp/custom/です。

-b, --begin beginTime

リクエストが開始される時間を指定します。形式: HH:MM:SS:DD:MM:YYYY

-e, --end endTime

リクエストを超過して実行してはならない時間を指定します。形式: HH:MM:SS:DD:MM:YYYY。

prop=value

prop1=val1 prop2=val2などと指定された他のリクエスト・パラメータまたはプロパティを指定します。パラメータの一覧は「バッチ削除パラメータ」を参照してください。

-f, --file filename

サーバー接続パラメータを含むファイルの名前を指定します。指定されない場合、デフォルトのファイル$HOME/server.propertiesが使用されます。

-H, --host hostname

WLSサーバーのホスト名またはIPアドレスを指定します。

-P, --port port

接続するポート番号を指定します。

-u, --user username

ユーザー名を指定します。

-s, --serv server_name

ESSAPPが実行されているサーバーの名前を指定します。

-h

コマンドの使用方法を表示します。

4.6.9.3 関連ファイル

このコマンドで次のファイルが使用されます。

server.properties: サーバー接続情報が含まれます

4.6.9.4 終了値

このコマンドは次の可能な値で終了します。

- 0: 正常終了

- -1: エラー

4.6.9.5 例

次の例では、サーバー接続プロパティは~/server.propertiesファイルで定義されていることを前提としています。

- すべてのパージ可能リクエストの削除。

essBatchDeleteRequests.sh

- アプリケーションESS_NATIVE_HOSTING_APP_LOGICAL_NAMEのすべてのパージ可能リクエストの削除

essBatchDeleteRequests.sh --desc "My purge for ESS NativeApp" CriteriaApplication=ESS_NATIVE_HOSTING_APP_LOGICAL_NAME

- ジョブ定義がJobDefinition://oracle/apps/ess/custom/MyDefのアプリケーションESS_NATIVE_HOSTING_APP_LOGICAL_NAMEのすべてのパージ可能リクエストの削除

essBatchDeleteRequests.sh --desc "My purge for ESS NativeApp" CriteriaApplication=ESS_NATIVE_HOSTING_APP_LOGICAL_NAMEsCriteriaJobDefn=JobDefinition://oracle/apps/ess/custom/MyDef

- スケジュール/oracle/as/ess/essapp/custom/WeeklySchを使用したバッチ削除ジョブ・リクエストの発行

essBatchDeleteRequests.sh --desc "Purge using WeekSch" --schId /oracle/as/ess/essapp/custom/WeeklySch

- ユーザーweblogicに発行されたすべてのパージ可能リクエストの削除

essBatchDeleteRequests.sh CriteriaSubmitUser=weblogic

- 最大10個のパージ可能リクエストの削除

essBatchDeleteRequests.sh CriteriaProcessLimit=10

- ジョブ実行タイプがJAVA_TYPEのパージ可能リクエストの削除

essBatchDeleteRequests.sh CriteriaJobExecType=JAVA_TYPE

- 5日以上前に完了したパージ可能リクエストの削除

essBatchDeleteRequests.sh CriteriaMinimumAge=5

- パージ可能リクエストを削除、ただし過去5日間に正常に完了したリクエストは保持

essBatchDeleteRequests.sh CriteriaRetentionAgeSuccess=5

- 「DemoProduct」という名前の製品に属するパージ可能リクエストの削除

essBatchDeleteRequests.sh CriteriaProduct=DemoProduct

4.6.9.6 関連ネイティブ・コマンド

batchDeleteSchedulerRequestコマンド

5 Oracle Managed File TransferのカスタムWLSTコマンド

この章では、Oracle Managed File Transfer (MFT)の操作を実行するWLST (Oracle WebLogic Scripting Tool)コマンドの要約を示します。

この章の内容は次のとおりです。

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

- MFTアーティファクト管理コマンド

- MFTメタデータ・コマンド

- MFT鍵管理コマンド

- MFTデプロイメント履歴コマンド

- MFT転送管理コマンド

- MFT埋込みサーバー・コマンド

- MFTコールアウト・コマンド

- MFTイベント通知コマンド

- MFTアーカイブおよび復元コマンド

- MFTパージ・コマンド

- MFT WLSTコマンドのシステムMBeanプロパティの設定

WLSTの全般的な情報は、『WebLogic Server WLSTコマンド・リファレンス』を参照してください。

MFTの全般的な情報は、「Oracle Managed File Transferの使用」を参照してください。

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

MFT WLSTコマンドは、次のカテゴリに分類されます。

表5-1 MFT WLSTコマンド・カテゴリ

コマンド・カテゴリ

説明

MFTアーティファクト管理コマンド

ソース、転送およびターゲットのアーティファクトで、有効化、無効化、デプロイ、アンデプロイ、削除、エクスポート、メタデータ・ストア(MDS)での存在のチェックの操作を実行します。

MFTメタデータ・コマンド

MFTメタデータをエクスポート、インポートおよびリセットします。

MFT鍵管理コマンド

MFTキーストアのSSL、SSHおよびPGP鍵を生成、インポート、エクスポート、削除、一覧表示および更新します。

MFTデプロイメント履歴コマンド

ソース、転送およびターゲットのアーティファクトのデプロイメント履歴を表示します。

MFT転送管理コマンド

転送インスタンスについての情報を一時停止、再開、再発行または表示します。

MFT埋込みサーバー・コマンド

埋込みFTPおよびsFTPサーバーのポートを起動、停止および変更します。

MFTコールアウト・コマンド

カスタム・コールアウトを作成、削除、一覧表示および更新します。

MFTイベント通知コマンド

- 連絡先を作成、削除および一覧表示します。

- イベント通知から連絡先を追加および削除します。

- イベント通知を有効および無効にします。

MFTアーカイブおよび復元コマンド

ステータスや日付範囲などの基準に基づいて転送インスタンスまたはファイル・システム・データをアーカイブします。

MFTパージ・コマンド

ステータスや日付範囲などの基準に基づいて転送インスタンスまたはファイル・システム・データをパージします。

5.2 MFTアーティファクト管理コマンド

ソース、転送およびターゲットのアーティファクトで操作を実行するには、表5-2に示されたMFT WLSTアーティファクト管理コマンドを使用します。

表5-2 MFTアーティファクト管理WLSTコマンド

使用するコマンド

用途

使用するWLST

bulkDeployArtifact

複数のソース、転送またはターゲットのアーティファクトをデプロイします。

オンラインまたはオフライン

deleteArtifactまたはdelAF

ソース、転送またはターゲットのアーティファクトを削除します。

オンラインまたはオフライン

deleteArtifactDeploymentまたはdelDepAF

アンデプロイされたソース、転送またはターゲットのアーティファクトを削除します。

オンラインまたはオフライン

deployArtifactまたはdepAF

ソース、転送またはターゲットのアーティファクトをデプロイします。

オンラインまたはオフライン

disableArtifactまたはdisAF

デプロイ済のソース、転送またはターゲットのアーティファクトを無効にします。

オンラインまたはオフライン

enableArtifactまたはenAF

デプロイ済のソース、転送またはターゲットのアーティファクトを有効にします。

オンラインまたはオフライン

exportDeployedArtifactまたはexpDepAF

デプロイ済のソース、転送またはターゲットのアーティファクトをZIPファイルにエクスポートします。

オンラインまたはオフライン

isArtifactInMDSまたはisAFinMDS

ソース、転送またはターゲットのアーティファクトがMDS(メタデータ・ストア)に存在するかどうかをチェックします。

オンラインまたはオフライン

undeployArtifactまたはundepAF

ソース、転送またはターゲットのアーティファクトをアンデプロイします。

オンラインまたはオフライン

5.2.1 bulkDeployArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.1.1 説明

複数のソース、転送またはターゲットのアーティファクトを一括デプロイします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.1.2 構文

bulkDeployArtifact(artifact_type, artifact_names, comment)

引数

定義

artifact_type

アーティファクト・タイプ: SOURCE、TRANSFERまたはTARGET。

artifact_names

カンマ区切りのアーティファクト名、またはすべてに対しては*。

comment

アーティファクトの説明またはそれらをデプロイする理由を示す文字列。

5.2.1.3 例

次の例では、2つのSOURCEアーティファクトをデプロイし、コメントを付けます。

bulkDeployArtifact('SOURCE', 'order-file-src,chk-inv-src', 'retrieves new purchase orders, checks inventory')

次の例では、すべてのTRANSFERアーティファクトをデプロイし、コメントを付けます。

bulkDeployArtifact('TRANSFER', '*', 'deploying all transfers')

5.2.2 deleteArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.2.1 説明

ソース、転送またはターゲットのアーティファクトを削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.2.2 構文

deleteArtifact(artifact_type, artifact_name)

delAF(artifact_type, artifact_name)

引数

定義

artifact_type

アーティファクト・タイプ: SOURCE、TRANSFERまたはTARGET。

artifact_name

アーティファクト名。

5.2.2.3 例

次の例では、order-file-srcというSOURCEアーティファクトを削除します。

deleteArtifact('SOURCE', 'order-file-src')

5.2.3 deleteArtifactDeployment

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.3.1 説明

アンデプロイされたソース、転送またはターゲットのアーティファクトを削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.3.2 構文

deleteArtifactDeployment(artifact_type, artifact_name, label)

delDepAF(artifact_type, artifact_name, label)

引数

定義

artifact_type

アーティファクト・タイプ: SOURCE、TRANSFERまたはTARGET。

artifact_name

アーティファクト名。

label

MDS (メタデータ・ストア)でのアーティファクト・ラベル。

このラベルを表示するには、「デプロイメント」タブの「デプロイメントの詳細の表示」を使用します。

5.2.3.3 例

次の例では、ラベルsoa_mft-2012-12-07 22:24:09.383の付いたorder-file-srcというSOURCEアーティファクトを削除します。

deleteArtifactDeployment('SOURCE', 'order-file-src', 'soa_mft-2012-12-07 22:24:09.383')

5.2.4 deployArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.4.1 説明

ソース、転送またはターゲットのアーティファクトをデプロイします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.4.2 構文

deployArtifact(artifact_type, artifact_name, comment)

depAF(artifact_type, artifact_name, comment)

引数

定義

artifact_type

アーティファクト・タイプ: SOURCE、TRANSFERまたはTARGET。

artifact_name

アーティファクト名。

comment

アーティファクトの説明またはアーティファクトをデプロイする理由を示す文字列。

5.2.4.3 例

次の例では、order-file-srcというSOURCEアーティファクトをデプロイし、このアーティファクトについてのコメントを付けます。

deployArtifact('SOURCE', 'order-file-src', 'retrieves new purchase orders')

5.2.5 disableArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.5.1 説明

デプロイ済で以前に有効化されたソース、転送またはターゲットのアーティファクトを無効にします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.5.2 構文

disableArtifact(artifact_type, artifact_name, comment)

disAF(artifact_type, artifact_name, comment)

引数

定義

artifact_type

アーティファクト・タイプ: SOURCE、TRANSFERまたはTARGET。

artifact_name

アーティファクト名。

comment

アーティファクトの説明またはアーティファクトを無効にする理由を示す文字列。

5.2.5.3 例

次の例では、order-file-srcというSOURCEアーティファクトを無効にし、その理由についてのコメントを付けます。

disableArtifact('SOURCE', 'order-file-src', 'order server being upgraded')

5.2.6 enableArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.6.1 説明

デプロイ済で以前に無効化されたソース、転送またはターゲットのアーティファクトを有効にします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.6.2 構文

enableArtifact(artifact_type, artifact_name, comment)

enAF(artifact_type, artifact_name, comment)

引数

定義

artifact_type

アーティファクト・タイプ: SOURCE、TRANSFERまたはTARGET。

artifact_name

アーティファクト名。

comment

アーティファクトの説明またはアーティファクトを有効にする理由を示す文字列。

5.2.6.3 例

次の例では、order-file-srcというSOURCEアーティファクトを有効にし、その理由についてのコメントを付けます。

enableArtifact('SOURCE', 'order-file-src', 'order server upgrade complete')

5.2.7 exportDeployedArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.7.1 説明

デプロイ済のソース、転送またはターゲットのアーティファクトをZIPファイルにエクスポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.7.2 構文

exportDeployedArtifact(artifact_type, artifact_name, label, archive_file_path)

expDepAF(artifact_type, artifact_name, label, archive_file_path)

引数

定義

artifact_type

アーティファクト・タイプ: SOURCE、TRANSFERまたはTARGET。

artifact_name

アーティファクト名。

label

MDS (メタデータ・ストア)でのアーティファクト・ラベル。

このラベルを表示するには、「デプロイメント」タブの「デプロイメントの詳細の表示」を使用します。

archive_file_path

エクスポートするZIPファイルへのフルパス。WLSTにリモート接続している場合は、ZIPファイルはリモート・サーバー上に作成されます。

5.2.7.3 例

次の例では、ラベルsoa_mft-2012-12-07 22:24:09.383の付いたorder-file-srcというSOURCEアーティファクトを/export/order-file-src.zipにエクスポートします。

exportDeployedArtifact('SOURCE', 'order-file-src', 'soa_mft-2012-12-07 22:24:09.383', '/export/order-file-src.zip')

5.2.8 isArtifactInMDS

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.8.1 説明

ソース、転送またはターゲットのアーティファクトがMDS (メタデータ・ストア)に存在するかどうかを調べてTRUEまたはFALSEを返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.8.2 構文

isArtifactInMDS(artifact_type, artifact_name)

isAFinMDS(artifact_type, artifact_name)

引数

定義

artifact_type

アーティファクト・タイプ: SOURCE、TRANSFERまたはTARGET。

artifact_name

アーティファクト名。

5.2.8.3 例

次の例では、order-file-srcというSOURCEアーティファクトがMDSに存在しているかどうかをチェックします。

isArtifactInMDS('SOURCE', 'order-file-src')

5.2.9 undeployArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.9.1 説明

ソース、転送またはターゲットのアーティファクトを、構成から削除せずにアンデプロイします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.9.2 構文

undeployArtifact(artifact_type, artifact_name, comment)

undepAF(artifact_type, artifact_name, comment)

引数

定義

artifact_type

アーティファクト・タイプ: SOURCE、TRANSFERまたはTARGET。

artifact_name

アーティファクト名。

comment

アーティファクトの説明またはアーティファクトをアンデプロイする理由を示す文字列。

5.2.9.3 例

次の例では、order-file-srcというSOURCEアーティファクトをアンデプロイし、その理由についてのコメントを付けます。

undeployArtifact('SOURCE', 'order-file-src', 'upgrading artifact')

5.3 MFTメタデータ・コマンド

メタデータ操作を実行するには、表5-3に示されたMFT WLSTメタデータ・コマンドを使用します。

表5-3 MFTメタデータWLSTコマンド

使用するコマンド

用途

使用するWLST

exportMetadataまたはexpMD

MFT構成全体(パスワードを除く)をZIPファイルにエクスポートします。

オンラインまたはオフライン

exportTransferMetadataまたはexpXfrMD

転送アーティファクトおよび関連するメタデータをZIPファイルにエクスポートします。

オンラインまたはオフライン

importMetadataまたはimpMD

エクスポート済のMFT構成をZIPファイルからインポートします。

オンラインまたはオフライン

resetMetadataまたはresMD

すべてのアーティファクトを削除し、すべての管理設定をデフォルトにリセットしてMFT構成をリセットし、オプションでユーザーのプリファレンスは保持します。

オンラインまたはオフライン

5.3.1 exportMftMetadata

コマンド・カテゴリ: MFTメタデータ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.3.1.1 説明

MFT構成全体(パスワードを除く)をZIPファイルにエクスポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.3.1.2 構文

exportMftMetadata(archive_file_path)

expMD(archive_file_path)

引数

定義

archive_file_path

エクスポートするZIPファイルへのフルパス。

5.3.1.3 例

次の例では、MFT構成を/export/mft-config-dec-2012.zipにエクスポートします。

exportMftMetadata('/export/mft-config-dec-2012.zip')

5.3.2 exportTransferMetadata

コマンド・カテゴリ: MFTメタデータ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.3.2.1 説明

転送アーティファクトおよび関連するメタデータをZIPファイルにエクスポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.3.2.2 構文

exportTransferMetadata(archive_file_path, transfer_name)

expXfrMD(archive_file_path, transfer_name)

引数

定義

archive_file_path

エクスポートするZIPファイルへのフルパス。

transfer_name

転送アーティファクト名。

5.3.2.3 例

次の例では、order-xfrという名前の転送アーティファクトとそのメタデータを/export/order-xfr.zipにエクスポートします。

exportTransferMetadata('/export/order-xfr.zip', 'order-xfr')

5.3.3 importMftMetadata

コマンド・カテゴリ: MFTメタデータ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.3.3.1 説明

エクスポート済のMFT構成をZIPファイルからインポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.3.3.2 構文

importMftMetadata(archive_file_path)

impMD(archive_file_path)

引数

定義

archive_file_path

エクスポートするZIPファイルへのフルパス。

5.3.3.3 例

次の例では、MFT構成を/export/mft-config-dec-2012.zipからインポートします。

importMftMetadata('/export/mft-config-dec-2012.zip')

5.3.4 resetMetadata

コマンド・カテゴリ: MFTメタデータ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.3.4.1 説明

すべてのアーティファクトを削除し、すべての管理設定をデフォルトにリセットしてMFT構成をリセットし、オプションでユーザーのプリファレンスは保持します。サポートされない操作の場合は、WLSTExceptionを返します。

5.3.4.2 構文

resetMetadata(preserve_preferences)

resMD(preserve_preferences)

引数

定義

preserve_preferences

TRUEの場合、ユーザーのプリファレンスを保持します。FALSEの場合、構成のリセットとともにユーザーのプリファレンスをリセットします。

5.3.4.3 例

次の例ではMFT構成をリセットしますが、ユーザーのプリファレンスは保持します。

resetMetadata('TRUE')

5.4 MFT鍵管理コマンド

MFTキーストアでSSL、SSHおよびPGPの鍵の管理を行うには、表5-4のMFT WLST鍵管理コマンドを使用します。詳細は、Oracle Managed File Transferの使用のキーストア管理に関する項を参照してください。

表5-4 MFT鍵管理WLSTコマンド

使用するコマンド

用途

使用するWLST

deleteCSFKeyまたはdelKey

鍵別名をMFTキーストアから削除します。

オンラインまたはオフライン

exportCSFKeyまたはexpKey

鍵をMFTキーストアからキー・ファイルにエクスポートします。

オンラインまたはオフライン

generateKeysまたはgenKeys

鍵を生成して1つ以上のキー・ファイルに保存します。

オンラインまたはオフライン

importCSFKeyまたはimpKey

鍵をキー・ファイルからMFTキーストアにインポートします。

オンラインまたはオフライン

listCSFKeyAliasesまたはlsKeyAliases

MFTキーストア内の鍵別名をリストします。

オンラインまたはオフライン

updateCSFKeyまたはupdKey

鍵別名をMFTキーストアから削除して新しいキー・ファイルを作成します。

オンラインまたはオフライン

5.4.1 deleteCSFKey

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.1.1 説明

鍵別名をMFTキーストアから削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.1.2 構文

deleteCSFKey(key_format, key_type, alias)

delKey(key_format, key_type, alias)

引数

定義

key_format

鍵の書式: SSHまたはPGP。

key_type

鍵の書式: PRIVATEまたはPUBLIC。

alias

鍵別名。

5.4.1.3 例

次の例では、別名my-aliasのPRIVATE SSH鍵を削除します。

deleteCSFKey('SSH', 'PRIVATE', 'my-alias')

5.4.2 exportCSFKey

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.2.1 説明

鍵をMFTキーストアからキー・ファイルにエクスポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.2.2 構文

exportCSFKey(key_format, key_type, key_file_path)

expKey(key_format, key_type, key_file_path)

引数

定義

key_format

鍵の書式: SSHまたはPGP。

key_type

鍵の書式: PRIVATEまたはPUBLIC。

key_file_path

エクスポート先のキー・ファイルへのフルパス。

5.4.2.3 例

次の例では、PRIVATE SSH鍵をファイル/export/ssh/my_private_keys.ppkにエクスポートします。

exportCSFKey('SSH', 'PRIVATE', '/export/ssh/my_private_keys.ppk')

5.4.3 generateKeys

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.3.1 説明

鍵を生成して1つ以上のキー・ファイルに保存します。鍵のタイプはRSAで、鍵のサイズは1024ビットです。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.3.2 構文

generateKeys(key_format, password, key_file_path)

genKeys(key_format, password, key_file_path)

引数

定義

key_format

鍵の書式: SSHまたはPGP。

password

秘密鍵用のオプションのパスワード。

key_file_path

生成されたキー・ファイルまたはディレクトリへのフルパス。

SSHの場合は、パスにキー・ファイル名が含まれている必要があります。

PGPの場合は、指定したパスの下に2つのファイルが生成されます。secret.ascファイルの内容はPGP秘密鍵で、pub.ascファイルの内容はPGP公開鍵です。

5.4.3.3 例

次の例では、SSH鍵をパスワード保護なしでファイル/export/ssh/ssh-pvt-keys.ppkにエクスポートします。

generateKeys('SSH', '','/export/ssh/ssh-pvt-keys.ppk')

次の例では、PGP鍵をパスワード保護なしでディレクトリ/export/pgpにエクスポートします。

generateKeys('PGP', 'P@s$W0rd','/export/pgp')

5.4.4 importCSFKey

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.4.1 説明

鍵をキー・ファイルからMFTキーストアにインポートして別名を作成します。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.4.2 構文

importCSFKey(key_format, key_type, alias, key_file_path)

impKey(key_format, key_type, alias, key_file_path)

引数

定義

key_format

鍵の書式: SSHまたはPGP。

key_type

鍵の書式: PRIVATEまたはPUBLIC。

alias

鍵別名。

key_file_path

インポート元のキー・ファイルへのフルパス。

5.4.4.3 例

次の例では、別名my-aliasのPRIVATE SSH鍵をファイル/export/ssh/my_private_keys.ppkからインポートします。

importCSFKey('SSH', 'PRIVATE', 'my-alias', '/export/ssh/my_private_keys.ppk')

次の例では、別名mftpgppubのPUBLIC PGP鍵をファイル/export/pgp/pub.ascからインポートします。

importCSFKey('PGP', 'PUBLIC', 'mftpgppub', '/export/pgp/pub.asc')

次の例では、別名mftpgppriのPRIVATE PGP鍵をファイル/export/pgp/secret.ascからインポートします。

importCSFKey('PGP', 'PRIVATE', 'mftpgppri', '/export/pgp/secret.asc')

5.4.5 listCSFKeyAliases

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.5.1 説明

MFTキーストア内の鍵別名のリストを返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.5.2 構文

listCSFKeyAliases(key_format, key_type, alias)

lsKeyAliases(key_format, key_type, alias)

引数

定義

key_format

鍵の書式: SSHまたはPGP。

key_type

鍵の書式: PRIVATEまたはPUBLIC。

5.4.5.3 例

次の例では、PRIVATE SSH鍵を一覧表示します。

listCSFKeyAliases('SSH', 'PRIVATE')

5.4.6 updateCSFKey

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.6.1 説明

鍵別名をMFTキーストアから削除して新しいキー・ファイルを作成します。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.6.2 構文

updateCSFKey(key_format, key_type, alias, key_file_path)

updKey(key_format, key_type, alias, key_file_path)

引数

説明

key_format

鍵の書式: SSHまたはPGP。

key_type

鍵の書式: PRIVATEまたはPUBLIC。

alias

鍵別名。

key_file_path

作成するキー・ファイルへのフルパス。

5.4.6.3 例

次の例では、別名my-aliasのPRIVATE SSH鍵を削除し、キー・ファイル/export/ssh/my-private-key.ppkを作成します。

updateCSFKey('SSH', 'PRIVATE', 'my-alias', '/export/ssh/my-private-key.ppk')

5.5 MFTデプロイメント履歴コマンド

ソース、転送およびターゲットのアーティファクトのデプロイメント履歴を表示するには、表5-5に示されたMFT WLSTデプロイメント履歴コマンドを使用します。

表5-5 MFTデプロイメント履歴WLSTコマンド

使用するコマンド

用途

使用するWLST

getSourceDeploymentHistoryまたはgetSrcDH

ソース・アーティファクトのデプロイメント履歴を返します。

オンラインまたはオフライン

getTargetDeploymentHistoryまたはgetTrgtDH

ターゲット・アーティファクトのデプロイメント履歴を返します。

オンラインまたはオフライン

getTransferDeploymentHistoryまたはgetXfrDH

転送アーティファクトのデプロイメント履歴を返します。

オンラインまたはオフライン

5.5.1 getSourceDeploymentHistory

コマンド・カテゴリ: MFTデプロイメント履歴コマンド

WLSTでの使用: オンラインまたはオフライン

5.5.1.1 説明

ソース・アーティファクトのデプロイメント履歴を返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.5.1.2 構文

getSourceDeploymentHistory(source_name)

getSrcDH(source_name)

引数

定義

source_name

ソース・アーティファクト名。

5.5.1.3 例

次の例では、order-file-srcという名前のソース・アーティファクトのデプロイメント履歴を返します。

getSourceDeploymentHistory('order-file-src')

5.5.2 getTargetDeploymentHistory

コマンド・カテゴリ: MFTデプロイメント履歴コマンド

WLSTでの使用: オンラインまたはオフライン

5.5.2.1 説明

ターゲット・アーティファクトのデプロイメント履歴を返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.5.2.2 構文

getTargetDeploymentHistory(target_name)

getTrgtDH(target_name)

引数

定義

target_name

ターゲット・アーティファクト名。

5.5.2.3 例

次の例では、order-file-tgtという名前のターゲット・アーティファクトのデプロイメント履歴を返します。

getTargetDeploymentHistory('order-file-tgt')

5.5.3 getTransferDeploymentHistory

コマンド・カテゴリ: MFTデプロイメント履歴コマンド

WLSTでの使用: オンラインまたはオフライン

5.5.3.1 説明

転送アーティファクトのデプロイメント履歴を返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.5.3.2 構文

getTransferDeploymentHistory(transfer_name)

getXfrDH(transfer_name)

引数

定義

transfer_name

転送アーティファクト名。

5.5.3.3 例

次の例では、order-xfrという名前の転送アーティファクトのデプロイメント履歴を返します。

getTransferDeploymentHistory('order-xfr')

5.6 MFT転送管理コマンド

転送インスタンスを管理するには、表5-6に示されたMFT WLST転送管理コマンドを使用します。

表5-6 MFT転送管理WLSTコマンド

使用するコマンド

用途

使用するWLST

getTransferInfoまたはgetXfrInfo

転送アーティファクトに関する情報を返します。

オンラインまたはオフライン

pauseTransferまたはpauseXfr

進行中の転送を一時停止します。

オンラインまたはオフライン

resubmitまたはresub

失敗した転送を再発行します。

オンラインまたはオフライン

resumeTransferまたはresXfr

一時停止している転送を再開します。

オンラインまたはオフライン

5.6.1 getTransferInfo

コマンド・カテゴリ: MFT転送管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.6.1.1 説明

転送アーティファクトに関する情報を返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.6.1.2 構文

getTransferInfo(transfer_name, label)

getXfrInfo(transfer_name, label)

引数

定義

transfer_name

転送アーティファクト名。

label

MDS (メタデータ・ストア)でのアーティファクト・ラベル。

このラベルを表示するには、「デプロイメント」タブの「デプロイメントの詳細の表示」を使用します。

5.6.1.3 例

次の例では、ラベルsoa_mft-2012-12-07 22:28:17.392の付いたorder-xfrという名前の転送アーティファクトについての情報が返されます。

getTransferInfo('order-xfr', 'soa_mft-2013-09-26 22:28:17.392')
ID                                        | NAME          | LABEL
xfer_521a6788-4e24-4822-bb03-43a4a8eaa8ce | ftp-file-xfer | soa_mft-2013-09-26 16:00:09.803

5.6.2 pauseTransfer

コマンド・カテゴリ: MFT転送管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.6.2.1 説明

進行中の転送を一時停止します。サポートされない操作の場合は、WLSTExceptionを返します。

5.6.2.2 構文

pauseTransfer(instance_id, comment)

pauseXfr(instance_id, comment)

引数

定義

instance_id

転送用のターゲット・インスタンスID。

ターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。ターゲット・レポートの詳細は、Oracle Managed File Transferの使用のソース、転送およびターゲットのレポートの解釈に関する項を参照してください。

comment

一時停止の理由を説明する文字列。

5.6.2.3 例

次の例では、ターゲット・インスタンスID 240C93AD-5401-483B-8182-274FA0705DF1の転送を一時停止し、その理由を示します。

pauseTransfer('240C93AD-5401-483B-8182-274FA0705DF1', 'resume when less network traffic')

5.6.3 resubmit

コマンド・カテゴリ: MFT転送管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.6.3.1 説明

転送を再送信します。成功または失敗した転送を再送信できます。サポートされない操作の場合は、WLSTExceptionを返します。

5.6.3.2 構文

resubmit(resubmit_type, instance_ids, comment)

resub(resubmit_type, instance_ids, comment)

引数

定義

resubmit_type

再送信のタイプ: SOURCE、TRANSFER_INSTANCE、TARGETまたはTARGET_INSTANCE。

TARGETでは、ファイルは前処理なしで配信されます。TARGET_INSTANCEでは、配信前に任意の処理が呼び出されます。

instance_ids

カンマ区切りのインスタンスID。

ソース、転送またはターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。これらのレポートの詳細は、Oracle Managed File Transferの使用のソース、転送およびターゲットのレポートの解釈に関する項を参照してください。

comment

再送信の理由を説明する文字列。

5.6.3.3 例

次の例では、インスタンスID 3D48B12B-295A-4F52-A8EE-BD1CC1A20246のSOURCEを再送信し、その理由を示します。

resubmit('SOURCE', '3D48B12B-295A-4F52-A8EE-BD1CC1A20246', 'trying again')

5.6.4 resumeTransfer

コマンド・カテゴリ: MFT転送管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.6.4.1 説明

一時停止している転送を再開します。サポートされない操作の場合は、WLSTExceptionを返します。

5.6.4.2 構文

resumeTransfer(instance_id, comment)

resXfr(instance_id, comment)

引数

定義

instance_id

転送用のターゲット・インスタンスID。

ターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。ターゲット・レポートの詳細は、Oracle Managed File Transferの使用のソース、転送およびターゲットのレポートの解釈に関する項を参照してください。

comment

再開の理由を説明する文字列。

5.6.4.3 例

次の例では、ターゲット・インスタンスID 240C93AD-5401-483B-8182-274FA0705DF1の転送を再開し、その理由を示します。

resumeTransfer('240C93AD-5401-483B-8182-274FA0705DF1', 'less network traffic now')

5.7 MFT埋込みサーバー・コマンド

埋込みFTPおよびsFTPサーバーを管理するには、表5-7に示されたMFT WLST埋込みサーバー・コマンドを使用します。

表5-7 MFT埋込みサーバーWLSTコマンド

使用するコマンド

用途

使用するWLST

ConfigureHomeDirまたはconfHmDir

埋込みサーバーにホーム・ディレクトリを割り当てます。

オンラインまたはオフライン

grantPermissionToDirectoryまたはgrPermDir

埋込みサーバー・ディレクトリに対する権限を付与します。

オンラインまたはオフライン

listAllPermissionsまたはlsPerms

指定されたプリンシパルとサーバー・タイプに使用できるすべての権限のリストを返します。

オンラインまたはオフライン

revokePermissionForDirectoryまたはrevPermDir

埋込みサーバー・ディレクトリの権限を取り消します。

オンラインまたはオフライン

startEmbeddedServerまたはstartES

停止された埋込みFTPまたはsFTPサーバーを起動します。

オンラインまたはオフライン

stopEmbeddedServerまたはstopES

実行している埋込みFTPまたはsFTPサーバーを停止します。

オンラインまたはオフライン

updatePortsまたはupdPorts

埋込みFTPまたはsFTPサーバーのポートを更新します。

オンラインまたはオフライン

5.7.1 ConfigureHomeDir

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.1.1 説明

指定されたディレクトリをホーム・ディレクトリとしてユーザーに割り当てます。そのユーザーが埋込みサーバーにログインしたときの作業ディレクトリとなります。

5.7.1.2 構文

configureHomeDir(directory_path, user_name)

引数

定義

directory_path

埋込みサーバーのルートから開始する任意の有効なパス。

user_name

WebLogicユーザーID

5.7.1.3 例

次の例では、ディレクトリdir1を"user1"という名前のユーザーのホーム・ディレクトリとして割り当てます。

configureHomeDir("/dir1","user1")

5.7.2 grantPermissionToDirectory

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.2.1 説明

埋込みサーバー・ディレクトリに対する権限を付与します。埋込みサーバー上の既存のディレクトリに対する権限のセットをユーザーやグループに割り当てることができます。

5.7.2.2 構文

grantPermissionToDirectory(directory_path, principal_name, principal_type, permissions, server_type, include_subfolder)

引数

定義

directory_path

埋込みサーバーのルートから開始する任意の有効なパス

principal_name

エンタープライズ・ユーザー、グループまたはアプリケーション・ロールの名前。

principal_type

次のうちの1つ。

- USER

- GROUP

- APPLICATION_ROLE

permissions

次の権限のカンマ区切りのリスト

- READ

- WRITE

- LIST

- DELETE

server_type

FTPまたはSFTP

include_subfolder

trueまたはfalse

5.7.2.3 例

次の例では、FTPサーバーのユーザー"weblogic"に対して、ディレクトリ/orders (およびサブディレクトリ)への読取り、書込み、リストおよび削除権限を割り当てます。

grantPermissionToDirectory("/orders","weblogic","USER", "READ, WRITE, LIST, DELETE","FTP",true)

5.7.3 listAllPermissions

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.3.1 説明

指定されたプリンシパルとサーバー・タイプに使用できるすべての権限のリストを返します。サーバー・タイプはFTPまたはSFTPです。

5.7.3.2 構文

listAllPermissions(principal_name,server_type)

引数

定義

principal_name

エンタープライズ・ユーザー、グループまたはアプリケーション・ロールの名前。

server_type

FTPまたはSFTP

5.7.3.3 例

次の例では、FTPサーバーの"weblogic"というプリンシパルに対するすべての権限をリストします。

listAllPermissions("weblogic","FTP"

5.7.4 revokePermissionForDirectory

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.4.1 説明

埋込みサーバー・ディレクトリに対する権限のセットを取り消します。

5.7.4.2 構文

revokePermissionForDirectory(directory_path, principal_name, principal_type, permissions, server_type, include_subfolder)

引数

定義

directory_path

埋込みサーバーのルートから開始する任意の有効なパス

principal_name

エンタープライズ・ユーザー、グループまたはアプリケーション・ロールの名前。

principal_type

次のうちの1つ。

- USER

- GROUP

- APPLICATION_ROLE

permissions

次の権限のカンマ区切りのリスト

- READ

- WRITE

- LIST

- DELETE

server_type

FTPまたはSFTP

include_subfolder

trueまたはfalse

5.7.4.3 例

次の例では、FTPサーバーのユーザー"weblogic"に対して、ディレクトリ/orders (およびサブディレクトリ)からの読取り、書込み、リストおよび削除権限を取り消します。

grantPermissionToDirectory("/orders","weblogic","USER", "READ, WRITE, LIST, DELETE","FTP",true)

5.7.5 startEmbeddedServer

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.5.1 説明

停止している埋込みFTP、FTPS (FTP over SSL)またはsFTP (SSH-FTP)サーバーを起動します。サポートされない操作の場合は、WLSTExceptionを返します。

5.7.5.2 構文

startEmbeddedServer(server_type)

startES(server_type)

引数

定義

server_type

埋込みサーバーのタイプ: FTP、FTPSまたはSFTP。

5.7.5.3 例

次の例では、埋込みFTPサーバーを起動します。

startEmbeddedServer('FTP')

5.7.6 stopEmbeddedServer

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.6.1 説明

実行中の埋込みFTP、FTPS (FTP over SSL)またはsFTP (SSH-FTP)サーバーを停止します。サポートされない操作の場合は、WLSTExceptionを返します。

5.7.6.2 構文

stopEmbeddedServer(server_type)

stopES(server_type)

引数

定義

server_type

埋込みサーバーのタイプ: FTP、FTPSまたはSFTP。

5.7.6.3 例

次の例では、埋込みFTPサーバーを停止します。

stopEmbeddedServer('FTP')

5.7.7 updatePorts

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.7.1 説明

埋込みFTP、FTPS (FTP over SSL)またはsFTP (SSH-FTP)サーバーのポートを更新します。埋込みサーバーは、MFT専用のOracle WebLogic Server管理対象サーバーのサービスの1つです。サポートされない操作の場合は、WLSTExceptionを返します。

5.7.7.2 構文

updatePorts(server_instance, service, port)

updPorts(server_instance, service, port)

引数

定義

server_instance

MFT専用のOracle WebLogic Server管理対象サーバーの名前。

service

サービス(埋込みサーバーのタイプ): FTP、FTPSまたはSFTP。

port

ポート番号。

5.7.7.3 例

次の例では、埋込みFTPサーバーのポートを更新します。

updatePorts('mft_server1', 'FTP', 7021)

5.8 MFTコールアウト・コマンド

カスタム・コールアウトを管理するには、表5-8に示されたMFT WLSTコールアウト・コマンドを使用します。

表5-8 MFTコールアウトWLSTコマンド

使用するコマンド

用途

使用するWLST

createCalloutsまたはcrtCalls

コールアウトを定義するXMLファイルに基づいてコールアウトを作成します。

オンラインまたはオフライン

deleteCalloutまたはdelCalls

コールアウトを削除します。

オンラインまたはオフライン

listCalloutsまたはlsCalls

コールアウトのリストを返します。

オンラインまたはオフライン

updateCalloutsまたはupdCalls

コールアウトを定義するXMLファイルに基づいて、同じ名前のコールアウトを更新します。

オンラインまたはオフライン

5.8.1 createCallouts

コマンド・カテゴリ: MFTコールアウト・コマンド

WLSTでの使用: オンラインまたはオフライン

5.8.1.1 説明

コールアウトを定義するXMLファイルに基づいてコールアウトを作成します。サポートされない操作の場合は、WLSTExceptionを返します。

コールアウトの説明および例は、Oracle Managed File Transferの使用のカスタム・コールアウトでの転送の処理に関する項を参照してください。

5.8.1.2 構文

createCallouts(def_file_path)

crtCalls(def_file_path)

引数

定義

def_file_path

コールアウト定義XMLファイルへのフルパス。

5.8.1.3 例

次の例では、/tmp/CalloutDefn.xmlという名前の定義ファイルに基づいてコールアウトを作成します。

createCallouts('/tmp/CalloutDefn.xml')

5.8.2 deleteCallout

コマンド・カテゴリ: MFTコールアウト・コマンド

WLSTでの使用: オンラインまたはオフライン

5.8.2.1 説明

コールアウトを削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.8.2.2 構文

deleteCallout(callout_name)

delCalls(callout_name)

引数

定義

callout_name

コールアウト名。

5.8.2.3 例

次の例では、NotifyTransferCompleteという名前のコールアウトを削除します。

deleteCallout('NotifyTransferComplete')

5.8.3 listCallouts

コマンド・カテゴリ: MFTコールアウト・コマンド

WLSTでの使用: オンラインまたはオフライン

5.8.3.1 説明

コールアウトのリストを返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.8.3.2 構文

listCallouts()

lsCalls()

5.8.3.3 例

次の例では、コールアウトをリストします。

listCallouts()

5.8.4 updateCallouts

コマンド・カテゴリ: MFTコールアウト・コマンド

WLSTでの使用: オンラインまたはオフライン

5.8.4.1 説明

コールアウトを定義するXMLファイルに基づいて、同じ名前のコールアウトを更新します。サポートされない操作の場合は、WLSTExceptionを返します。

注意:

既存のコールアウトのパラメータは追加、削除または変更できません。

5.8.4.2 構文

updateCallouts(def_file_path)

updCalls(def_file_path)

引数

定義

def_file_path

コールアウト定義XMLファイルへのフルパス。

5.8.4.3 例

次の例では、/tmp/CalloutDefn.xmlという名前の定義ファイルに基づいてコールアウトを更新します。

updateCallouts('/tmp/CalloutDefn.xml')

5.9 MFTイベント通知コマンド

イベントの連絡先通知を管理するには、表5-9に示されたMFT WLSTイベント通知コマンドを使用します。

表5-9 MFT連絡先WLSTコマンド

使用するコマンド

用途

使用するWLST

addContactToNotificationまたはaddContNote

特定のイベント通知に連絡先を追加します。

オンラインまたはオフライン

createContactまたはCrtCont

イベント通知の連絡先を作成します。

オンラインまたはオフライン

deleteContactまたはdelCont

連絡先を削除します。

オンラインまたはオフライン

listContactsまたはlsConts

連絡先のリストを返します。

オンラインまたはオフライン

removeContactFromNotificationまたはremContNote

特定のイベント通知から連絡先を削除します。

オンラインまたはオフライン

updateEventまたはupdEvt

特定のイベント通知を有効または無効にします。

オンラインまたはオフライン

5.9.1 addContactToNotification

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.1.1 説明

特定のイベント通知に連絡先を追加します。サポートされない操作の場合は、WLSTExceptionを返します。

5.9.1.2 構文

addContactToNotification(event, contact_type, value)

addContNote(event, contact_type, value)

引数

定義

event

イベント: RUNTIME_ERROR_EVENT、DELETE_ARTIFACT_EVENT、DEPLOY_ARTIFACT_EVENT、EXPORT_IMPORT_EVENT、PURGE_EVENTまたはARCHIVE_RESTORE_EVENT。

contact_type

連絡先タイプ EMAIL、PHONE、FAXまたはSMS。

value

電子メール・アドレスまたは電話番号。

5.9.1.3 例

次の例では、EMAIL連絡先jane.doe@example.comをRUNTIME_ERROR_EVENT通知に追加します。

addContactToNotification('RUNTIME_ERROR_EVENT', 'EMAIL', 'jane.doe@example.com')

5.9.2 createContact

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.2.1 説明

イベント通知の連絡先を作成します。サポートされない操作の場合は、WLSTExceptionを返します。

電子メール・ドライバの構成方法の詳細は、Oracle Managed File Transferの使用の通知のための電子メール・ドライバの構成に関する項を参照してください。SMSドライバの構成方法の詳細は、Oracle Managed File Transferの使用の通知のためのSMSドライバの構成に関する項を参照してください。

注意:

電話およびFAXの通知は、このリリースのOracle Managed File Transferではサポートされていません。

5.9.2.2 構文

createContact(contact_type, value)

crtCont(contact_type, value)

引数

定義

contact_type

連絡先タイプ EMAIL、PHONE、FAXまたはSMS。

value

電子メール・アドレスまたは電話番号。

5.9.2.3 例

次の例では、電子メール・アドレスjane.doe@example.comに基づいて連絡先を作成します。

createContact('EMAIL', 'jane.doe@example.com')

5.9.3 deleteContact

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.3.1 説明

連絡先を削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.9.3.2 構文

deleteContact(contact_type, value)

delCont(contact_type, value)

引数

定義

contact_type

連絡先タイプ EMAIL、PHONE、FAXまたはSMS。

value

電子メール・アドレスまたは電話番号。

5.9.3.3 例

次の例では、電子メール・アドレスjane.doe@example.comに基づいて連絡先を削除します。

deleteContact('EMAIL', 'jane.doe@example.com')

5.9.4 listContacts

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.4.1 説明

連絡先のリストを返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.9.4.2 構文

listContacts(contact_type)

lsConts(contact_type)

引数

定義

contact_type

連絡先タイプ EMAIL、PHONE、FAXまたはSMS。

5.9.4.3 例

次の例では、電子メール連絡先をリストします。

listContacts('EMAIL')

5.9.5 removeContactFromNotification

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.5.1 説明

特定のイベント通知から連絡先を削除します。サポートされない操作の場合は、WLSTExceptionを返します。

イベントから最後の連絡先を削除すると、イベントは無効にされます。ただし、その逆はありません。イベントに最初の連絡先を追加する際、イベントは自動的に有効にされません。イベントは、updateEventコマンドを使用して有効にしてください。

5.9.5.2 構文

removeContactFromNotification(event, contact_type, value)

remContNote(event, contact_type, value)

引数

定義

event

イベント: RUNTIME_ERROR_EVENT、DELETE_ARTIFACT_EVENT、DEPLOY_ARTIFACT_EVENTまたはEXPORT_IMPORT_EVENT。

contact_type

連絡先タイプ EMAIL、PHONE、FAXまたはSMS。

value

電子メール・アドレスまたは電話番号。

5.9.5.3 例

次の例では、EMAIL連絡先jane.doe@example.comをRUNTIME_ERROR_EVENT通知から削除します。

removeContactFromNotification('RUNTIME_ERROR_EVENT', 'EMAIL', 'jane.doe@example.com')

5.9.6 updateEvent

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.6.1 説明

特定のイベント通知を有効または無効にします。イベント通知はデフォルトで無効にされています。サポートされない操作の場合は、WLSTExceptionを返します。

5.9.6.2 構文

updateEvent(event, enabled)

updEvt(event, enabled)

引数

定義

event

イベント: RUNTIME_ERROR_EVENT、DELETE_ARTIFACT_EVENT、DEPLOY_ARTIFACT_EVENTまたはEXPORT_IMPORT_EVENT。

enabled

有効化: TRUEまたはFALSE。

5.9.6.3 例

次の例では、DELETE_ARTIFACT_EVENT通知を無効にします。

updateEvent('DELETE_ARTIFACT_EVENT', 'FALSE')

5.10 MFTアーカイブおよび復元コマンド

ステータスや日付範囲などの基準に基づいてランタイム・インスタンスまたはファイル・システム・データをアーカイブおよび復元するには、表5-10に示されたMFTアーカイブおよび復元コマンドを使用します。

表5-10 MFTアーカイブおよび復元WLSTコマンド

使用するコマンド

用途

使用するWLST

archiveInstanceDataまたはarcData

指定された基準に基づいてランタイム・インスタンスをアーカイブします。

オンラインまたはオフライン

restoreInstanceDataまたはresData

アーカイブ済のランタイム・インスタンスを復元します。

オンラインまたはオフライン

archivePayloadsまたはarcPLs

指定された基準に基づいてランタイム・インスタンス・データに対応するファイル・システム・データをアーカイブします。

オンラインまたはオフライン

restorePayloadsByNameまたはresPLbyN

以前にアーカイブされたファイル・システム・データをzipファイル名で復元します。

オンラインまたはオフライン

restorePayloadsByPrefixまたはresPLbyP

以前にアーカイブされたファイル・システム・データをzipファイル名接頭辞で復元します。

オンラインまたはオフライン

5.10.1 archiveInstanceData

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.1.1 説明

指定された基準に基づいてランタイム・インスタンスをアーカイブします。オプションで、ファイル・システム・データをアーカイブします。サポートされない操作の場合は、WLSTExceptionを返します。

このコマンドを実行する前に、次のSQLコマンドを使用して、データベース・サーバーにMFTアーカイブ・ディレクトリを作成する必要があります。

CREATE DIRECTORY MFT_DIR AS path;
GRANT READ, WRITE ON DIRECTORY MFT_DIR TO MFT_STB;

データベースおよびスキーマ所有者(MFT_STB)の詳細は、Managed File Transferのインストールと構成を参照してください。

5.10.1.2 構文

archiveInstanceData(arguments)

arcData(arguments)

引数

定義

archiveFileName

定義済のMFTアーカイブ・ディレクトリに保存されるランタイム・インスタンス・アーカイブ・ファイルの名前。デフォルトの拡張子は、.dmpです。これは必須の引数です。

startDate

形式dd-MM-yyyy H:m:s:Sのタイムスタンプ。デフォルトでは日付および時間は指定されていません。式はサポートされていません。

endDate

形式dd-MM-yyyy H:m:s:Sのタイムスタンプ。デフォルトは現在の日時です。式はサポートされていません。

batchId

前のarchiveInstanceDataコマンドの出力の中にある識別子です。デフォルトの入力は空文字列です。テスト済または失敗したarchiveInstanceDataを失敗の時点から再実行するか、archivePayloadsを実行するために使用します。

status

ステータス: すべてのステータスには*、COMPLETEDにはC、FAILEDにはF、ACTIVE (進行中)にはA。デフォルトはCです。複数のカンマ区切りのステータスを指定できます。

testMode

アーカイブすべきものをテストしますが、アーカイブはしません。TRUEまたはFALSE。デフォルトはTRUEです。そのため、ランタイム・インスタンスを実際にアーカイブするには、明示的にtestMode=FALSEに設定する必要があります。

comments

コメント文字列。デフォルトは空の文字列です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

fsArchiveFolderPath

ペイロード・アーカイブ.zipファイルが保存されるフォルダへのパス。デフォルトは空文字列で、これはペイロードが何もアーカイブされないことを意味します。これは、ランタイム・インスタンス・アーカイブ・ファイルおよびMFTアーカイブ・ディレクトリからは独立しています。

5.10.1.3 例

次の例では、テスト・モード(何もアーカイブしない)で、ステータスがCOMPLETEDのすべてのインスタンスに対してバックグラウンド(実行中、WLSTコマンドをブロックしない)で実行し、インスタンスまたはペイロードがいくつアーカイブされるかなどの統計を提供します。

archiveInstanceData()

出力の例は次のとおりです。

Total no. of instances to be archived: 105.
Total no. of payloads to be archived: 105.
Nothing has been archived as test mode was TRUE.
To archive these records, run the same command
by passing batch id 546781 and test mode as FALSE.

次の例では、2013年3月31日よりも前で、ステータスがCOMPLETEDのインスタンスに対してバックグラウンドでテスト・モードで実行し、アーカイブ統計を提供します。startDate引数が省略された場合、endDate引数に明示的にラベルを付ける必要があります。

archiveInstanceData(endDate='31-03-2013 00:00:00:00')

次の例では、ステータスがCOMPLETEDの2013年2月1日から2013年3月31日までのインスタンスをファイルmft.dmpにアーカイブし、アーカイブ統計を提供します。startDateおよびendDate引数の両方が含まれる場合、ラベルは省略できます。

archiveInstanceData(archiveFileName='mft.dmp','01-02-2013 00:00:00:00', '31-03-2013 00:00:00:00', testMode='FALSE')

次の例では、ステータスがACTIVEまたはFAILEDの2013年2月1日から2013年3月31日までのインスタンスをファイルmft.dmpにアーカイブし、アーカイブ統計を提供します。runInSync='TRUE'が指定されるため、アーカイブがただちに発生し、完了するまでそれ以降のWLSTコマンドをブロックします。runFSArchive='TRUE'が指定されるため、ファイル・システム・データもアーカイブされます。

archiveInstanceData(archiveFileName='mft.dmp','01-02-2013 00:00:00:00', '31-03-2013 00:00:00:00', testMode='FALSE', status='A,F',
runInSync='TRUE', fsArchiveFolderPath='2013-01-02-MftArchive')

次の例では、バッチID 546781のテスト済の失敗したアーカイブを、失敗の場所から実行します。

archiveInstanceData(archiveFileName='mft2.dmp',batchId='546781', testMode='FALSE')

5.10.2 restoreInstanceData

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.2.1 説明

アーカイブ済のランタイム・インスタンスを復元します。サポートされない操作の場合は、WLSTExceptionを返します。

5.10.2.2 構文

restoreInstanceData(arguments)

resData(arguments)

引数

定義

archiveFilePath

復元するMFTアーカイブ・ディレクトリにあるアーカイブ・ファイルの名前。このディレクトリの定義方法は、「archiveInstanceData」を参照してください。デフォルトの拡張子は、.dmpです。これは必須の引数です。

fileNamePrefix

対応するペイロード・アーカイブ・ファイルのファイル名接頭辞を識別する文字列で、通常はバッチIDです。archiveInstanceDataバッチIDのarchivePayloadsを先に実行させる必要があります。デフォルト値はありません。

fsFolderPath

対応するペイロード・アーカイブ・ファイルが格納されるディレクトリへのパスを識別する文字列です。デフォルト値はありません。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.10.2.3 例

次の例では、以前にarchiveInstanceDataコマンドによってアーカイブされたランタイム・インスタンス・データを復元します。対応するペイロード・アーカイブは/tmp/mft/546781.zipから復元されます。このコマンドは、バックグラウンドで実行します。

restoreInstanceData(archiveFilePath="mft_runtime_archive.dmp", fileNamePrefix="546781", fsFolderPath="/tmp/mft")

5.10.3 archivePayloads

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.3.1 説明

指定された基準に基づいてランタイム・インスタンス・データに対応するファイル・システム・データをアーカイブします。サポートされない操作の場合は、WLSTExceptionを返します。

5.10.3.2 構文

archivePayloads(arguments)

arcPLs(arguments)

引数

定義

batchId

アーカイブ基準を識別する文字列。デフォルト値はありません。先にarchiveInstanceDataを実行してbatchIdを取得します。これは必須の引数です。

archivePath

batchId.zipアーカイブが保存されるディレクトリへのパス。このディレクトリは存在している必要があります。大規模なアーカイブをbatchId_n.zipという名前の複数のファイルに保存できます。これは必須の引数です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.10.3.3 MBeanプロパティ

Enterprise Managerを使用してMBeanを設定する方法の詳細は、「MFT WLSTコマンドに対するシステムMBeanプロパティの設定」を参照してください。

プロパティ

定義

FS_ARCHIVE_MAX_SIZE

アーカイブzipファイルのサイズ制限をMBで設定する文字列。デフォルト値はゼロで、無制限を設定します。

FS_ARCHIVE_MAX_FILES_PER_ZIP

アーカイブzipファイルに含めることができるファイル数の制限を設定する文字列。デフォルト値はゼロで、無制限を設定します。

5.10.3.4 例

次の例では、以前にarchiveInstanceDataコマンドによってアーカイブされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データをアーカイブします。アーカイブは/tmp/mft/546781.zipに保存され、ただちに実行されます。

archivePayloads(batchId='546781',archivePath='/tmp/mft',runInSync='TRUE')

5.10.4 restorePayloadsByName

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.4.1 説明

以前にアーカイブされたファイル・システム・データを復元します。サポートされない操作の場合は、WLSTExceptionを返します。

5.10.4.2 構文

restorePayloadsByName(arguments)

resPLbyN(arguments)

引数

定義

fileNames

復元する.zipファイルの名前を識別する文字列。デフォルト値はありません。これは必須の引数です。

.zipファイルの名前がバッチID以外の名前に変更されている場合、この引数のバッチIDのかわりに新しいファイル名を指定する必要があります。

複数のbatchId_n.zipまたはprefix_n.zipファイルで構成されるアーカイブには、かわりにrestorePayloadsByPrefixコマンドを使用できます。

folderPath

.zipアーカイブが保存されたディレクトリへのパス。これは必須の引数です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.10.4.3 MBeanプロパティ

Enterprise Managerを使用してMBeanを設定する方法の詳細は、「MFT WLSTコマンドに対するシステムMBeanプロパティの設定」を参照してください。

プロパティ

定義

FS_RESTORE_OVERWRITE_EXISTING

復元で同じ名前のファイルを上書きするかどうかを決定する文字列。デフォルト値はTRUEです。

5.10.4.4 例

次の例では、以前にarchivePayloadsコマンドによってアーカイブされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データを復元します。アーカイブは/tmp/mft/546781.zipから復元され、ただちに実行されます。

restorePayloadsByName(fileNames='546781',folderPath='/tmp/mft',runInSync='TRUE')

5.10.5 restorePayloadsByPrefix

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.5.1 説明

以前にアーカイブされたファイル・システム・データを復元します。サポートされない操作の場合は、WLSTExceptionを返します。

5.10.5.2 構文

restorePayloadsByPrefix(arguments)

resPLbyP(arguments)

引数

定義

fileNamePrefix

復元する.zipファイルを識別する文字列で、通常はバッチIDです。デフォルト値はありません。先にarchivePayloadsを実行してbatchIdを取得します。これは必須の引数です。

.zipファイルの名前がバッチID以外の名前に変更されている場合、この引数のバッチIDのかわりに新しいファイル名を指定する必要があります。

1つのprefix_n.zipファイルの名前を変更した場合、_n部分を変更せずに、すべの名前を変更する必要があり、そうしない場合にはこのコマンドはアーカイブ全体を復元しません。

folderPath

.zipアーカイブが保存されたディレクトリへのパス。これは必須の引数です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.10.5.3 MBeanプロパティ

Enterprise Managerを使用してMBeanを設定する方法の詳細は、「MFT WLSTコマンドに対するシステムMBeanプロパティの設定」を参照してください。

プロパティ

定義

FS_RESTORE_OVERWRITE_EXISTING

復元で同じ名前のファイルを上書きするかどうかを決定する文字列。デフォルト値はTRUEです。

5.10.5.4 例

次の例では、以前にarchivePayloadsコマンドによってアーカイブされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データを復元します。アーカイブは/tmp/mft/546781.zipから復元され、ただちに実行されます。

restorePayloadsByPrefix(fileNamePrefix='546781',folderPath='/tmp/mft',runInSync='TRUE')

5.11 MFTパージ・コマンド

ステータスや日付範囲などの基準に基づいてランタイム・インスタンスまたはファイル・システム・データをパージするには、表5-11に示されたMFTパージ・コマンドを使用します。

表5-11 MFTパージWLSTコマンド

使用するコマンド

用途

使用するWLST

purgeInstanceDataまたはprgData

指定された基準に基づいてランタイム・インスタンスをパージします。オプションで、ファイル・システム・データをパージします。

オンラインまたはオフライン

purgePayloadsまたはprgPLs

指定された基準に基づいてランタイム・インスタンス・データに対応するファイル・システム・データをパージします。

オンラインまたはオフライン

5.11.1 purgeInstanceData

コマンド・カテゴリ: MFTパージ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.11.1.1 説明

指定された基準に基づいてランタイム・インスタンスをパージします。オプションで、ファイル・システム・データをパージします。サポートされない操作の場合は、WLSTExceptionを返します。

5.11.1.2 構文

purgeInstanceData(optional_arguments)

prgData(optional_arguments)

引数

定義

startDate

形式dd-MM-yyyy H:m:s:Sのタイムスタンプ。デフォルトでは日付および時間は指定されていません。式はサポートされていません。

endDate

形式dd-MM-yyyy H:m:s:Sのタイムスタンプ。デフォルトは現在の日時です。式はサポートされていません。

batchId

前のpurgeInstanceDataコマンドの出力の中にある識別子です。デフォルトの入力は空文字列です。テスト済または失敗したpurgeInstanceDataを失敗の時点から再実行するか、purgePayloadsを実行するために使用します。

status

ステータス: すべてのステータスには*、COMPLETEDにはC、FAILEDにはF、ACTIVE (進行中)にはA。デフォルトはCです。複数のカンマ区切りのステータスを指定できます。

testMode

パージすべきものをテストしますが、パージはしません。TRUEまたはFALSE。デフォルトはTRUEです。そのため、ランタイム・インスタンスを実際にパージするには、明示的にtestMode=FALSEに設定する必要があります。

comments

コメント文字列。デフォルトは空の文字列です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

runPayloadPurge

ランタイム・インスタンス・データに対応するファイル・システム・データもパージします。TRUEまたはFALSE。デフォルトはFALSEです。ファイル・システム・データを個別にパージするには、purgePayloadsを使用します。

5.11.1.3 例

次の例では、テスト・モード(何もパージしない)で、ステータスがCOMPLETEDのすべてのインスタンスに対してバックグラウンド(実行中、WLSTコマンドをブロックしない)で実行し、インスタンスまたはペイロードがいくつパージされるかなどの統計を提供します。

purgeInstanceData()

出力の例は次のとおりです。

Total no. of purgeable instances: 105.
Total no. of purgeable payloads: 105.
Nothing has been purged as test_mode was TRUE.
To purge these records, run the same command
by passing batchId 546781 and test mode as FALSE.

次の例では、テスト・モードで、ステータスがCOMPLETEDの2013年5月31日よりも前のインスタンスに対してバックグラウンドで実行し、パージ統計を提供します。startDate引数が省略された場合、endDate引数に明示的にラベルを付ける必要があります。

purgeInstanceData(endDate='31-03-2013 00:00:00:00')

次の例では、ステータスがCOMPLETEDの2013年2月1日から2013年3月31日までのインスタンスをパージし、パージ統計を提供します。startDateおよびendDate引数の両方が含まれる場合、ラベルは省略できます。

purgeInstanceData('01-02-2013 00:00:00:00', '31-03-2013 00:00:00:00', testMode='FALSE')

次の例では、ステータスがACTIVEまたはFAILEDの2013年2月1日から2013年3月31日までのインスタンスをパージし、パージ統計を提供します。runInSync='TRUE'が指定されるため、パージがただちに発生し、完了するまでそれ以降のWLSTコマンドをブロックします。runPayloadPurge='TRUE'が指定されるため、ファイル・システム・データもパージされます。

purgeInstanceData('01-02-2013 00:00:00:00', '31-03-2013 00:00:00:00', testMode='FALSE', status='A,F', runInSync='TRUE',
runPayloadPurge='TRUE')

次の例では、バッチID 546781のテスト済の失敗したパージを、失敗の場所から実行します。

purgeInstanceData(batchId='546781', testMode='FALSE')

5.11.2 purgePayloads

コマンド・カテゴリ: MFTパージ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.11.2.1 説明

指定された基準に基づいてランタイム・インスタンス・データに対応するファイル・システム・データをパージします。サポートされない操作の場合は、WLSTExceptionを返します。

5.11.2.2 構文

purgePayloads(arguments)

prgPLs(arguments)

引数

定義

batchId

パージ基準を識別する文字列。デフォルト値はありません。先にpurgeInstanceDataを実行してbatchIdを取得します。

detailedAudit

各パージ済ファイルの監査するかどうかです。TRUEまたはFALSE。デフォルトはTRUEです。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.11.2.3 MBeanプロパティ

Enterprise Managerを使用してMBeanを設定する方法の詳細は、「MFT WLSTコマンドに対するシステムMBeanプロパティの設定」を参照してください。

プロパティ

定義

FS_PURGE_BATCH_SIZE

ペイロード・パスを読み取るためのバッチ・サイズを決定する文字列。purgePayloadsコマンドは、メモリー不足を防ぐため、データベースからペイロード・パスを数回に分けて読み取ります。デフォルト値は、5000です。

FS_PURGE_TEMP_TABLES_LIFE

ペイロード・パージの後に削除される一時表の最小経過時間を日数で決定する文字列。デフォルト値は30です。

FS_PURGE_THREAD_COUNT

ペイロード・パージの実行に使用されるノードごとのスレッド数を決定する文字列。デフォルト値は1です。

5.11.2.4 例

次の例では、以前にpurgeInstanceDataコマンドによってパージされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データをパージします。パージされたファイルの詳細な監査が行われ、このパージはバックグラウンドで実行します。

purgePayloads(batchId='546781')

次の例では、以前にpurgeInstanceDataコマンドによってパージされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データをパージします。パージされたファイルの詳細な監査は行われず、パージはバックグラウンドで実行します。

purgePayloads(batchId='546781', detailedAudit='FALSE')

次の例では、以前にpurgeInstanceDataコマンドによってパージされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データをパージします。パージされたファイルの詳細な監査が行われ、パージはただちに発生します。

purgePayloads(batchId='546781', detailedAudit='TRUE', runInSync='TRUE')

5.12 MFT WLSTコマンドのシステムMBeanプロパティの設定

一部のMFT WLSTコマンドには、実行する操作を調整するために設定できる関連プロパティがあります。

このプロセスの手順は次のとおりです。

1. Oracle Enterprise Managerコンソールにログインします。

2. ターゲット・ナビゲーション・ペインで、「WebLogicドメイン」ノードを開きます。

3. Oracle Managed File Transfer専用のOracle WebLogic Server管理対象サーバーがインストールされているドメインを選択します。
たとえば、ドメインはsoainfraまたはbase_domainです。

4. ドメインを右クリックし、「システムMBeanブラウザ」を選択します。

5. 「検索」アイコンをクリックします。

6. 「MBean名」テキスト・ボックスにMFTConfigと入力します。[Enter]を押します。
「アプリケーション定義のMBeans: MFTConfig: mft」ページが表示されます。

7. 「操作」タブをクリックします。

8. 「addProperty」をクリックします。
「操作: addProperty」ページが表示されます。

9. 「キー」テキスト・ボックスにプロパティ名を入力します。「値」テキスト・ボックスにプロパティ値を入力します。コメントの入力はオプションです。「呼出し」をクリックします。

10. プロパティが追加されたことを確認するには:

a. 「戻る」をクリックします。

b. 「属性」タブをクリックします。

c. 「プロパティ」をクリックします。
「属性: プロパティ」ページが表示されます。追加したプロパティが一覧表示されるはずです。