ポータルデータリストウィジェットの JSON パラメーター
JSON パラメーターは、ポータルページ上のポータルデータリストウィジェットの要素を定義します。
| パラメーター | 説明 |
|---|---|
| categories | 各カテゴリには、フィルター基準を満たす顧客ケースビューのケース [sn_customerservice_case] テーブルのレコードセットが表示されます。 カテゴリごとに、pre_defined_filters と run_time_filters の事前定義フィルタータブから選択し、リストビューの列を設定し、カードビューに表示するフィルターを決定することができます。 |
| ID | カテゴリー条件スクリプトがウィジェットでカテゴリーを表示するか非表示にするかを決定できるようにする一意の識別子 |
| ラベル | ナビゲーションペインに表示されるカテゴリの名前です。 ラベルが入力されていない場合、カテゴリは表示されません。 |
| テーブル | カテゴリーが選択されたときにウィジェットに表示されるレコードのテーブルです。 デフォルトでは、このフィールドはケース [sn_customerservice_case] テーブルに設定されています。 |
| list_view | ウィジェットに表示する列またはフィールドのリストを定義するビューの名前です。 これらのビューの詳細については、「Create and delete views」を参照してください。 値を指定しない場合は、すべての列が表示されます。 |
| card_view_primary_column | カードの最初の列に表示される、定義されたテーブルのフィールドです。たとえば、最初の列にケース番号を表示できます。 |
| card_view_secondary_column | カードの 2 列目に表示される、定義されたテーブルのフィールドです。たとえば、ケースレコードの簡単な説明を表示できます。 このパラメーターはオプションです。 |
| card_view_additional_columns":"column1|column2|column3|column4 | カードの追加列として表示される、定義されたテーブルのフィールドペアです。 最大 4 つの列を追加できます。 このパラメーターはオプションです。 |
| query":"active=true" | カテゴリの下に表示されるレコードをフィルタリングするクエリです。 値を指定しない場合は、すべてのレコードが表示されます。 |
| glyph":"glyph_name" | ナビゲーションペインのカテゴリラベルの左側に表示されるグリフです。 指定するグリフ名は、次の URL からアクセスできる font-awesome ライブラリのものである必要があります。 現在サポートされている font-awesome ライブラリのバージョンは v4.7 です。別のバージョンのグリフ名を使用すると、画像は正しく表示されません。 注: グリフと画像の両方が定義されている場合は、画像が表示されます。 このパラメーターはオプションです。 |
| "image_name":"file_img" | カテゴリの左側に表示される画像です。 画像名は、画像 [db_image] テーブルから選択する必要があります。 注: グリフと画像の両方が定義されている場合は、画像が表示されます。 このパラメーターはオプションです。 |
| record_view_page | ウィジェットでアクセスされたレコードの詳細を含むページを表示する サービスポータル 。 このパラメーターはオプションです。 デフォルトでは、このフィールドは [ケース] (csm_ticket) ページに設定されています。 |
| pre_defined_filter "filter_name":"Value", |
選択したカテゴリで、[新規]、[クローズ済み]、[オープン]、または [情報待ち] ステータスのケースを表示します。これらのフィルターは、ウィジェットにタブとして表示されます。JSON コードにデフォルトで含まれるのは、[オープン] ケースと [クローズ済み] ケースのみです。使用可能な値:
このパラメーターはオプションです。 |
| run_time_filter | 定義されたテーブルの列とそのフィールドをランタイムフィルターとしてドロップダウンリストに表示します。これらのランタイムフィルターは、定義されたテーブルのさまざまなフィールドに基づいて、ウィジェットに表示されるケースレコードをフィルタリングします。たとえば、[優先度] を列として、[状況]、[連絡先]、または [更新済み (Updated)] をフィールドとして表示できます。 ランタイムフィルター値が列パラメーターと selection_type パラメーターに指定されていない場合、カテゴリにフィルターアイコンは表示されません。 このパラメーターはオプションです。 |
| selection_type | 選択タイプを表示します。使用可能なオプションは、次のとおりです。
|
| 値 "value":"4" |
定義されたテーブルの列パラメーターの値です。使用可能な値:
|
| "ranges": "label":"先月", "query":"<範囲条件>", |
label パラメーターと query パラメーターで定義されたクエリによるレコードのフィルタリングに使用されます。たとえば、先月、過去 3 か月、または過去 6 か月に更新されたケースレコードを表示できます。 範囲の構成は次のとおりです
このパラメーターはオプションです。 |
|
ログインしているユーザーのロールに従ってデータリストを表示するために使用されます。 ロールをアレイにリストして、複数のロールを同じビューにマップします。そのアレイ内のすべてのロールは同じビューを共有します。 たとえば、サポートエージェントとサービスマネージャーの両方に同じケースビューを表示する場合は、アレイ内の両方のロールに同じビュー ( ユーザーが複数のロールを持っている場合、最初に一致するビューが見つかりました。 このパラメーターはオプションです。 |
| "guest_view":"viewname | ゲストユーザーまたはログインしていないユーザーのアイテムを表示するために使用されます。ゲストユーザーに表示するビューをマップします。 ゲストユーザーがアイテムを利用できるようにするには、次の項目を公開に設定する必要があります。
詳細については、「ポータルデータリストウィジェットでのパブリックアクセスの構成」を参照してください。 このパラメーターはオプションです。 |
| "sort_by":"<列名>" | データリストの初回ロードソートに使用されます。 このパラメーターはオプションです。 |
| "sort_order":"<asc/desc>" | データリストをソートする順番。デフォルトは昇順です。 このパラメーターはオプションです。 |