アイテム ID
定義と用法
アイテム ID コンポーネントは、特定のアイテムについての基本的な情報 (ID 情報) を表示できるウィジェットです。情報は、通常はアイテムページの上部にあるパネルに表示されます。パネルには、アイテムのイメージ、プライマリタイトル、セカンダリタイトル、セカンダリアイコン、およびさまざまな ID 属性が表示されます。セカンダリアイコンはアイテムタイプを示し、Windchill アイコンを使用するように設定できます。また、これにはアイテムに対して実行可能な操作が含まれている埋め込み操作バーも含まれています。
「アイテム ID」コンポーネントのサンプルイメージを以下に示します。
次の方法で、アイテム ID コンポーネントを設定できます。
• プライマリタイトルとセカンダリタイトルを定義
• 埋め込み操作バーで使用可能な操作を設定
• 表示する ID 属性を定義
• イメージを表示してデフォルトのイメージパスを定義するかどうかを選択
• セカンダリアイコンを表示するかどうかを選択
• パネルを折りたためるようにするかどうかを選択
バインドプロパティ
入力 | ||||
|---|---|---|---|---|
プロパティ名 | 説明 | プロパティタイプ | ||
Input | バックエンドシステムからフェッチするデータの識別に使用します。以下にサンプルを示します。 サンプル JSON: { "version":"1.0.0", "data":[ { "adapter":{ "thingName":"PTC.WCAdapter", "instanceName":"windchill" }, "itemListsData":[ { "objectType":"PTC.ChangeMgmt.ChangeRequest", "items":[ { "id":{ "value":"OR:wt.change2.WTChangeRequest2:439476" } } ] } ] } ] }
| CCOフォーマットの JSON | ||
TailoringName | アイテム ID コンポーネントのインスタンスを一意に識別します。この値は、その特定のインスタンスの調整情報を検索するために内部で使用されます。 このバインドプロパティは、カスタムタスクに専用の調整ページがある場合にのみ使用します。 | String | ||
コンフィギュレーションプロパティ
次のテーブルとイメージは、このコンポーネントの設定に使用される JSON プロパティを示しています。
コンフィギュレーションの構造の詳細については、コンポーネントのコンフィギュレーション構造を参照してください。
サブプロパティの詳細については、サブプロパティとコンテナキーを参照してください。
プロパティ名 | 説明 | プロパティタイプ | デフォルト値 | 必須またはオプション | |||
|---|---|---|---|---|---|---|---|
actionBarConfiguration | ユーザーインタフェースの操作バーに表示される操作。詳細については、操作バーのコンポーネントを参照してください。 | なし | オプション | ||||
attributes | バックエンドシステムからデータをフェッチする必要がある属性のリスト。
| なし | オプション | ||||
defaultImagePath | イメージをフェッチするデフォルトのパス。 このプロパティは、showImage のサブプロパティであり、showImage が true に設定されている場合にのみ関連します。そのコンテナキーは itemIdentityShowImageDefinition です。 | なし | showImage が true に設定されている場合は必須です。 | ||||
enableExpandCollapse | ユーザーインタフェースで「アイテム ID」パネルを折りたたみおよび展開できるようにするかどうかを決定します。 true に設定すると、パネルを折りたたんで、プライマリタイトルだけを表示したり、該当する場合は操作バーを表示することができます。 false に設定した場合 、パネルは折りたたみできず、常に完全に展開されます。 | true | 必須 | ||||
primaryTitle | 「アイテム ID」パネルの最上部に表示されるメインタイトル。 | なし | 必須 | ||||
secondaryTitle | セカンダリタイトル。「アイテム ID」パネルのプライマリタイトルの下に表示されます。 | なし | 必須 | ||||
showImage | 「アイテム ID」パネルにイメージを表示するかどうかを指定します。 オプション : true、false。 true に設定した場合、イメージがパネルに表示されます。defaultImagePath プロパティを使用してイメージパスを定義します。 false に設定した場合、イメージは表示されません。 | なし | 必須 | ||||
showSecondaryIcon | セカンダリアイコンを表示するかどうかを指定します。 オプション : true、false。 true に設定した場合、セカンダリアイコンがパネルに表示されます。false に設定した場合、セカンダリアイコンは表示されません。 | false | 必須 | ||||
サンプルコンフィギュレーション
カスタマイズサービス
コンフィギュレーションに加え、コンポーネントごとにビジネスロジックを拡張してコンポーネントをカスタマイズできます。各コンポーネントのビジネスロジックには、拡張およびオーバーライド可能な Thing Template 内のサービスが含まれています。次のテーブルは、このコンポーネントのオーバーライド可能なサービスの詳細を示しています。
各サービスの戻り値とパラメータの例については、カスタマイズサービスの入力/出力の例を参照してください。
名前 | 説明 |
|---|---|
GetConfigurations | コンポーネントの実装で使用可能なコンフィギュレーションを返します。 パラメータ: なし 戻り値: JSON |
GetImplementationLabel | コンポーネントのローカライズ名、またはローカライズ名を取得するために使用できるトークンを返します。このローカライズ名は Mashup Builder のユーザーインタフェースに表示されます。 パラメータ: なし 戻り値: String |
ProcessAttributesConfiguration | 属性のコンフィギュレーションを処理し、属性を既成の属性と追加の属性に分割します。 次の形式のキーと値のペアを含む JSON を返します。 • OOTBAttributes : OOTB Attributes configuration CCO JSON • additionalAttributes : Additional Attributes configuration CCO JSON 属性は、そのオブジェクトタイプに基づいて、既成の属性と追加の属性に分割されます。.Custom.Adapter または .Custom.Implementation で終わるオブジェクトタイプを持つ属性は、追加の属性として扱われます。その他すべての属性は既成の属性と見なされます。 アイテム ID コンポーネントは、オブジェクトタイプが .Custom.Implementation で終わる属性のみの使用をサポートしていません。オブジェクトタイプが異なる属性を 1 つ以上使用してください。 パラメータ: attributes (必須) - 既成の属性と追加の属性のリストを含む JSON。 configuration (オプション) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 戻り値: CCOフォーマットの JSON |
GetItemIdentityAttributes | コンフィギュレーションをチェックし、必要なその他の属性を追加してから、GetAttributeValues を呼び出して、バックエンドシステムからすべての属性値をフェッチします。 パラメータ: input (必須) - バックエンドシステムからフェッチするデータの入力 ID およびバックエンドシステムのアダプタ情報を含む、CCOフォーマットの JSON。 configuration (オプション) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 attributes (必須) - コンフィギュレーションで定義されているか、調整によって設定された、既成の属性のリストを含む JSON。 戻り値: JSON |
GetAttributesValues | 属性とその値を含む JSON を返します。 パラメータ: input (必須) - バックエンドシステムからフェッチするデータの入力 ID およびバックエンドシステムのアダプタ情報を含む、CCOフォーマットの JSON。 configuration (オプション) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 attributes (必須) - 既成の属性と追加の属性のリストを含む JSON。 戻り値: CCOフォーマットの JSON |
GetAdditionalAttributes | 使用可能な既成の属性のリストに追加される、追加の属性のリストを返します。 パラメータ: なし 戻り値: JSON |
実装定義