|
リリース 11.1.2.3
Oracle Hyperion Profitability and Cost Managementで、非常に長い、または反復するプロセスの実行を簡略化するには、Oracle Web Services Manager (OWSM)を使用して自社用のカスタム・スクリプトを作成します。これにより、オンサイト従業員がプロセスを開始しなくても、Oracle Essbaseキューブの配置やデータの転送などのプロセスを本番環境で自動的に呼び出すことができます。
Javaアプリケーション・プログラミング・インタフェース(API)を使用してカスタム・スクリプトを生成し、Profitability and Cost Managementに対してWebサービス操作を呼出しできます。使用可能な操作の全リストは、Profitability Webサービスの操作を参照してください。
カスタム・スクリプトの作成を支援するために、このインストールにはサンプル・クライアントも用意されています。サンプル・クライアントは、Profitability and Cost Managementで使用可能なWebサービス・コマンドを提供し、モデル内のデータの識別を支援します。
Webサービスを使用して自動スクリプトを作成する前に、『Oracle Hyperion Enterprise Performance Management Systemインストールおよび構成ガイド』で説明されている次のコンポーネントをインストールおよび構成する必要があります:
リポジトリ作成ユーティリティ(RCU)を実行します。Profitability and Cost Managementの「構成後のタスク」を参照してください。
Oracle Web Services Manager (OWSM)を構成します。Profitability and Cost Managementの「Oracle Web Services Managerの構成」を参照してください。
Webサービスのセキュリティを有効にします。Profitability and Cost Managementの「構成後のタスク」を参照してください。
このドキュメントでは、次のコンポーネントに関する作業知識があることを前提としています:
Oracle Web Services Manager
WSDL
XML
XMLスキーマ(XSD)
SOAP
WebサービスAPIのインタフェースは、Web Services Description Language (WSDL)ドキュメントによって定義されます。WSDLはXMLベースの言語で、Webサービスを説明し、サービスの場所およびサービスが公開する操作を示します。
Profitability and Cost Management WebサービスのWSDLドキュメントを確認するには、http://<localhost>:19000/profitability/ProfitabilityService?WSDLを参照してください。
Oracle Hyperion Profitability and Cost Management Web Service API Reference - Profitability Servicesに、Profitability Serviceのサンプル・クライアント・ファイルで使用されているWSDL Webサービス・コマンドのリストが記載されています。
操作ごとに、パラメータがハイライト表示されます。サンプル・ファイルから追加情報にナビゲートするには:
プラス記号をクリックしてアイテムを展開し、関連付けられたコードを表示します。
任意のリンクをクリックすると、関連付けられた説明に接続します。たとえば、「String:applicationName」をクリックすると「Type: String」にリンクし、そのタイプに有効な値が表示されます。
特定のコーディングの詳細は、次の手順に説明するように、ドキュメント・ライブラリ内のOracle Hyperion Profitability and Cost Management Web Service API Reference - Profitability Services (WebサービスJavaDoc)を参照してください。
WebサービスAPIリファレンス - Profitability Servicesドキュメントにアクセスするには:
http://www.oracle.com/technetwork/middleware/performance-management/documentation/index.htmlにあるOTNドキュメント・ライブラリを開きます。
「Oracle Hyperion Profitability and Cost Management, Fusion Edition」で「Web Service API Reference」を選択し、標準Profitabilityアプリケーションと詳細Profitabilityアプリケーションの両方のWebサービスAPIリファレンスを表示します。
操作は、Profitability and Cost ManagementのWebサービスから使用できるメソッドまたはタスクです。各操作には入力パラメータの定義が必要であり、使用中のデータや、実行中のプロセスまたはタスクを制御するための出力パラメータも必要な場合がほとんどです。使用可能な操作の全リストは、Profitability Webサービスの操作を参照してください。
入力および出力パラメータ、またはその他のオプションは、次のいずれかのタイプとして表示されます:
データ転送オブジェクト(DTO) - DTOは、Profitability and Cost Managementアプリケーション・サーバーからのデータの転送または取得に使用されるフォーマットです。DTOに関連付けられている動作はありません。
たとえば、bulkEditOptionsDTOを展開すると、オブジェクト宣言とそのアクセス可能なメンバー名の全詳細がオプションで指定されます。フィールド名のみが表示され、データ値は自動的に移入されません。Java開発者は、各フィールドに使用可能な"set"メソッドおよび"get"メソッドを使用して、値を設定するか既存の値を読み取る必要があります。
ブール - ブール応答は常にTRUEまたはFALSEです。
文字列 - 文字列タイプは文字列コンテンツを指定する、または返すときに使用されます。例:
applicationName (登録されたProfitability and Cost Managementアプリケーションの名前。たとえば、BksSP82、BksDP30などがあります。)
xxxxStageList - モデル内のステージ名のリスト。この変数の使用例は、表5クラス内にあります。たとえば、generateStageList、calculateStageListなどがあります。
importConfigName - Profitability and Cost Managementアプリケーションで作成されたインポート構成の名前。
paths - Profitability and Cost Managementアプリケーションで作成された、有効な系統実行パス。
注: | 後続ステージの自動選択はWebサービスで使用できないため、processCalcScriptOptionsでは、clearAllStageListおよびclearAllCalculatedStageListについて、すべてのステージを入力する必要があります。 |
入力パラメータは操作の実行に必要な情報を提供します。
パラメータには、次の2つのタイプがあります:
出力パラメータは操作によって要求される情報を提供します。
deleteApplications()などの一部の操作については、出力パラメータが生成されません。
パラメータには、次の2つのタイプがあります:
シンプル・パラメータ・タイプ - これらのパラメータは、"String"値などの基本的なJavaデータ型を使用して定義されます。たとえば、Oracle Essbaseキューブ配置またはPOVデータのコピーの要求時には、TaskflowIDが生成されます。
複合パラメータ・タイプ - これらのパラメータは、複合データ型を使用して定義されます。たとえば、getApplications() Webサービス・メソッドを使用してすべての既存アプリケーションのリストを要求する際は、List<ApplicationDTO>が返されます。
カスタム・スクリプト内のPortTypeをProfitabilityServicesに設定すると、事前定義されたProfitability and Cost Management操作のリストが使用可能になります。操作の全リストは、Oracle Hyperion Profitability and Cost Management Web Service API Reference - Profitability Servicesから入手できます。
カスタムProfitabilityServicePortTypeClientプログラムで必要な操作を呼び出すことにより、既存のすべてのProfitability and Cost Managementアプリケーションのリストを表示するgetApplicationsなどの特定のタスクを実行できます。
注意 | Webサービス・リクエストの入力パラメータとして提供されたデータ(アプリケーション名、ステージ名、POV名またはその他の関連データ)がProfitability and Cost Managementデータベースに存在しない場合、操作は失敗するため、存在していることを確認します。 |
すべての操作のAPIコマンドの詳細は、Oracle Hyperion Profitability and Cost Management Web Service API Reference - Profitability Servicesを参照してください。このドキュメントは、WebサービスAPIリファレンス - ProfitabilityServiceの使用に示すように、OTNドキュメント・ライブラリから入手できます。
注: | 次の表のすべての例は、%EPM_ORACLE_HOME%\products\Profitability\samples - BksDP30およびBksSP82に付属しているサンプル・アプリケーション内にあります。 |
この操作を使用して、指定されたソース割当てルールのバルク編集を宛先ルール、またはProfitability and Cost Managementの詳細アプリケーションのドライバによって実行します。
String applicationName - このバルク編集操作が適用される対象のProfitability and Cost Managementアプリケーションの名前。
オプション: BulkEditOptionsDTO bulkEditOptions - 「バルク編集の適用」操作の実行に必要な情報が含まれるDTO。
表 1. BulkEditOptionsDTO
変数 |
説明 |
例 |
---|---|---|
sourceRules |
このバルク編集操作に選択されているソース割当てルール名のリスト。 |
すべての構築アクティビティの適用 |
destinationRules |
このバルク編集操作に選択されている宛先割当てルール名のリスト。 注: この値は、BulkEditOperations.ADD_ASSIGNMENT_RULESとBulkEditOperations.REMOVE_ASSIGNMENT_RULESによってのみ渡される必要があります。 |
販売オーダーから請求書 |
drivers |
このバルク編集操作の一環として、選択されたソース割当てルールに適用されるドライバの名前。 注: BulkEditOperations.ADD_DRIVER操作の使用時は1つのドライバ名のみが提供されますが、BulkEditOperations.REMOVE_DRIVERS操作の使用時はドライバ名のリストが提供される場合があります |
DRVビルド製品 |
operation |
バルク編集操作を指定します:
|
ADD_DRIVERS |
povGrp |
このバルク編集操作が適用される対象のPOVの次元メンバー名を指定します:
|
povDimensionMember1 = 2012 povDimensionMember2 = January povDimensionMember3 = Actual Draft |
selectAllRulesOrDriversForDelete |
すべての宛先割当てルールまたはドライバを、削除のために選択する必要があるかどうかを示すブール・フラグ。 有効な値はTRUEまたはFALSEです。 注: この値は、BulkEditOperations.REMOVE_DRIVERSおよびBulkEditOperations.REMOVE_ASSIGNMENT_RULESによってのみ渡される必要があります。 |
FALSE |
selectEntireStageForDelete |
ステージ全体を削除のために選択する必要があるかどうかを示すブール・フラグ。 有効な値はTRUEまたはFALSEです。 |
FALSE |
comment |
このバルク編集操作のコメントを指定します。 |
"ドライバを追加するためのバルク編集操作" |
@return String - この操作に対して生成されたCESタスクID。
注: | getTaskflowStatusByProcessName操作を使用して、(「タスクフロー・ステータス(要約)」に表示される)このCESタスクフロー名のステータスを取得します。 |
この操作を使用して、アプリケーション名、POVおよびレイヤーの特定の組合せに対するASOキューブを消去します。
String applicationName - 使用するProfitability and Cost Managementアプリケーションの名前。
povMemberGroupDTO pov - POV情報
layer layerName - レイヤー名。例: COST、REVENUE
@return String - このタスクに対して生成されたCESタスクID。
注: | getTaskflowStatusByProcessName操作を使用して、(「タスクフロー・ステータス(要約)」に表示される)このCESタスクフロー名のステータスを取得します。 |
この操作を使用して、選択ステージおよびその他の詳細のPOVデータを消去します。
String applicationName - Profitability and Cost Managementアプリケーションの名前。
ClearPOVDTO clearPOVData - POV消去オプション。
表 3. ClearPOVDTO
変数 |
説明 |
例 |
---|---|---|
clearAssignmentRuleSelections |
割当てルールの選択を消去するかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
clearCalculationRules |
計算ルールを消去するかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
clearCostLayer |
費用レイヤーを消去するかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
clearDriverSelectionExceptions |
ドライバの選択の例外を消去するかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
clearDriverSelectionRules |
ドライバの選択ルールを消去するかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
clearRegularAssignments |
通常の割当てを消去するかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
clearRevenueLayer |
収益レイヤーを消去するかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
pov |
このバルク編集操作が適用される対象のPOVの次元メンバー名を指定します:
|
povDimensionMember1 = 2012 povDimensionMember2 = January povDimensionMember3 = Actual povState = Draft |
povGrp |
このバルク編集操作が適用される対象のPOVの次元メンバー名を指定します:
|
povDimensionMember1 = 2012 povDimensionMember2 = January povDimensionMember3 = Actual povState = Draft |
stages |
このバルク編集操作が適用される対象のPOVの次元メンバー名を指定します:
|
元帳データ |
この操作を使用して、モデル・アーティファクトとソースPOVの組合せのデータを、宛先POVの組合せにコピーします。この操作は、画面で「モデルの管理」>「POVマネージャ」>「コピー」を選択することでサポートされる機能に対応しています。
String applicationName - copyPOVData操作が実行される対象のProfitability and Cost Managementアプリケーションの名前。
CopyPOVDTO copyPOVData - POVのコピー機能の選択詳細。このDTOのすべてのブール値は、「モデルの管理」>「POVマネージャ」>「コピー」画面で使用できるチェック・ボックスに対応しています。表3を参照してください。
@return String - この操作に対して生成されたCESタスクID。
注: | getTaskflowStatusByProcessName操作を使用して、(「タスクフロー・ステータス(要約)」に表示される)このCESタスクフロー名のステータスを取得します。 |
この操作を使用して既存のProfitability and Cost Managementアプリケーションと、そのOracle Hyperion Shared Servicesとの関連付けを削除します。
注意 | deleteApplications操作では、すべてのPOVおよび関連するEssbaseキューブのモデル・データ全部が削除されるため、慎重に実行してください。 |
注: | アプリケーションは、Oracle Hyperion EPM Architectライブラリでは引き続き使用可能です。このアプリケーションをProfitability and Cost Managementに再配置するには、Oracle Hyperion EPM Architectで「診断」を実行し、ステータスを「未配置」に戻して設定します。 |
String applicationName - Profitability and Cost Managementデータベースから削除される予定で、Oracle Hyperion Shared Servicesに未登録のアプリケーションの名前。
この操作を使用して、Profitability and Cost Managementアプリケーションの既存のPOVを削除します。
注意 | このPOVに関連付けられたすべてのモデル・データもこの操作によって削除されるため、操作の使用時には注意してください。 |
String applicationName - POVが削除される対象のProfitability and Cost Managementアプリケーションの名前。
POVMemberGroupDTO povDTO - このバルク編集操作が適用される対象のPOVの次元メンバー名を指定します。表2を参照してください。
layerName - 有効な値: COST、REVENUE
この操作を設定する場合、次の条件が適用されます:
操作には少なくとも1つのPOV次元メンバー名が必要です。
値は、アプリケーションで定義されている変数のみに設定できます。POVが2つのPOV次元を使用して定義されている場合は、povDimensionMember1およびpovDimensionMember2に対する値のみを指定します。その他の値は"NULL"のままにします。
povStateは、getPOVs操作が使用される場合のみ代入されます。このフィールドは、いずれかの操作でPOVMemberGroupDTOをパラメータとして渡すときは不要です。表2を参照してください。
この操作を使用して、選択した標準Profitabilityアプリケーションの計算キューブまたはレポート・キューブを、配置または再配置します。
CubeDeployOptionsDTOオプションは、「計算」を選択したときのアプリケーションのラジオ・ボタンおよびチェック・ボックスに関連します。
String applicationName - 配置または再配置の対象となる、Profitability and Cost Managementアプリケーションの計算キューブまたはレポート・キューブの名前。
CubeDeployOptionsDTO cubeDeployOptions - キューブの配置に関する選択詳細を入力します。
表 4. CubeDeployOptionsDTO
変数 |
説明 |
例 |
---|---|---|
cubeType |
有効な値:
|
CALCULATION_CUBE REPORTING_CUBE |
firstTimeDeployment |
このアプリケーションで初めてキューブが配置されているかどうかを示すブール・フラグ。有効な値はTRUEまたはFALSEです。 |
FALSE |
updateDatabase replaceDatabase |
どちらの変数もアプリケーションのラジオ・ボタンに関連するため、いずれか一方のみをTRUEに設定する必要があります。 データベースを更新するかどうかを示すブール・フラグ。有効な値はTRUEまたはFALSEです。 注: その他のパラメータ(archiveDataBeforeDeploy、archiveDataAndReloadAfterDeploy、deleteDataArchiveAfterReload)は、updateDatabaseがTRUEに設定されている場合にのみTRUEに設定できます。 |
TRUE |
archiveDataBeforeDeploy |
配置の開始前にデータをアーカイブするかどうかを示すブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
archiveDataAndReloadAfterDeploy |
配置前にアーカイブされたデータを、配置の完了後にリロードするかどうかを示すブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
deleteDataArchiveAfterReload |
アーカイブされたデータをリロード後に削除するかどうかを示すブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
@return String- キューブの配置アクション用として生成されたCESタスクフローID。
注: | getTaskflowStatusByProcessName操作を使用して、(「タスクフロー・ステータス(要約)」に表示される)このCESタスクフロー名のステータスを取得します。 |
この操作を使用すると、既存のProfitability and Cost Managementアプリケーションのアプリケーション・タイプがGeneral (標準Profitabilityの場合)またはDetail (詳細Profitabilityの場合)として表示されます。
この操作を使用して既存のProfitability and Cost Managementアプリケーションをすべてリストします。
この操作を使用して、選択したタイプのProfitability and Cost Managementアプリケーションをすべてリストします。
String applicationType - Profitability and Cost Managementアプリケーション・サーバーからフェッチされるアプリケーションのタイプを指定します。有効な値は次のとおりです:
GENERAL (標準Profitabilityアプリケーションの場合)
DETAIL (詳細Profitabilityアプリケーションの場合)
この操作を使用して、指定された詳細Profitabilityアプリケーションの特定のステージに対して、(関連付けではなく)割当てルールの定義をすべて取得します。
String applicationName - 割当てルールの定義が取得される対象の詳細Profitability and Cost Managementアプリケーションの名前。
String stageName - 割当てルールの定義を取得する対象のステージ名を指定します。
この操作を使用して、詳細Profitability and Cost Managementアプリケーションのすべてのドライバ定義をリストします。
この操作を使用して、選択したアプリケーションのすべてのPOV詳細を取得します。
@return List<POVMemberGroupDTO> - POV情報が含まれるPOVMemberGroupDTOのリスト。関連付けられているメンバーのリストは、表2を参照してください。
この操作を使用して、選択したアプリケーションのすべてのステージ詳細を取得します。このコマンドを使用して、ステージの名前および表示順序を検索できます。
この操作を使用して、ジョブ・プロセス名の現在のステータス(CESタスクフロー)を、タスクフロー・ステータス(要約)に表示されるとおりに参照します。有効なステータスは、新規、アクティブ、停止済および完了です。
この操作を使用して、詳細Profitability and Cost Managementアプリケーションのビューを用意します。
String applicationName - レポート用ビューが用意される対象の詳細Profitability and Cost Managementアプリケーションの名前。
List<DimensionDTO> dimensions - レポート用ビューの生成に含まれる次元の、名前および短い名前のプロパティのリストを指定します。
この操作を使用して、選択した標準Profitabilityアプリケーションのプロセスを開始し、計算スクリプトを実行します。次のアクションは、アプリケーションの「計算の管理」タブ上のチェック・ボックスに関連します:
すべて消去
計算済の消去
生成
計算
計算後にデータを転送
注: | clearAllStageListまたはclearAllCalculatedStageListの場合、消去するすべてのステージ名をリストします。どのステージも消去しない場合は、空の引用符を使用します |
String applicationName - 選択したオプションに応じて、計算スクリプトが生成および実行される対象の標準Profitability and Cost Managementアプリケーションの名前。
CalcScriptOptionsDTO options: - 計算スクリプトの処理に関する選択詳細。
表 5. CalcScriptOptionsDTO
変数 |
説明 |
例 |
---|---|---|
povGrp |
計算スクリプトの生成および実行が、実行される対象のPOV情報。表2を参照してください。 |
povDimensionMember1=2012 povDimensionMember2=March povDimensionMember3=Actual povState=Draft |
layerName |
計算スクリプトが生成および実行される対象のレイヤー名。有効な値:
|
COST |
clearCalculatedStageList |
計算済データの消去が必要とされるステージ名のリスト。 |
会計データ、アクティビティ |
clearAllStageList |
すべての情報のクリアが必要とされるステージ名のリスト。 |
会計データ、アクティビティ |
generateStageList |
計算スクリプトの生成が必要とされるステージ名のリスト。 |
会計データ、アクティビティ |
calculateStageList |
計算スクリプトの実行が必要とされるステージ名のリスト。 |
会計データ、アクティビティ |
transferData |
データ転送の実行が必要かどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
FALSE |
@return String - この操作に対して生成されたCESタスクID。
注: | getTaskflowStatusByProcessName操作を使用して、(「タスクフロー・ステータス(要約)」に表示される)このCESタスクフロー名のステータスを取得します。 |
この操作を使用して、選択した詳細Profitabilityアプリケーションの計算を処理および実行します。次のアクションは、アプリケーションの「計算の管理」タブ上のチェック・ボックスに関連します:
clearCalculated - 「処理のオプション」>「計算済の値を消去」
createContributionDetail - 「処理のオプション」>「計算の実行」>「コントリビューションの詳細の作成」
createDetailCalculatedDriverTables - 「処理のオプション」>「計算の実行」>「計算済ドライバ・テーブルの詳細の作成」
executeCalculations - 「処理のオプション」>「計算の実行」
runSingleCalcRuleSequence - 「処理のオプション」>「単一の計算ルール・シーケンスの実行」
abortOnError - 「処理のオプション」>「制限されたソース・セットでのプレビュー」
transferToContribDb - 「処理のオプション」>「データ転送」>「コントリビューション・データベース」
transferToDstStgDb - 「処理のオプション」>「データ転送」>「宛先ステージ・データベース」
transferToSrcStgDb - 「処理のオプション」>「データ転送」>「ソース・ステージ・データベース」
String applicationName - 計算される対象の詳細Profitability and Cost Managementアプリケーションの名前。
DetailedCalculationOptionsDTO calc options - 計算を実行するための選択詳細。
表 6. DetailedCalculationOptionsDTO
変数 |
説明 |
例 |
---|---|---|
clearCalculated |
前に計算した値をクリアするかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
executeCalculations |
この操作の一環として計算を実行するかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 注: executeCalculationsフラグがTRUEに設定されている場合、createContributionDetail、createDriverTablesおよびrunSingleCalcRuleSequenceの値を指定する必要があります。 |
TRUE |
createContributionDetail |
コントリビューションの詳細を作成することを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
TRUE |
createDetailCalculatedDriverTables |
計算済ドライバ・テーブルを作成するかどうかを指定するブール・フラグ。 |
TRUE |
dataPOVMemberGroups |
計算時にデータPOVについて考慮が必要なPOV次元メンバー・グループの詳細リスト。 表2を参照してください。 |
povDimensionMember1=2012 povDimensionMember2=January povDimensionMember3=Actual |
modelPOVMemberGroup |
計算の実行時の、モデルPOV次元メンバー・グループの詳細。 |
povDimensionMember1=2012 povDimensionMember2=January povDimensionMember3=Actual |
runSingleCalcRuleSequence |
計算時に単一の計算ルール・シーケンスを考慮するかどうかを指定するブール・フラグ。有効な値はTRUEまたはFALSEです。 |
FALSE |
postScript |
計算後スクリプトの名前 |
POST |
preScript |
計算前スクリプトの名前 |
PRE |
calcRuleSequence |
計算ルール・シーケンス値。 |
有効な値は1 - 9999です。 |
transferToSrcStgDb |
ソース・ステージ・データベースに対してデータ転送を実行するどうかを指定するブール・フラグ。 |
有効な値はTRUEまたはFALSEです。 |
transferToDstStgDb |
宛先ステージ・データベースに対してデータ転送を実行するどうかを指定するブール・フラグ。 |
有効な値はTRUEまたはFALSEです。 |
transferToContribDb |
コントリビューション・データベースに対してデータ転送を実行するどうかを指定するブール・フラグ。 |
有効な値はTRUEまたはFALSEです。 |
abortOnError |
有効な値はTRUEまたはFALSEです。 |
TRUE |
comment |
(文字列) |
オプションのフィールド |
@return String - この操作に対して生成されたCESタスクID。
注: | getTaskflowStatusByProcessName操作を使用して、(「タスクフロー・ステータス(要約)」に表示される)このCESタスクフロー名のステータスを取得します。 |
この操作を使用して、選択した標準Profitabilityアプリケーションに対して定義されている系統パスを実行します。次のアクションは、「計算」>「計算の管理」>「系統」タブを選択したときのチェック・ボックスに関連します。
String applicationName - 系統パスが計算される対象のProfitability and Cost Managementアプリケーションの名前。
GenealogyOptionsDTO genealogyInfo - 系統パスの実行に関する選択詳細。
表 7. GenealogyOptionsDTO
変数 |
説明 |
例 |
---|---|---|
layerName |
系統実行パスが実行される対象のレイヤー名。有効な値は次のとおりです:
|
Layer.COST |
paths |
系統実行パスのリスト |
1-3-5 |
povGrp |
この系統パスの実行に関連するPOV次元メンバー・グループ情報を指定します。 表2を参照してください。 |
povDimensionMember1=2012 povDimensionMember2=January povDimensionMember3=Actual povState=Draft |
@return String - この操作に対して生成されたCESタスクID。
注: | getTaskflowStatusByProcessName操作を使用して、(「タスクフロー・ステータス(要約)」に表示される)このCESタスクフロー名のステータスを取得します。 |
この操作を使用して、そのPOVとレイヤーの組合せに対するASOキューブを消去せずに系統コントリビューション・パスを実行します。
注: | 使用目的は、標準原価計算HPCMアプリケーションで複数のPOVに対して系統を実行することです。同じPOVに対して複数の系統計算を実行するためのものではありません。 |
String applicationName - Profitability and Cost Managementアプリケーションの名前。
GenealogyOptionsDTO genealogyInfo - 系統パスの実行に関する選択詳細。表 7を参照してください
@return String - 系統パスの実行用として生成されたCESタスクID。
注: | getTaskflowStatusByProcessName操作を使用して、(「タスクフロー・ステータス(要約)」に表示される)このCESタスクフロー名のステータスを取得します。 |
この操作を使用して、ステージング・テーブルからProfitability and Cost Managementアプリケーションへの選択済のインポートを起動します。
String applicationName - インポート構成によってデータがインポートされる対象のProfitability and Cost Managementアプリケーションの名前。
String importConfigName - 実行するインポート構成の名前。
@return String - インポート構成の実行のために生成されたCESタスクID。
注: | getTaskflowStatusByProcessName操作を使用して、(「タスクフロー・ステータス(要約)」に表示される)このCESタスクフロー名のステータスを取得します。 |
WebサービスAPIリファレンスは、カスタムProfitabilityServicePortTypeClientクラスの開発を目的とするJava開発者を対象としています。
カスタム・スクリプトはProfitability and Cost Management操作を使用して構築できます。
カスタム・スクリプトで次のコマンドを使用することで、Profitability and Cost Managementに対して使用可能なWebサービスを呼び出します。各カスタム・スクリプトには、表8に説明のあるコンポーネントの一部またはすべてが必要です。
表 8. Profitability and Cost Managementのカスタム・スクリプトの要件
スクリプト・アイテム |
説明 |
---|---|
ネームスペースおよび場所 |
ネームスペースおよび場所は、サービスを含むすべてのコマンドまたは操作に使用します:
|
サービス |
各スクリプトについて、サービスをProfitabilityServiceに設定すると、Profitability and Cost Managementに定義されたWebサービス操作が有効になります。 |
「インタフェース(ポート・タイプ)」 |
ポート・タイプ・クラスをProfitabilityServiceに設定します。 |
操作 |
操作とは、使用可能なWebサービスのことです。 使用可能な各操作には、次の情報がAPIリファレンスで定義されています:
APIリファレンスのトピックを展開すると、関連コードが表示されます。 |
入力パラメータ |
各操作には、入力パラメータが必要な場合があります。 たとえば、String applicationNameでは、POVを取得する対象のアプリケーションの名前を入力する必要があります。 |
出力パラメータ |
各操作には、出力パラメータが存在する場合があります。 |
操作定義 |
サービスごとに、タスクの実行に使用される可能性のあるメソッドまたは操作がいくつか存在します。 |
バインディング操作定義 |
バインディング操作は、指定したポート・タイプの操作およびメッセージのメッセージ・フォーマットとプロトコル詳細に関する情報を定義します。 |
メッセージ |
メッセージは、例外が発生した場合に表示される障害メッセージです。これらのメッセージは自動的に表示され、カスタム・スクリプトでのコーディングは必要ありません。 |
要素 |
要素は、.wsdlファイルで定義されるため、カスタム・スクリプトでのコーディングは必要はありません。 |
タイプ |
タイプは、指定したパラメータのラッパー・タイプを表し、パラメータを戻します。カスタム・スクリプトでのコーディングは必要ありません。 |
カスタムWebサービス・スクリプトを生成する場合、サービス名を識別し、呼び出す操作を選択する必要があります。
Profitability Webサービスのカスタム・スクリプトを作成するには:
Webサービスに対して有効にするサーバーを設定します。Oracle Enterprise Performance Management System Installation and Configuration Guideを参照してください。
コーディング時に、「ProfitabilityService」サービス名を選択します。(詳細は、Profitability and Cost Managementサンプル・クライアント・ファイルの使用を参照してください。)
Webサービス・クライアントを作成し、実行する操作を選択します。
使用可能な操作のリストは、Profitability Webサービスの操作を参照してください。
各操作のパラメータの詳細な説明は、OTNドキュメント・ライブラリ内のOracle Hyperion Profitability and Cost Management Web Service API Reference - Profitability Services (WebサービスJavaDoc)を参照してください。
オプション: .batまたは.shスクリプトを使用してプログラムを実行するには、新しく作成したWebサービス・クライアント名と一致する既存のファイルを編集します。
Webサービスのサンプル・クライアント・ファイルには、Profitability and Cost Managementを自動化するためのカスタム・スクリプトで使用可能なコマンドが表示され、Profitability and Cost Managementモデル内のデータが識別されます。このサンプル・クライアント・ファイルは、カスタム・スクリプトの作成を支援するためのガイドのみを目的としています。
サンプル・クライアント環境を設定するには:
オプション: Oracle Hyperion Enterprise Performance Management Workspaceがインストールされているマシンと同じマシン上で作業していない場合は、サンプルにアクセスするマシンにフォルダ%EPM_ORACLE_HOME%/products/Profitability/samples/wsclientをコピーします。
たとえば、C:\wsclientです。
ProfitabilityServiceと関連付けられているSecurityPolicyがUSERNAME_WITH_SAML_TOKENの場合、以下にリストされたソース・フォルダから次のファイルをwsclientフォルダにコピーします。
手順4で、hpm_ws_client.propertiesファイル内にこれを構成設定として指定できます。
表 9. サンプル・クライアントに必要なファイル
ソース・フォルダ |
ファイル名 |
---|---|
%EPM_ORACLE_HOME%/../user_projects/domains/EPMSystem/config/fmwconfig |
jps-config.xml |
%EPM_ORACLE_HOME%/../user_projects/domains/EPMSystem/config/fmwconfig |
<<Associated keystore file.XXXX.jks>> |
ファイルベース・セキュリティを使用している場合は、%EPM_ORACLE_HOME%/../user_projects/domains/EPMSystem/config/fmwconfig |
cwallet.sso |
ローカル設定に合うようにhpm_ws_client.propertiesファイルを編集します:
#Open the HPCM WSDL URL which is to be accessed. For example: http://localhost:19000/profitability/ProfitabilityService?WSDL (or) {DRIVE_LETTER}:/{FILE_PATH}/FILE_NAME.wsdl hpcm.wsdl.url=http://localhost:19000/profitability/ProfitabilityService?WSDL #Delimiter used to separate String literals in paramters string.delimiter=_ # Delimiter used to separate logical entities in parameters # For example, when passing multiple POVs at a time, please use this to delimit POVs # For example: 2009_January_Actual#2009_March_Actual when passing 2 POVs string.logical.delimiter=# # SecurityPolicy associated with ProfitabilityService, that needs to be used by Sample Client. # The sample client is programmed to work with only one of 2 values: # a. USERNAME_TOKEN # b. USERNAME_WITH_SAML_TOKEN hpcm.service.security.policy=USERNAME_TOKEN ## These next two values are needed only when the security policy is ## USERNAME_TOKEN #HSS user name for the Profitability user. hss.username=admin #Password for the username above. hss.password=password123 ## These next three values are needed only when the security policy is ## USERNAME_WITH_SAML_TOKEN # Full Path of the jps-config.xml file in use. jps.config.file=C:/wsclient/jps-config.xml #WSS Recipient key alias name used. wss.recipient.key.alias=adminalias # WSS Credential Store Framework key used. wss.csf.key=epmpcm.credentials
オプション: Oracle Enterprise Performance Management Workspaceがインストールされているマシンと同じマシン上で作業していない場合は、JDeveloper 11.1.1.6.0をダウンロードしてローカルにインストールし、適切なJAVA_HOMEおよびMIDDLEWARE_HOMEフォルダを取得します。
コマンドまたはシェル・ウィンドウから、次の環境変数を設定します:
表 10. サンプル・クライアント環境の変数
環境変数 |
場所 |
---|---|
JAVA_HOME |
Java Development Kitが使用可能な場所:
|
MIDDLEWARE_HOME |
Oracle Middlewareホームがインストールされている場所。
|
コマンド・ウィンドウで、C:\wsclientに移動し、次のコマンドを入力します:
hpm_ws_client.bat -help
使用可能なすべての関数のリストが表示されます。
サンプル・クライアント・ファイルに指定されているフォーマットおよび操作を使用して、カスタム・スクリプトを構築します。サンプル・クライアント・ファイルの使用を参照してください。
サンプル・クライアント・ファイルは、Webサービスを介してOracle Hyperion Profitability and Cost Managementデータにアクセスするカスタム・スクリプトの構築をガイドすることのみを目的としています。サンプル・クライアント・ファイルは、%EPM_ORACLE_HOME%/products/Profitability/samples/wsclientから入手できます。これらのファイルは、バッチ・スクリプト(Windows OS)およびシェル・スクリプト(UNIX/Linux OS)を使用して作成されています。
サンプル・クライアント・ファイルを使用するには:
コマンド・ウィンドウで、C:\wsclientに移動します。サンプル・クライアント環境の設定を参照してください。
hpm_ws_client.bat - help
使用可能な機能のリストは、Profitability Webサービスの操作を参照してください。
実行する操作を選択し、次のフォーマットでコマンドを入力します:
hpm_ws_client.bat - help <operation_name>
たとえば、getPovs操作の使用詳細を取得するには、次のフォーマットでコマンドを入力します:
hpm_ws_client.bat - help getPovs
サンプル・クライアント・ファイルを使用して操作を実行するには、次のフォーマットでコマンドを入力します:
hpm_ws_client.bat <operation_name> <<parameters>>
例1: すべてのアプリケーションのリスト
たとえば、使用可能なすべてのアプリケーションのリストを取得するには、次のコマンドを入力します:
hpm_ws_client.bat getApplications
例2: すべてのPOVのリスト
たとえば、特定のアプリケーションのすべてのPOVのリストを取得するには、次のコマンドを入力します:
hpm_ws_client.bat getPovs <<application name>>
例3: ステージの取得
たとえば、アプリケーションのステージを取得するには、次のコマンドを入力します:
hpm_ws_client.bat getStages <<application name>>
クライアント・サンプルは、次のフォーマットで提供されます:
ソース・コードとして(wsclient/src/oracle/epm/webservices/profitability/client/ProfitabilityServicePortTypeClientSample.java内)
コンパイルされたバイナリ・ファイルとして(wsclient/lib/hpcmwsclient-sample.jar内)
コードを正常にコンパイルするには、common.components.homeフォルダの場所を指定する必要があります。
なんらかの理由でソース・コードを再コンパイルする必要がある場合は、Antを使用して再コンパイルできます。Ant用のbuild.xmlファイルはwsclientフォルダ内にあります。
ソース・コードを再コンパイルするには:
コマンドまたはシェル・ウィンドウを開き、common.components.homeフォルダの場所を指定します。
このフォルダは、MIDDLEWARE_HOME/oracle_commonとして定義されています。MIDDLEWARE_HOMEは、次のように設定されています:
Windowsの場合: SET MIDDLEWARE_HOME=C:/Oracle/Middleware
UNIXの場合: export MIDDLEWARE_HOME=/usr/c/Oracle/Middleware
次のいずれかの方法を使用して、フォルダの場所をAntに渡します:
コマンドライン・パラメータとして。例:
ant -Dcommon.components.home=C:/Oracle/Middleware/oracle_common
build.propertiesファイルで、編集のためにファイルを開き、common.components.home変数の定義のコマンドを解除します。例:
common.components.home=C:/Oracle/Middleware/oracle_common