ナビゲーションに戻る

新規インターフェイスの登録

新規インターフェイスを登録するには、レジストリ ウィザード コンポーネント (HMCR_WZ_REGSRV) を使用します。

次の各トピックでは、新規インターフェイスを登録する方法について説明します。

ページ名

定義名

用途

レジストリ情報ページ

HMCR_WZ_STEP1

新規インターフェイスの情報を入力します。

インターフェイスの仕様ページ

HMCR_WZ_STEP2

新規インターフェイスの詳細を入力します。

実装ページ

HMCR_WZ_STEP3

インターフェイスを実装して、新規インターフェイスの登録を完了します。

レジストリ情報ページ (HMCR_WZ_STEP1) を使用して、新規インターフェイスの情報を入力します。

画像: レジストリ情報ページ

次の例では、レジストリ情報ページのフィールドおよびコントロールを説明します。このページのフィールドおよびコントロールの定義は後で説明します。

レジストリ情報ページ

フィールドまたはコントロール

定義

タイプ

インターフェイスのタイプを選択します。

注: このコンポーネントのページ内容と入力する情報は、選択するインターフェイスのタイプによって異なります。

名称

以下のガイドラインに従って、インターフェイスの内容を表す名前を入力します。

  • 1 語 (スペースなし)。

  • 大文字と小文字を混在させる。

  • インターフェイスのタイプに応じて、以下の形式の 1 つを使用する。

    登録するインターフェイスのタイプの応じて、<名詞>Exception、<名詞>Service、または<名詞>sqlView の形式にします。

    • "タイプ" インターフェイスの場合は、"<名詞>Type"。

    • "サービス" インターフェイスの場合は、"<動詞><名詞>"。

    • "例外" インターフェイスの場合は、"<名詞>Exception"。

    • インターフェイス ビューの場合は、"<名詞><名詞>"。

注: ここで入力する名前がレジストリ ツリーに表示されるため、インターフェイスの内容を表すわかりやすい名前にします。

バージョン

インターフェイスのバージョンを "n.n" の形式で指定します。

1 つのインターフェイスに、複数のアクティブなバージョンを割り当てることができます。

ステータス

このバージョンのインターフェイスのステータスを選択します。有効値は以下のとおりです。

  • リクエスト

    インターフェイスがパーティによってリクエスト済みですが、実装されていません。

  • 使用中

    インターフェイスが現在定義中です。

  • アクティブ

    インターフェイスを使用できる状態です。

  • 非推奨

    インターフェイスは最新のバージョンで置き換えられていますが、まだサポートされています。

  • 廃止

    選択したバージョンのインターフェイスは廃止されています。

オブジェクト オーナー ID

インターフェイス プロバイダを選択します。

範囲

インターフェイスの範囲を指定します。有効値は、[パブリック] (全てのアプリケーションで利用可能) または [プライベート] (プロバイダ アプリケーションでのみ利用可能) です。

親フォルダの選択

このリンクをクリックしてレジストリ フォルダ構造にアクセスし、新規インターフェイスを配置するフォルダを選択します。インターフェイスは機能別にグループ化します。

インターフェイスの仕様ページ (HMCR_WZ_STEP2) を使用して、新規インターフェイスの詳細を入力します。

画像: インターフェイスの仕様ページ

次の例では、インターフェイスの仕様ページのフィールドおよびコントロールを説明します。このページのフィールドおよびコントロールの定義は後で説明します。

インターフェイスの仕様ページ

注: このページの表示内容は、登録するインターフェイスのタイプによって異なります。このページでサービス インターフェイスを登録する方法については、「サービスの登録」を参照してください。

フィールドまたはコントロール

定義

実装からロード

実装済みのインターフェイスに基づいてインターフェイス ビューを定義する場合は、[実装からロード] リンクをクリックしてビューを選択します。各エレメントには、ビューのレコードのフィールドがロードされます。

注: このリンクが表示されるのは、インターフェイス ビューを登録する場合のみです。

連番

エレメントの発生順を指定します。

エレメント名

エレメント名を入力します。エレメントとは、インターフェイスのプロパティです。エレメント名は、1 語で大文字と小文字を混在させ、自己記述的な表記にする必要があります。

注: インターフェイス ビューを実装する場合は、ビューのレコードの各フィールドに対応するように、エレメントを追加する必要があります。

注: サービス インターフェイスのエレメントは、指定した位置のパラメータを表す記述的なアイテムになります。エレメントの位置はパラメータに対応する必要がありますが、PeopleSoft フィールド名にする必要はありません。

型のカテゴリ

