Oracle Projects API, クライアント拡張およびオープン・インタフェース・リファレンス リリース12 E05609-01

目次

前へ

次へ

Oracle Projects APIの説明

この章では、Oracle Projects APIの概要を示します。セキュリティ要件、エラー・メッセージおよび標準APIパラメータを説明します。

この章では、次のトピックを説明します。

• Oracle Projects APIの説明
• Oracle Projects APIの概要
• 外部システムとOracle Projectsとの統合
• セキュリティ要件
• エラー・メッセージの処理
• 標準APIパラメータ
• 共通API
• Oracle Projectsでの処理の管理
• APIプロシージャの使用方法

Oracle Projects APIの説明

Oracle Projects APIを使用すると、外部システム（たとえば、プロジェクト管理システム）をOracle Projectsと統合できます。

注意: これらのAPIの一部は、Activity Management Gateway APIとして以前に文書化されています。現在、Activity Management Gateway製品にはライセンスがありません。Activity Management Gatewayとして以前にパッケージ化されていたAPIはすべて、このマニュアルで説明されています。

この項には、Oracle Projectsに用意されたパブリック・アプリケーション・プログラミング・インタフェース（API）の構造と処理を理解するために必要な情報を示します。

この章には次の情報が含まれます。

• Oracle Projects APIの概要。この項では、Oracle ProjectsのパブリックAPIを使用してOracle Projectsを外部管理システムと統合する方法をいくつか説明します。

• 外部システムとOracle Projectsとの統合。この項のステップに注意深く従ってください。システムを正しく統合すると、外部システムがOracle Projectsデータベースにアクセスできるようになり、Oracle Applicationsユーザーはこのマニュアルで説明されているアプリケーション・プログラミング・インタフェース（API）を使用するために必要な権限を取得できるようになります。

• セキュリティ要件。この項のステップに従うと、ユーザーが外部システムからOracle Projectsデータにアクセスする際に正しいセキュリティを確保できます。

• エラー・メッセージの処理。この項では、Oracle Projects APIによるエラー・メッセージの作成と、外部アプリケーションでのエラー・メッセージの表示方法を説明します。

• 標準APIパラメータ。この項では、Oracle ProjectsのパブリックAPIの大部分で共有される標準入出力パラメータを説明します。

• 共通API。この項では、すべてのOracle Projects APIで使用可能なAPI（GET_MESSAGES、GET_DEFAULTSおよびGET_ACCUM_PERIOD_INFO）の詳細を示します。

Oracle Projects APIの概要

Oracle Projectsのアプリケーション・プログラミング・インタフェース（API）では、Oracle Projectsをサード・パーティ・システムと統合して完全な管理ツールを作成できるようになります。優先システムの機能をOracle Projectsの機能と組み合せると、データを安全に共有して情報を交換できます。

APIには、150を超える次のようなアプリケーション・プログラミング・インタフェースが含まれています。

• システムとOracle Projects間のデータのリアルタイムまたはバッチ共有を実行することにより、データ入力の重複をなくします。

• システム間でビジネス・ルールやワークフローを共有します。

• 設定、プロジェクト計画、資源計画、予算編成、実績および進捗データを共有します。

APIの詳細な説明は、各Oracle Projectsアプリケーションの詳細に関する章に示します。

Oracle Projects APIのアプリケーション

Oracle Projects APIは、Oracle Projectsを様々なタイプの外部システムやサード・パーティ・システムと統合するために使用できる汎用ツールです。次のようなシステムとの統合が可能です。

• コラボレイティブ・プロジェクト計画およびスケジューリング・システム。企業のビジネス・システムをチーム指向のプロジェクト計画および計画ツールと統合し、会社全体に通信リンクを提供します。

• 営業管理システム。営業管理システムを使用して受注を入力し、APIを呼び出して、発注情報に基づいてOracle Projectsでプロジェクトを作成します。

• 作業管理システム。Oracle Projects APIを使用して、作業管理システムを含む包括的な解決を調整します。公益事業の会社では通常、このタイプのシステムが使用されます。

• 顧客資産管理および工場保守システム。作業指示、タスク、資産、クルー労務費、およびプロジェクトに賦課された在庫取引に関する情報を共有します。

• プロジェクト製造システム。Oracleのプロジェクト製造解決と同様に、APIを使用して在庫、製造および財務アプリケーションを結合します。

