アイテムリスト
定義と用法
アイテムリストコンポーネントは、グリッドビューのデータセットからアイテムのリストを表示できる組み込みマッシュアップです。また、エンドユーザーは、リストのサーチ、並べ替え、フィルタのほか、リスト全体または特定のリストアイテムに対して操作を実行できます。
アイテムリストコンポーネントのサンプルイメージを以下に示します。
次の方法で、アイテムリストコンポーネントを設定できます。
• サーチとフィルタを有効化または無効化
• 初期のフィルタと並べ替えのオプションを設定
• グリッド内の行の最大数を設定
• アイテムをリストから選択できるかどうかを定義し、できる場合は複数のアイテムを選択できるかどうかを定義
• 埋め込み操作バーで使用可能な操作を設定
• エクスポート操作を表示するかどうかを選択
フィルタボックスまたはサーチボックスを使用して、アイテムリストをフィルタまたはサーチできます。ただし、フィルタボックスとサーチボックスがコンフィギュレーションで有効になっていない場合は、フィルタとサーチを使用できません。列タイトルをクリックして、その列によってリストを並べ替えることができます。並べ替え順序を逆にするには、もう一度列タイトルをクリックします。
アイテムリストコンポーネントには、埋め込みの操作バーコンポーネントが含まれています。操作バーを設定することにより、1 つまたは複数のリストアイテムに対して操作を実行するなど、追加の機能を有効にできます。詳細については、操作バー (ベータ)を参照してください。デフォルトでは、アイテムリストには、フィルタ基準に一致するすべてのアイテムを CSV ファイルにエクスポートする「エクスポート」操作が含まれています。
アイテムリストには、「デフォルトに戻す」ボタンもあります。「デフォルトに戻す」ボタンは、列の並べ替え、スワップ、表示/非表示など、フィルタ、サーチ、グリッドレベルの操作のデフォルト設定を回復します。
バインドプロパティ
入力 | ||
|---|---|---|
プロパティ名 | 説明 | プロパティタイプ |
input | バックエンドシステムからフェッチするデータの識別に使用します。 入力が必要な場合、コンフィギュレーションプロパティ waitForInput を true に設定します。 サンプル JSON: { "version":"1.0.0", "data":[ { "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" }, "itemListsData":[ { "items":[ { "id":{ "value":"OR:wt.workflow.work.WorkItem:1432583" } } ], "objectType":"PTC.Workflow.WorkItem" } ] } ] } | CCOフォーマットの JSON |
tailoringName | アイテムリストコンポーネントのインスタンスを一意に識別します。この値は、その特定のインスタンスの調整情報を検索するために内部で使用されます。 このバインドプロパティは、カスタムタスクに専用の調整ページがある場合にのみ使用します。 | |
出力 | ||
|---|---|---|
プロパティ名 | 説明 | プロパティタイプ |
totalItemsNumber | サーチ基準およびフィルタ基準と一致するリストアイテムの数。 | Integer |
selectedItems | 選択されているグリッドアイテムとその属性を識別するために使用します。このプロパティは、ほかのコンポーネントの input バインドプロパティにバインドできます。 サンプル JSON: { "timeStamp":"2019-08-25 18:53:33.476", "data":[ { "itemListsData":[ { "items":[ { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143921" } }, { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143928" } } ], "objectType":"PTC.Workflow.WorkItem" } ], "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" } } ], "version":"1.0.0", "statusMessage":"OK", "status":"200" } | CCOフォーマットの JSON |
コンフィギュレーションプロパティ
次のテーブルは、このコンポーネントの設定に使用される JSON フィールドを示しています。
コンフィギュレーションの構造の詳細については、コンポーネントのコンフィギュレーション構造を参照してください。
サブプロパティの詳細については、サブプロパティとコンテナキーを参照してください。
プロパティ名 | 説明 | プロパティタイプ | デフォルト値 | 必須またはオプション | |
|---|---|---|---|---|---|
actionBarConfiguration | 埋め込み操作バーのコンフィギュレーション。詳細については、操作バー (ベータ)を参照してください。 | なし | オプション | ||
attributes | 表示する属性。これらはグリッドに列タイトルとして表示されます。 | なし | 必須 | ||
defaultSelectedFilterValue | 最初に選択した値、またはフィルタ基準となる値。空白の場合、デフォルトのフィルタはありません。 このプロパティは、filterFields のサブプロパティであり、filterFields がコンフィギュレーションに含まれている場合にのみ関連します。そのコンテナキーは itemListFilterFieldDefinition です。 | なし | オプション | ||
defaultSortDirection | デフォルトの並べ替え方向。オプション: 昇順を示す asc と降順を示す dsc。空白の場合、並べ替え方向は昇順になります。 このプロパティは、defaultSortField のサブプロパティであり、defaultSortField がコンフィギュレーションに含まれている場合にのみ関連します。そのコンテナキーは itemListDefaultSortFieldDefinition です。 | asc | オプション | ||
defaultSortField | 並べ替えの基準となる初期の列。空白の場合、最初の列によってアイテムリストが並べ替えられます。 | なし | オプション | ||
enableSearch | サーチフィールドを表示するかどうか。オプション : true、false。 | true | オプション | ||
filterFields | データのフィルタに使用するフィールドの、バックエンドシステムでの ID。空白にした場合、データをフィルタするオプションはありません。 | なし | オプション | ||
filterLabelOverride | GetItems サービスから返される表示値をオーバーライドする、フィルタのラベル。 このプロパティは、filterFields のサブプロパティであり、filterFields がコンフィギュレーションに含まれている場合にのみ関連します。そのコンテナキーは itemListFilterFieldDefinition です | なし | オプション | ||
implementationConfigurations | コンポーネントをさらにカスタマイズするために、アプリケーションビルダーがその実装に必要な追加の値を渡す際の開始点。 | なし | オプション | ||
label | アイテムリストのタイトル。 | [[PTC.ItemList]] | オプション | ||
maxNumberOfRowsInGrid | グリッド領域に表示される行の最大数。10,000 より小さい値を入力することをお勧めします。 | 500 | オプション | ||
searchHintText | サーチボックスに表示するヒントテキスト。 このプロパティは、enableSearch のサブプロパティであり、enableSearch が true に設定されている場合にのみ関連します。そのコンテナキーは itemListSearchDefinition です。 | Find Item | オプション | ||
selectionType | 一度に選択できるグリッド内のアイテムの数を指定します。オプション: • none - グリッドアイテムを選択できません • single - 一度に 1 つのグリッドアイテムを選択できます • multi - 1 つまたは複数のグリッドアイテムを一度に選択できます | multi | オプション | ||
showExportAction | エクスポート操作を有効または無効にします。オプション : true、false。 | true | オプション | ||
waitForInput | グリッドに設定されているアイテムの読み込みを開始する前に、実行時に値がアイテムリストの入力マッシュアップパラメータに渡されるのを待つかどうかを指定します。オプション : true、false。 | false | オプション | ||
サンプルコンフィギュレーション
カスタマイズサービス
コンフィギュレーションに加え、コンポーネントごとにビジネスロジックを拡張してコンポーネントをカスタマイズできます。各コンポーネントのビジネスロジックには、拡張およびオーバーライド可能な Thing Template 内のサービスが含まれています。次のテーブルは、このコンポーネントのオーバーライド可能なサービスの詳細を示しています。
各サービスの戻り値とパラメータの例については、カスタマイズサービスの入力/出力の例を参照してください。
 | ビジネスロジック実装コンポーネントからアイテムリストコンポーネントに JSON オブジェクトをCCOフォーマットで返す場合、1 つのオブジェクトタイプの属性のみを含めてください。現在、アイテムリストでは、異なるオブジェクトタイプの属性はサポーされていません。 |
