RESTデータプロバイダーを使用してフォームオプションを入力する
［リストから選択］ フィールドには、多くのオプションを含めることができます。 これらのオプションは、Liferay DXPに登録されているJSON Web サービスや、その他のサードパーティーのREST Webサービスを使用して、自動的に提供することができます。 データプロバイダーの一般的な説明については、データプロバイダーの概要を参照してください。 RESTデータプロバイダーをフォームに適用するために、JSONウェブサービスを呼び出し、そこからデータを引き出すようにデータプロバイダーを設定し、フォームでデータプロバイダーを使用する方法を学びます。
前提条件
一般的なニーズは、［選択］フィールドにオプションのリストを入力することです。たとえば、フォームで個人情報を収集する場合は、ユーザーの国が必要です。
-
国 という 単一選択フィールドを含むフォームを作成します。
-
次に、
get-countriesJSON Webサービスを使用します（2つありますが、どちらか一方を使用してください）。- ローカルでLiferayを動かしている場合は、 http://localhost:8080/api/jsonwsに移動してください。
- 「get-countries］と検索します。
［Invoke］ をクリックします。
これで、国のリストが使用可能になりました。
ローカルネットワーク上のデータへのアクセスを有効にする
デフォルトでは、ユーザーはデータプロバイダーがローカルネットワーク上のURLを使用するように設定することはできません。 このデフォルト設定は本番環境におけるセキュリティにとっては適切ですが、テストがしずらくなります。
データプロバイダーからローカルネットワークへのアクセスを有効にするには：
-
［Control Panel］ → ［Configuration］ → ［System Settings］ に移動します。
-
［コンテンツ & データ］の下にある ［データプロバイダー］ をクリックします。
-
［ローカルネットワークへのアクセス］ チェックボックスにチェックを入れます。
-
完了したら、 ［Save］ をクリックします。
基本的なRESTデータプロバイダーの追加
Countries of the World データプロバイダーを追加するには：
-
プロダクトメニュー（
）を開き、 ［サイト管理］ メニューのコンパスアイコン（
）をクリックします。 -
フォームを作成するサイトを選択します。
-
［コンテンツ & データ］ → ［フォーム］ をクリックします。
-
［データプロバイダー］ タブをクリックします。
-
追加ボタン（
）をクリックし、RESTデータ・プロバイダーを追加します。 -
このデータを入力してください：
- 名前 : Countries of the World
- URL :
http://localhost:8080/api/jsonws/country/get-countries/ - ユーザー名 :
adminuser@liferay.com - パスワード : adminuserpass
- タイムアウト : 1000
- 出力のラベル : Country Name
- 出力パス :
$..nameCurrentValue - 出力タイプ : List
-
完了したら、 ［Save］ をクリックします。
RESTデータプロバイダーのフィルターとしての入力の使用
上記の例では、 Select from List フィールド に入力するために、単一の出力のみを使用しています。 RESTプロバイダーからのレスポンスをフィルタリングする場合は、Inputフィールドを使用します。
この例では、別のデータプロバイダーを使用し、世界の国々に対して地域（例えば、アメリカ、ヨーロッパ、オセアニア）フィルタを適用しています：
-
このデータを入力してください：
- 名前 :
restcountries - URL :
https://restcountries.com/v3.1/region/{region}?fields=name - Input Parameter : 地域
- インプットタイプ : Text
- 入力ラベル : Region
- 出力パス :
$..name.common - 出力タイプ : List
- 出力ラベル : 国名
これらの値の詳細については、 データプロバイダーの概要参照してください。
- 名前 :
この例では入力パラメータを使用しているため、APIコールを正しく解決するためには、データプロバイダーに入力を提供する必要があります。 テキストフィールドの値を入力としてデータプロバイダに送信するオートフィルルルールを設定することができます。 例として、 Autofill Rule のドキュメントを参照してください。
データプロバイダーへの権限付与
データプロバイダーが提供するオプションを表示するには、ユーザーはデータプロバイダーに対して表示権限を持つ必要があります。 例えば、ゲストがフォームに入力する必要がある場合、閲覧権限を付与します。
データプロバイダーの権限を設定するには：
-
［サイト管理］ → ［コンテンツ & データ］ → ［フォーム］ に移動します。
-
［データプロバイダー］タブをクリックします。
-
アクションボタン（
）をクリックし、データプロバイダーの横にある ［権限設定］ をクリックします。
-
必要な権限を付与します。
-
完了したら、 ［保存］ をクリックします。
選択フィールドでのデータプロバイダーを使用する
データプロバイダーを設定したら、それを使用して［リストから選択］フィールドを入力します。
-
［コンテンツ & データ］ → ［Form］ をクリックします。
-
［リストから選択］ フィールドをフォームにドラッグします。
-
［リストを作成］ドロップダウンメニューから ［データプロバイダーから］ を選択します。
-
［データプロバイダーを選択］ドロップダウンメニューから ［Countries of the World］ を選択します。
-
［出力パラメータの選択］ドロップダウンメニューから ［Country Name］ を選択します。
-
完了したら、［フォームを保存］クリックします。
データプロバイダは、正しい権限を持ってフォームにアクセスしているユーザに対して、セレクトフィールドを生成するようになりました。
データプロバイダーのエラーのトラブルシューティング
データプロバイダーの障害によるエラーを発見するには、これらのサービスに対してログレベルを設定します。
- コントロールパネル → システム → サーバ管理 へ行きます。
- ［ログレベル］ タブをクリックします。
- ロギングカテゴリ
com.liferay.dynamic.data.mapping.data.provider.internal.DDMDataProviderInvokerImplを追加し、 WARN レベルでログを記録するように設定します。 完了したら 保存 します。 - ロギングカテゴリ
com.liferay.dynamic.data.mapping.form.field.type.internal.DDMFormFieldOptionsFactoryImplを追加し、 WARN レベルでログを記録するように設定します。 完了したら 保存 します。
データプロバイダーでエラーが発生した場合、コンソールが警告メッセージを送信するようになりました。