情報の発生場所

Oracle Projects APIを使用すると、Oracle Projectsとサード・パーティ外部システムとの間で双方向通信が可能になります。たとえば、タスクに対して発生した発注が企業内で処理されている場合は、そのプロジェクトのタスクを、デスクトップ・プロジェクト管理システムから削除できないように制限できます。(特定処理の制限の詳細は、「Oracle Projectsでの処理の管理」を参照してください。）

次の表に、Oracle Projectsで発生する情報のタイプを示します。

次の表に、外部システム（この場合、プロジェクト管理システム）で発生する情報のタイプを示します。

外部システムとOracle Projectsとの統合

Oracle Projectsをインストールして実装した後、外部システムをOracle Projectsと統合できます。次のステップに従って、外部システムがOracle Projectsデータベースにアクセスできるようにし、このマニュアルを通じて説明されているAPIを使用するために必要な権限をOracle Applicationsユーザーが取得できるようにします。

ステップ1: データベース・ロールの作成

特殊なデータベース・ロールを作成し、Oracle Projects APIを使用するすべてのユーザーに割り当てます。このステップは、ユーザー数にかかわらず、データベースごとに1回のみ行う必要があります。ユーザーは独自のロール名を定義できます。Oracle Projectsには、これらのデータベース・ロールを作成して割り当てるためにpaamgcrole.sqlスクリプトが用意されています。このスクリプトは、サーバーの$PA_TOP/sqlディレクトリに存在し、paamgcrole.lstという出力ファイルを作成します。書込み権限を持つ任意のディレクトリからスクリプトを実行してください。このスクリプトは任意のユーザー（Oracle ProjectsのパブリックAPIおよびビューに対するロールの作成権限および付与権限を持つSYSTEMまたはSYSなど）として実行します。

このスクリプトに必須の引数は次のとおりです。

• 新規データベース・ロール名（PMXFACEなど）

• Oracle Applicationsユーザー・アカウントのユーザー名（APPSなど）

SQL*Plusセッションから、次の構文を使用してスクリプトを実行します。

 start $PA_TOP/sql/paamgcrole.sql &role &un_apps

たとえば、APPSアカウントでロールPMXFACEを作成するには、次のように入力します。

 start $PA_TOP/sql/paamgcrole.sql PMXFACE APPS

このスクリプトによってロールが作成され、必須のデータベース・オブジェクトに対して必要な権限が付与されます。paamgcrole.lstファイルをチェックして、スクリプトが正常に完了していることを確認してください。

ステップ2: Oracle Applicationsユーザーの作成

すべてのAPIユーザーは、まずOracle Applicationsユーザーとして定義される必要があります。Oracle Applicationsユーザーとその必須職責を定義するには、Oracle Applications「ユーザー」ウィンドウを使用します。『Oracle Applicationsシステム管理者ガイド』を参照してください。

ステップ3: データベース・ユーザーの作成

必須の職責を持つOracle Applicationsユーザーを定義したら、データベース・ユーザーを作成する必要があります。Oracle Applicationsユーザー名とデータベース・ユーザー名は同一である必要があります。Oracle Projectsには、データベース・ユーザーを作成するためのスクリプトpaamgcuser.sqlが用意されています。このスクリプトは、サーバーの$PA_TOP/sqlディレクトリに存在し、paamgcuser.lstという出力ファイルを作成します。書込み権限を持つ任意のディレクトリからスクリプトを実行してください。このスクリプトは、任意のユーザー（Oracle ProjectsのパブリックAPIに対してユーザーの作成権限およびシノニムの作成権限を持つSYSTEMまたはSYSなど）として実行します。

このスクリプトに必須の引数は次のとおりです。

• 既存のデータベース・ロール名（PMXFACEなど）。ステップ1で作成したのと同じロール名を使用する必要があります。

• Oracle Applicationsユーザー・アカウントのユーザー名（APPSなど）

• 提示済新規データベース・ユーザー名

• 提示済新規データベース・ユーザー・パスワード

SQL*Plusセッションから、次の構文を使用してスクリプトを実行します。

 start $PA_TOP/sql/paamgcuser.sql &role &un_apps &uname &pwd

たとえば、パスワードWELCOMEを持つJCLARKというユーザーを作成するには、次のように入力します。

 start $PA_TOP/sql/paamgcuser.sql PMXFACE APPS JCLARK WELCOME

paamgcuser.lstファイルをチェックして、スクリプトが正常に完了したことを確認してください。

データベース・ユーザーを作成するためのテンプレート・スクリプト

Oracle Projectsには、大量データの処理を容易にする$PA_TOP/sql/paamgustemp.sqlというテンプレート・スクリプトが用意されています。このスクリプトによって出力ファイルpagenus.sqlが生成され、既存のOracle Applicationsユーザーから多数のデータベース・ユーザーが作成されます。WHERE条件を追加すると、基準を絞り込めます。書込み権限を持つ任意のディレクトリからスクリプトを実行してください。このスクリプトは、Oracle Projects APIにアクセスする必要があるユーザーに対してのみ実行する必要があります。このスクリプトは、任意のユーザー（Oracle ProjectsのパブリックAPIに対してユーザーの作成権限およびシノニムの作成権限を持つSYSTEMまたはSYSなど）として実行します。

注意: Oracle Applicationsユーザーは、同じユーザー名を共有する場合でも、データベース・ユーザーとは異なります。各Oracle Applicationsユーザーおよびデータベース・ユーザーは個別のパスワードを持ち、これらのパスワードは個別に保守される必要があります。Oracle Applicationsユーザーのパスワードを変更しても、データベース・ユーザーのパスワードは自動的には変更されません。ユーザーはOracle Applicationsユーザー名とデータベース・ユーザー名に対して異なるパスワードを選択できます。

ステップ4: Oracle Projectsでの製品の設定

「ソース製品」ウィンドウを使用して、Oracle Projectsで外部システムをソース製品として設定します。

データベースへの付与の復元

データベースがエクスポートされてからインポートされており、エクスポートとインポートの前にステップ1、2および3を実行している場合は、インポート後に付与の一部またはすべてが正しく機能しないことがあります。paamgurole.sqlスクリプト（$PA_TOP/sqlにある）を使用して付与を復元してください。このスクリプトは、任意のユーザー（Oracle ProjectsのパブリックAPIおよびビューに対して付与権限を持つSYSTEMまたはSYSなど）として実行します。

SQL*Plusセッションから、次の構文を使用してスクリプトを実行します。

 start $PA_TOP/sql/paamgurole.sql &role &un_apps

例:

 start $PA_TOP/sql/paamgurole.sql PMXFACE APPS

paamgurole.lstファイルをチェックして、スクリプトが正常に完了したことを確認してください。

既存のロールを以前のリリースからリリース12に移行

Oracle ProjectsのパブリックAPIを使用するために既存のデータベース・ロールとデータベース・ユーザーを移行するには、paamgurole.sqlおよびpaamguuser.sqlスクリプトを順次実行します。これらのスクリプトは$PA_TOP/sqlディレクトリ内にあります。これらのスクリプトは、任意のユーザー（Oracle ProjectsのパブリックAPIおよびビューに対して付与権限およびシノニムの作成権限を持つSYSTEMまたはSYSなど）として実行します。

SQL*Plusセッションから、次の構文を使用してpaamgurole.sqlスクリプトを実行します。

start $PA_TOP/sql/paamgurole.sql &role &un_apps   

例:

start $PA_TOP/sql/paamgurole.sql PMXFACE APPS   

paamgurole.lstファイルをチェックして、スクリプトが正常に完了したことを確認してください。

SQL*Plusセッションから、次の構文を使用してpaamguuser.sqlスクリプトを実行します。

start $PA_TOP/sql/paamguuser.sql &un_apps &name &role

例:

start $PA_TOP/sql/paamguuser.sql APPS JCLARK PMXFACE

paamguuser.lstファイルをチェックして、スクリプトが正常に完了したことを確認してください。

セキュリティ要件

Oracle Projects APIを使用して開発したインタフェースまたはアプリケーションのそれぞれは、ユーザーに情報の識別を求めるプロンプトを表示してから、グローバル変数を設定する必要があります。次のステップに従って、ユーザーが外部システムからOracle Projectsデータにアクセスする際に正しいセキュリティが確実に実装されるようにしてください。

ステップ1: ユーザーの認証

外部システムは、ユーザーにOracle Projectsユーザー名およびパスワードを求めるプロンプトを表示してから、このログイン情報を使用してOracle Projectsデータベースへの接続を確立します。接続の確立試行に3回失敗した場合、外部システムは異常終了し、エラー・メッセージが表示されます。

ステップ2: 職責の選択

Oracle Applications職責では、Oracle Projectsデータへのユーザーのアクセスが管理されるため、Oracle Applicationsユーザーは有効な職責のリストから特定の職責を選択する必要があります。Oracle Projectsでは、この情報がPA_USER_RESP_Vビューで提供されます。

注意: ビュー定義の更新済バージョンは、Oracle eTechnical Reference ManualのWebページにあります。

PA_USER_RESP_Vの列摘要は、Oracle Metalinkから入手可能なOracle eTRMにリストされています。

ステップ1で入力したログイン・ユーザー名によって、このビューで取得されたOracle Applications職責が管理されます。ユーザーが職責を選択すると、外部システムによって対応するUSER_IDおよびRESPONSIBILITY_IDも保存されます。RESPONSIBILITY_NAMEフィールドは表示専用で、保存する必要はありません。

注意: Oracle Applicationsではユーザー名が大文字で保存されるため、ログイン・ユーザー名をキーとして使用する前に大文字に変換する必要はあります。データベース接続文字列は大/小文字を区別しません。たとえば、ログイン・ユーザー名を「scott」と入力した場合は、「SCOTT」として保存されます。職責を表示するための標準的なPL/SQLコードは、次のようになります。

Login Name is stored in l_login_name
l_upper_login_name = UPPER(l_login_name)
Select RESPONSIBILITY_NAME, USER_ID,
RESPONSIBILITY_ID
from PA_USER_RESP_V where
USER_NAME = l_upper_login_name

注意: WHERE句ではUPPER(USER_NAME)を使用しないでください。WHERE句で式を使用すると、インデックスが無効になり、パフォーマンスが劣化します。必ず値をコード内で大文字に変換し、変換済の文字列をWHERE句で使用するようにしてください。

ステップ3: グローバル変数の設定

Oracle Projectsへのアクセスは、ユーザーの職責のみでなく、その職責に対するユーザーの組織によっても管理されます。データへのアクセス・レベルをユーザーの組織と確実に一致させるには、SET_GLOBAL_INFOというAPIを使用してグローバル変数を設定します。このAPIは、パブリックAPIパッケージPA_INTERFACE_UTILS_PUB内にあります。

SET_GLOBAL_INFOは、複数組織が実装された環境でデータにアクセスするために必要なグローバル変数を設定するPL/SQLプロシージャです。

引数P_RESPONSIBILITY_IDおよびP_USER_IDには有効な値を指定する必要があります。これらの引数にNULLまたは無効な値が含まれる場合、SET_GLOBAL_INFOによってエラー・ステータスが返されます。

次の表に、SET_GLOBAL_INFOのパラメータを示します。

これらのステップの完了後、タスクを完了するために必要な残りのOracle Projects API（CREATE_PROJECT、UPDATE_PROJECT、SELECT_RESOURCE_LIST、CREATE_DRAFT_BUDGETなど）が外部システムによって呼び出されます。

注意: 複数組織アクセス管理を実装していない場合、P_OPERATING_UNIT_IDパラメータを設定する必要はありません。その場合は、P_OPERATING_UNIT_IDパラメータによってデフォルトのMO（職責に割り当てられた営業単位値）が受け入れられます。

エラー・メッセージの処理

Oracle ProjectsのパブリックAPIでは、作業分解構造または予算に対するすべての更新、変更または追加に関して該当するエラー・メッセージが返されます。

エラー・メッセージの作成方法

APIはエラーの発生時に処理を停止しません。すべての項目が検証されてエラー・メッセージが生成されるまで、処理は続行されます。ただし、これらの処理のいずれかの途中でエラーが発生した場合、Oracle Projectsデータベースにレコードは保存されません。

エラー・メッセージには、各エラーに関連したデータ要素を識別するために必要なすべての情報が含まれています。この情報は次のとおりです。

WBSデータの場合:

• プロジェクト参照

• タスク参照

予算データの場合:

• プロジェクト参照

• タスク参照

• 予算タイプ

• 予算開始日

エラー・メッセージの表示

Oracle Projects APIを使用して外部システムとのリアルタイム統合とバッチ統合の両方を開発できるため、エラー・メッセージの表示は外部アプリケーションで処理する必要があります。

PA_INTERFACE_UTILS_PUB.get_messagesというAPIを使用して、エラー・メッセージを取得します。このAPIの詳細およびエラー・メッセージを取得するためのPL/SQLコードの例は、「GET_MESSAGES」を参照してください。

APIメッセージ

次の表に、Oracle Projects APIで使用されるメッセージを示します。

標準APIパラメータ

Oracle Projects APIのすべてに、公開プロシージャの大部分で使用される標準入出力パラメータのセットがあります。次の表に、これらの標準APIパラメータをそれぞれ説明します。

複合データ型を使用するAPI

この項は、複合データ型（レコードの配列など）を使用するOracle Projects APIを呼び出すためにPL/SQL 2.3以上を使用する場合にお読みください。

PL/SQL配列内で変数のサブセットに値を割り当てる場合は、最初にPL/SQLレコードに値を割り当ててから、PL/SQL配列にレコードを追加します。PL/SQLによって配列への割当が処理される方法の理由により、ここに記載された順序でステップを実行することが重要です。

次のサンプルPL/SQLコードは、CREATE_DRAFT_BUDGET APIでP_BUDGET_LINES_IN PL/SQL表に値を割り当てる方法を示しています。

DECLARE
--variables needed for API standard parameters
l_api_version_number         NUMBER        :=1.0;
l_commit                                         VARCHAR2(1)  := 'F';
l_return_status                        VARCHAR2(1);
l_init_msg_list                        VARCHAR2(1);
l_msg_count                                NUMBER;
l_msg_data                                        VARCHAR2(2000);
l_data                                                VARCHAR2(2000);
l_msg_entity                                VARCHAR2(100);
l_msg_entity_index                NUMBER;
l_msg_index                                NUMBER;
l_msg_index_out                        NUMBER;
l_encoded                                        VARCHAR2(1);
––
––variables needed for Oracle Project specific parameters
l_pm_product_code VARCHAR2(10);
l_pa_project_id NUMBER;
l_pm_project_reference VARCHAR2(25);
l_budget_type_code VARCHAR2(30);
l_change_reason_code VARCHAR2(30);
l_description VARCHAR2(255);
l_entry_method_code VARCHAR2(30);
l_resource_list_name VARCHAR2(60);
l_resource_list_id NUMBER;
l_budget_lines_in
PA_BUDGET_PUB.budget_line_in_tbl_type;
l_budget_lines_in_rec
PA_BUDGET_PUB.budget_line_in_rec_type;
l_budget_lines_out
PA_BUDGET_PUB.budget_line_out_tbl_type;
l_line_index NUMBER;
l_line_return_status VARCHAR2(1);
––
API_ERROR EXCEPTION;
––
BEGIN
––PRODUCT RELATED DATA
l_pm_product_code :=’SOMETHING’;
––
––BUDGET DATA
l_pm_project_reference := ’TEST’;
l_budget_type_code := ’AC’;
l_change_reason_code := ’ESTIMATING ERROR’;
l_description := ’New description –> 2’;
l_entry_method_code := ’PA_LOWEST_TASK_BY_PA_PERIOD’;
l_resource_list_id := 1001;

前の例では、PL/SQL表のサブセットに値を割り当てる方法を示しました。P_BUDGET_LINES_IN表内のPA_TASK_IDおよびRESOURCE_LIST_MEMBER_IDにのみ値を割り当てるには、最初にこれらの値をBUDGET_LINES_IN_RECに割り当ててから、BUDGET_LINES_IN_RECをBUDGET_LINES_IN PL/SQL表に追加します。次に例を示します。

--BUDGET LINES DATA
a := 5;
FOR i IN 1..a LOOP
if i = 1 THEN
l_budget_lines_in_rec.pa_task_id :=1496;
l_budget_lines_in_rec.resource_list_member_id:=1731;
elsif i = 2 THEN
l_budget_lines_in_rec.resource_list_member_id:=1732;
l_budget_lines_in_rec.pa_task_id := 1495;
elsif i = 3 THEN
l_budget_lines_in_rec.resource_list_member_id:=1733;
l_budget_lines_in_rec.pa_task_id := 1494;
elsif i = 4 THEN
l_budget_lines_in_rec.resource_list_member_id:=1734;
l_budget_lines_in_rec.pa_task_id := 1492;
elsif i = 5 THEN
l_budget_lines_in_rec.resource_list_member_id:=1735;
l_budget_lines_in_rec.pa_task_id := 1491;
end if;
l_budget_lines_in_rec.quantity:=97;
l_budget_lines_in_rec.period_name:= ’P06–03–95’;
l_budget_lines_in_rec.raw_cost:=300;
l_budget_lines_in(i) := l_budget_lines_in_rec;
END LOOP;
pa_budget_pub.create_draft_budget
( p_api_version_number => l_api_version_number
,p_msg_count => l_msg_count
,p_msg_data => l_msg_data
,p_return_status => l_return_status
,p_pm_product_code => l_pm_product_code
,p_pa_project_id=> l_pa_project_id
,p_pm_project_reference => l_pm_project_reference
,p_budget_type_code=> l_budget_type_code
,p_change_reason_code => l_change_reason_code
,p_description => l_description
,p_entry_method_code => l_entry_method_code
,p_resource_list_name => l_resource_list_name
,p_resource_list_id=> l_resource_list_id
,p_budget_lines_in => l_budget_lines_in
,p_budget_lines_out => l_budget_lines_out );

パラメータの名称表記法

Oracle ProjectsのAPIを使用すると、通常、識別コードまたは参照コードのいずれかでOracle Projectsエンティティを参照できます。たとえば、PROJECT_IDまたはPM_PROJECT_REFERENCEのいずれかを使用してプロジェクトを参照できます。

識別コードは、通常、Oracle Projectsによってエンティティに割り当てられたシステム生成の番号です。参照コードは、通常、エンティティの文字名または説明です。

Oracle Projects内にプロジェクトがすでに存在する場合は、参照コードのかわりに識別コードをAPIに渡すことで処理時間を短縮できます。APIによって識別コードが読み取られ、渡された参照コードが対応する識別コードに変換されてから実行されます。

APIによって処理に特定のエンティティが必要とされる場合は、エンティティの参照コード・パラメータまたはエンティティの識別コード・パラメータの（両方ではなく）いずれかを渡す必要があります。APIによって必須の識別コード・パラメータに対して参照コードが検出または導出されない場合は、エラー・メッセージが生成されて処理が中断されます。

Oracle Projects APIにパラメータを渡す際には、特定のAPIで必須のパラメータのみを渡すことができる名称表記法（次の例を参照）を使用します。名称表記法を使用すると、更新APIの処理が大幅に向上する場合があります。

重要: APIパラメータをNULLとして渡す場合、APIによってデータベース内の列がNULL値で更新されます。列が更新されないようにするには、対応するパラメータを渡さないでください。

名称表記法の例

API DELETE_PROJECTを使用すると、プロジェクトに対してPROJECT_IDまたはPM_PROJECT_REFERENCEのいずれかを渡すことができます。次の例では、プロジェクト識別コードP_PA_PROJECT_IDを渡します。次のSQL文では、オプション・パラメータ（P_INIT_MSG_LIST、P_COMMITなど）を省略しているため、これらのパラメータは表内で更新されません。

Delete_Project(p_api_version_number => 1.0
, p_msg_count => l_msg_count
, p_msg_data => l_msg_data
, p_return_status => l_return_status
, p_pm_product_code => l_product_code
, p_pa_project_id => 1043
);

Oracle Projectsビューで指定されるデータ

Oracle Projects APIでは、多数のOracle Projectsエンティティに対して識別コード・パラメータおよび参照コード・パラメータが使用されます。有効なパラメータ・データの取得を容易にするために、選択したビューによってOracle Projectsデータが指定されます。これらのビューは、各Oracle Projectsアプリケーションの詳細に関する章に示されています。

共通API

次のAPIは、すべてのモジュールで使用可能で、パブリックAPIパッケージPA_INTERFACE_UTILS_PUB内にあります。

GET_MESSAGES

GET_MESSAGESは、メッセージ・スタックからメッセージを取得するPL/SQLプロシージャです。APIによって実行中にエラーが1つのみ検出された場合は、標準API出力パラメータP_MSG_DATAを介してエラー・テキストが返されます。APIによって複数のエラーが検出された場合は、GET_MESSAGES APIを使用してメッセージを取得する必要があります。

次の表に、GET_MESSAGESのパラメータを示します。

複数のメッセージを処理するためのサンプル・コード

次のサンプルPL/SQLコードは、GET_MESSAGESを使用して外部アプリケーション内で複数のメッセージを処理する方法を示しています。

この例では、プロシージャPA_PROJECT_PUB.create_projectを使用しています。メッセージ・スタックの初期化は、この例のようにセッションの最初に行うことも、プロジェクトごとに行うこともできます。

メッセージはすべてPL/SQLメモリー内に保持されます。多数のエラー・メッセージが存在する可能性がある大規模なインストレーションでは、プロジェクトに関連したすべてのメッセージをファイルまたはデータベース内に保存し、メッセージ・スタックを頻繁に初期化できます。メッセージ・スタックを初期化するには、FND_MSG_PUB.initilizeを使用します。

この例に示すように、メッセージを表に一時的に挿入できます。あるいは、Cプログラムを実行しているかPL/SQLファイルI/Oユーティリティを使用している場合は、メッセージをログ・ファイルに書き出すことができます。メッセージをログ・ファイルに書き出す場合は、ログ・ファイル内にヘッダー情報を作成できます。その後、テキスト・エディタを起動してエラー・メッセージを即座に表示できます。

注意: このコード・サンプル内のパラメータp_msg_index_outは、Oracle AOLの既知の不具合に対する回避策として追加されました。このパラメータは、以降のリリースのOracle Projectsでは削除できます。754949より後のパッチを適用した後でコードが機能しなくなった場合は、このパラメータとして送信された値が原因である可能性があります。

サンプル・コードは次のとおりです。

-- Initialize the message stack
FND_MSG_PUB.initialize;
pa_project_pub.create_project
(p_api_version_number => l_api_version_number
,p_commit => l_commit
,p_init_msg_list => ’F’
,p_msg_count => l_msg_count
,p_msg_data => l_msg_data
,p_return_status => l_return_status
,p_pm_product_code => l_pm_product_code
,p_project_in => l_project_in_rec
,p_project_out => l_project_out_rec
,p_key_members => l_key_member_tbl
,p_class_categories => l_class_category_tbl
,p_tasks_in => l_tasks_in
,p_tasks_out => l_tasks_out);
IF l_return_status != ’S’
THEN
if l_msg_count > 0 THEN
for i in 1..l_msg_count loop
pa_interface_utils_pub.get_messages (
,p_encoded => ’F’
,p_msg_count => l_msg_count
,p_msg_data => l_msg_data
,p_data => l_data
,p_msg_index_out => l_msg_index_out );
–– Insert the messages from l_data into error_table
Insert into error_table (error_msg) values (l_data);
end loop;
end if;
END IF; 

GET_DEFAULTS

GET_DEFAULTSは、プログラムでVARCHAR2、NUMBERおよびDATE変数を初期化するために必要なデフォルト値を返すPL/SQLプロシージャです。このAPIに入力パラメータはありません。

次の表に、GET_DEFAULTSのパラメータを示します。

変数の値を条件付きで設定する場合は、デフォルト値が便利です。たとえば、プロジェクトの更新時に、Oracle Projectsで配分ルールを更新するかどうかに応じて、変数L_DISTRIBUTION_RULEの値を条件付きで設定できます。その場合は、次のようなPL/SQL文を使用します。

Pa_interface_utils.get_defaults (p_def_char => l_def_char,
p_def_num => l_def_num,
p_def_date => l_def_date,
p_return_status => l_return_status,
p_msg_count => l_msg_count,
p_msg_data => l_msg_data );
l_distribution_rule := l_def_char;
l_customer_id := l_def_num;
l_end_date := l_def_date;

GET_ACCUM_PERIOD_INFO

GET_ACCUM_PERIOD_INFOは、Oracle Projectsでプロジェクトが集約される最後の期間および現行レポート期間に関する情報を返すPL/SQLプロシージャです。外部システム内の実績がOracle Projects内の実績と一致しているかを確認する場合、このAPIを使用します。

次の表に、GET_ACCUM_PERIOD_INFOのパラメータを示します。

このPL/SQLの例では、GET_ACCUM_PERIOD_INFOの標準的な使用方法を示します。

Pa_interface_utils.get_accum_period_info
(p_api_version_number => l_api_version_number
l_msg_count => l_msg_count,
p_msg_data => l_msg_data,
p_return_status => l_return_status,
p_project_id => l_project_id,
p_last_accum_period => l_last_accum_period,
p_last_accum_start_date => l_last_accum_start_date,
p_last_accum_end_date => l_last_accum_end_date,
p_current_reporting_period => l_current_reporting_period,
p_period_start_date => l_period_start_date,
p_period_end_date => l_period_end_date);

Oracle Projectsでの処理の管理

外部システム内の情報とOracle Projects内の情報との整合性を確保するには、外部システムで発生するデータに対してユーザーが行える変更を制限します。Oracle Projectsの「管理処理」ウィンドウを使用して、制限する処理を選択します。制限可能な処理は次のとおりです。

• タスクの追加

• 予算の基本編成

• プロジェクトの削除

• タスクの削除

• 予算の更新

• プロジェクト日付の更新

• プロジェクト摘要の更新

• プロジェクト名の更新

• プロジェクト番号の更新

• プロジェクト組織の更新

• プロジェクト・ステータスの更新

• タスク日付の更新

• タスク摘要の更新

• タスク名の更新

• タスク番号の更新

• タスク組織の更新

情報の発生場所である外部システムまたは（予算関連処理の場合は）予算タイプを制限の基準にすることができます。

たとえば、外部システムからプロジェクトをダウンロードするとします。ビジネス・ルールに従って、常にソース・システムによってプロジェクトおよびタスク日付が保守されます。追加の予防措置として、外部システムで発生するプロジェクトおよびタスクのいずれもユーザーがOracle Projectsから削除できないようにします。これらの基準を満たすには、「管理処理」ウィンドウを使用して次の処理を指定します。

• プロジェクトの削除

• タスクの削除

• プロジェクト日付の更新

• タスク日付の更新

「管理処理」ウィンドウでこれらの処理を指定した場合、外部システムで発生したプロジェクトのプロジェクトおよびタスク日付をOracle Projectsユーザーが変更しようとすると、次のエラー・メッセージが表示されます。

 The value for this field originated in an external system. You cannot change it.

ユーザーがプロジェクトまたはタスクのいずれかを削除しようとすると、次のメッセージが表示されます。

 The record originated in an external system. You cannot delete it.

注意: 「管理処理」ウィンドウで選択する管理には有効日を指定できます。

APIプロシージャの使用方法

詳細に関する章では、外部システムで保守する情報に基づいてOracle Projectsで特定の関数を実行するために使用される各PL/SQLプロシージャについて説明しています。

一部のAPIでは、入出力パラメータとして複合データ型（レコード、レコードの表など）が使用されます。複合データ型は、Oracle 7.3.2で使用可能なPL/SQL 2.3機能です。複合データ型の詳細は、「複合データ型を使用するAPI」を参照してください。

複合データ型を使用できないツールおよび製品では、かわりに補足的なロード-実行-フェッチAPIを呼び出す必要があります。ロード-実行-フェッチAPIは、任意のツールとの互換性を得るために複合データ型パラメータなしで設計されたもので、次の関数を実行します。

• 標準データ型（VARCHAR2、NUMBERおよびDATE）を持つパラメータをINパラメータとして受け入れます。

• グローバル複合タイプ構造（レコードおよびテーブル）をロードします。

• 基礎となるビジネス・オブジェクトAPIを呼び出します（グローバル構造をINパラメータとして渡します）。

• グローバル・メッセージおよび結果表から結果を読み取ります。

• 必要時にメッセージを呼出し元プログラムに渡します（呼出し元プログラムは各メッセージを個別にフェッチします）。

プロシージャを次の順序で呼び出します。

1. 初期化。このステップにより、グローバル・データ構造が初期化されます。

2. ロード。この関数により、INパラメータPL/SQL表およびレコードがロードされます。入力構造がすべて移入されるまで、このステップを繰り返してください。

3. 実行。このステップにより、ビジネス・オブジェクトAPIを呼び出すビジネス・オブジェクトAPI COVERが呼び出されます。ビジネス・オブジェクトAPIでは、ロード・プロシージャ中に移入されたグローバル構造が使用されます。

4. フェッチ。このプロシージャにより、ビジネス・オブジェクトに対して一度に1つずつ出力値がフェッチされます。また、メッセージもフェッチされます。実行される関数に応じて、呼出し元プログラムはフェッチ・プロシージャを呼び出す場合と呼び出さない場合があります。

5. 消去。このステップにより、グローバル構造が消去され、呼出し元プログラムで使用されるグローバル・カウンタがすべてリセットされます。

Copyright © 1994, 2006, Oracle. All rights reserved.