名前 | 説明 |
|---|---|
GetConfigurations | コンポーネントの実装で使用可能なコンフィギュレーションを返します。 パラメータ: なし 戻り値: JSON |
GetImplementationLabel | コンポーネントのローカライズ名、またはローカライズ名を取得するために使用できるトークンを返します。このローカライズ名は Mashup Builder のユーザーインタフェースに表示されます。 パラメータ: なし 戻り値: String |
GetItems | バックエンドシステムからのアイテムのリストを返します。 アイテムリストのカスタム実装を作成するには、このサービスをオーバーライドしてカスタムデータを取得します。 パラメータ: input (オプション) - バックエンドシステムからフェッチするデータの入力 ID およびバックエンドシステムのアダプタ情報を含む、CCOフォーマットの JSON。 このパラメータを使用する場合は、waitForInput コンフィギュレーションプロパティが true に設定されていることを確認してください。 configuration (必須) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 戻り値: CCOフォーマットの JSON |
InitializeFilters | コンフィギュレーション内の各フィルタフィールドのフィルタタイプ定義を返します。 パラメータ: input (オプション) - バックエンドシステムからフェッチするデータの入力 ID およびバックエンドシステムのアダプタ情報を含む、CCOフォーマットの JSON。 configuration (必須) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 戻り値: CCOフォーマットの JSON |
DefHookImplementationConfigurationDefinitionGroup | 実装のカスタムコンフィギュレーションを含む実装固有の定義を返します。 パラメータ: なし 戻り値: JSON 配列 |
DefHookImplementationAttributesDefinition | 選択された属性の実装固有の定義を返します。 パラメータ: なし 戻り値: JSON 配列 |
DefHookMaxRowsProperties | グリッド領域に表示される行の最大数のプロパティを返します。 パラメータ: なし 戻り値: JSON |
実装定義