REST 設計を本番環境に昇格させる
システムの新規部分を設計する場合は、新規コンテンツを本番環境に直接適用するのではなく、新規部分を開発インスタンスで設計し、十分にテストした後、それらの設計を実働に移すことが、常に推奨されます。これは、REST 動作を使用する機能を設計する場合に特に重要です。
REST Web サービスの動作の設計と使用については、「REST Web サービスへのオブジェクトのリンク」をご参照ください。本番環境への REST 設計の昇格について詳しくは、「Ivanti コミュニティ」をご参照ください。
REST Web サービスを使用して設計を作成すると、 動作をオブジェクトに追加したときに、新規オブジェクトのセットが作成されます。その後、これらのオブジェクトを本番環境に移す必要があります。このセクションでは、非本番環境から本番環境に設計を昇格させるのに必要な手順の概略を示します。Test to Live を使用することも、デザイン転送を使用することもできます。
Test to Live
Test to Live アプリケーションを使用すると、オブジェクト、ウィンドウ、REST 接続設定、および要求本文の定義を含め、設計全体を昇格させることができます。
REST ペイロードの本体は、オブジェクト本体 参照リスト オブジェクト内の参照リストに保存されます。Test to Live では、新規の参照リストのみが移行されます。そのため、これらの項目のいずれかを更新または削除した場合は、本番システムでそれらの項目を手動で更新する必要があります。Test to Live の使用について詳しくは、「Test to Live」をご参照ください。
デザイン転送
このセクションでは、「デザイン転送」を使用して REST 設計を本番環境に昇格させる方法を説明します。デザイン設計の詳細については、「設計転送によるデータベースからの設計のエクスポート」と「データベースへの項目のインポート.」をご参照ください。
デザイン転送では、REST Web サービスの資格情報や本体の内容定義は転送されません。そのため、デザイン転送によるインポートを完了後に以下の情報を入力できるように、手元に用意しておいてください。
- エンドポイントの URI
- [基本] または [API キー(プロバイダ)] を選択する場合は、認証の詳細情報
- 応答マッピングの詳細情報 (必要であれば)
- 要求本文の内容
要求本文オブジェクト用のオブジェクト設計やウィンドウ設計は、デザイン転送ファイルに追加しないでください。追加すると、インポートを実行しようとしたときにエラーが発生する原因になります。
エクスポート ファイルを2つ (オブジェクト設計用に1つと、ウィンドウおよび REST 本体データ用に1つ) 作成する必要があります。
エクスポート ファイル1「オブジェクト設計ファイル」を作成するには:
- ソース システムで [デザイン転送] コンポーネントを起動し、[ビジネス オブジェクト] フォルダに移動します。
- REST オブジェクトを作成した場所で、このモジュール フォルダを展開します。
- 最上位のオブジェクトである [属性] フォルダーを展開します。
- REST オブジェクトに関連するコレクションを選択し、 従属オブジェクトを含めます。
これにより、対象となる REST オブジェクトも選択されます。 - REST オブジェクトの [属性] フォルダを展開し、残りのすべての属性が選択されていることを確認します。
- [処理] リストで、[選択した項目をエクスポート] をクリックしてから、ファイルを保存します。
エクスポート ファイル2「ウィンドウおよび REST 本体データ」を作成するには:
- [デザイン転送] コンポーネントを再起動し、[参照] フォルダに移動します。
- [参照リスト] を展開し、REST オブジェクトが含まれているモジュール フォルダを展開します。
- オブジェクト フォルダを右クリックし、[選択]をクリックします。
要求本文のすべての定義が選択されます。または、フォルダを展開し、必要な定義を選択します。 - [ウィンドウ] フォルダに移動し、REST オブジェクトが含まれているモジュール フォルダを展開します。
- REST オブジェクト フォルダを展開し、必要なウィンドウを選択します。従属オブジェクトは含めないでください。
- [処理] リストで、[選択した項目をエクスポート] をクリックしてから、ファイルを保存します。
要求本文の定義の名前だけが転送されます。デザイン転送ファイルをインポートした後、要求本体定義を追加する必要があります。
これで2つのデザイン転送ファイルが作成されましたので、ターゲット システムに設計をインポートできます。
ターゲット システムに設計をインポートするには:
- ターゲット システムで [デザイン転送] コンポーネントを開き、[インポート] オプションを選択します。
- [処理] リストで、[インポート ファイルを開く] をクリックし、上記の手順で作成したファイル1を選択します。
- [参照されているオブジェクトが見つからない] という警告に対して、[値を未設定のままにする] を選択し、[インポート] を選択します。
ファイルが読み込まれ、REST Body オブジェクトが作成されます。 - [OK] をクリックします。
- [処理] リストで、[インポート ファイルを開く] をクリックし、上記の手順で作成したファイル2を選択します。
読み込まれた後、数多くの警告が表示されます。 - [システムのオブジェクト競合] 警告に対してはすべて、[新規作成しない...] を選択します。
- [参照されているオブジェクトが見つからない] という警告に対して、[値を未設定のままにする] を選択します。
- [インポート] をクリックします。
メインの REST オブジェクト用に選択したウィンドウが作成され、選択した REST 本体参照リストのエントリが自動入力されます。 - [OK] をクリックします。
インポートのファイル ベースの部分は完了です。次に、ターゲット システムへの手動更新を完了する必要があります。
設計転送の手動更新を完了するには:
- [オブジェクト デザイナー] で、REST オブジェクトを開きます。
- このオブジェクトで [REST Web サービス] 設定を表示し、接続の詳細情報を追加して、変更を保存します。
- [ウィンドウ マネージャ] で、モジュールに移動してから、REST オブジェクトに移動し、ウィンドウを右クリックして、[Web Access で利用できるようにする] を選択します。
- 要求本文オブジェクトを右クリックし、参照リストに適したウィンドウを作成します。
- 管理コンポーネントで、[参照リスト] ツリーを展開します。
- REST オブジェクトが含まれているモジュールを展開し、 要求本文の定義を必要に応じて更新します。ここで新しい定義を追加することもできます。
REST オブジェクトおよび関連付けられたデータを使用する準備ができました。