エレメントのカテゴリを選択します。カテゴリでは、エレメントのデータ タイプが単純型か複合型かを指定します。単純データ タイプは、システム標準のデータ形式です。複合データ タイプは、レジストリに既に登録されている他のインターフェイス タイプを参照します。

注: "例外" エレメントの場合は、常に [複合] を選択します。

注: インターフェイス ビューの場合は、[単純] が選択され、それ以外は選択できません。

単純型

エレメントが単純タイプの場合は、エレメントのシステム標準のデータ形式を選択します。有効値は以下のとおりです。

  • xsd:string

  • xsd:date

  • xsd:number

  • xsd:boolean

複合型

エレメントが複合タイプの場合は、このエレメントで参照する登録済みのエレメントを選択します。

注: インターフェイスが "例外" の場合は、サービス フレームワーク フォルダから、"ExceptionType" を選択する必要があります。

最小回数

このエレメントの発生可能な最小回数を指定します。エレメントの発生が任意の場合は [0]、1 回以上発生させる必要がある場合は [1] を選択します。

注: "例外" エレメントの場合は、[1] を選択する必要があります。

最大回数

このエレメントの発生可能な最大回数を指定します。

注: "例外" エレメントの場合は、[1] を選択する必要があります。

サービスの登録

サービスを登録する場合は、以下の 4 つのグループ ボックスに情報を入力します。

  • DoService リクエスト

    サービス インターフェイスが情報のリクエストに使用される場合は、このグリッドのフィールドを使用して、サービスのリクエストパラメータを定義します。

  • DoService 応答

    サービス インターフェイスが情報のリクエストの応答に使用される場合は、このグリッドのフィールドを使用して、サービスのリクエスト パラメータを定義します。

  • 例外

    サービス インターフェイスで定義する例外を全て表示します。選択できる例外は、レジストリに既に追加されている例外のみです。

  • 警告

    サービスの実行中にログに記録される全ての警告とメッセージをコンシューマに理解できる形式で表示します。

実装ページ (HMCR_WZ_STEP3) を使用して、インターフェイスを実装し、新規インターフェイスの登録を完了します。

画像: 実装ページ

次の例では、実装ページのフィールドおよびコントロールを説明します。このページのフィールドおよびコントロールの定義は後で説明します。

実装ページ

注: このページの表示内容は、登録するインターフェイスのタイプによって異なります。このページでインターフェイス ビューを登録する方法については、「インターフェイス ビューの登録」を参照してください。

フィールドまたはコントロール

定義

運用運用ノード

このフィールドは、サービス インターフェイスを登録する場合にのみ表示されます。

サービスの運用場所を指定します。有効値は、[ローカル] (コンシューマと同じデータベースにある場合) または [リモート] (コンシューマのデータベースと別の場所にある場合) です。

サービスがリモートの場合は、運用ノードを選択します。

パッケージのルート

プロバイダのルート パッケージを選択します。ルート サフィックスは、登録するインターフェイスのタイプによって異なります。

  • タイプ インターフェイスの場合は、"<オーナー ID>_TYPES"。

  • 例外インターフェイスの場合は、"<オーナー ID>_EXCEPTIONS"。

  • サービス インターフェイスの場合は、"<オーナー ID>_SERVICES"。

クラス パス

指定したタイプ クラスの適切なバージョンのクラス パスを選択します。

実装アプリケーション クラス

クラスを実装したら、レジストリに戻り、インターフェイスのアプリケーション クラスを選択します。最初にインターフェイスを登録するときには値を選択せず、インターフェイスを実装してから選択してください。

登録したインターフェイスの実装」を参照してください。

注: サービス インターフェイスを実装する場合、このフィールドに入力するのは、サービスがローカルの場合のみです。

クラス コードを作成

このボタンをクリックすると、実装アプリケーション クラスの PeopleCode が生成されます。生成されたコードをコピーして、インターフェイスの実装時にアプリケーション クラス オブジェクトに貼り付けます。

登録したインターフェイスの実装」を参照してください。

注: サービス インターフェイスを登録する場合、このボタンは表示されません。

登録

このボタンをクリックすると、インターフェイス定義が登録されます。定義が正常に登録されると、インターフェイスの IUD が表示されます。

インターフェイス ビューの登録

フィールドまたはコントロール

定義

インターフェイスの表示

このインターフェイスの sqlView を実装したら、このページに戻り、このインターフェイス ビューに対応するビューを選択します。

登録したインターフェイスの実装」を参照してください。

関連言語のインターフェイス ビュー

関連言語ビューが存在する場合は、アプリケーション デザイナの実装で定義した関連言語ビューが表示されます。