アイテム ID
定義と用法
アイテム ID の再使用可能なコンポーネントは、特定のアイテムについての基本的な情報 (ID 情報) を表示することができるウィジェットです。情報は、通常はアイテムページの上部にあるパネルに表示されます。パネルには、アイテムのメインタイトル、セカンダリタイトル、およびさまざまな ID 属性が表示されます。また、アイテムに対して実行可能な操作が含まれている埋め込み操作バーも表示されます。パネルの左上にある矢印を使用して、アイテム ID パネルを展開したり折りたたんだりすることができます。折りたたんだ場合、プライマリタイトルと操作バーのみが表示されます。
次の方法で、アイテム ID の再使用可能なコンポーネントを設定できます。
• 表示する ID 属性を定義
• 埋め込み操作バーで使用可能な操作を設定
• メインタイトルとセカンダリタイトルを定義
以下のサンプルイメージは、アイテム ID の再使用可能なコンポーネントを示します。
タスク ID は、アイテム ID の再使用可能なコンポーネントで使用できる唯一の定義済みコンフィギュレーションです。詳細とサンプルコンフィギュレーションについては、「タスク ID」を参照してください。
バインドプロパティ
アイテム ID コンポーネントには、バインドに使用可能な 2 つのプロパティがあります。
• Input - この JSON は、バックエンドシステムからデータをフェッチする必要がある入力 ID です。この情報は CCO (Common Communication Object) フォーマットで指定されます。次に例を示します。
{
"version":"1.0.0",
"data":[
{
"adapter":{
"thingName":"PTC.WCAdapter",
"instanceName":"windchill"
},
"itemListsData":[
{
"objectType":"PTC.ChangeMgmt.ChangeRequest",
"items":[
{
"id":{
"value":"OR:wt.change2.WTChangeRequest2:439476"
}
}
]
}
]
}
]
}
• TailoringName - この文字列は、コンポーネントのインスタンス名です。これは調整と密接に結合されています。TailoringName は、各コンポーネントに対して保存されている調整情報をフェッチするために使用します。
コンフィギュレーションフィールド
次のテーブルは、このコンポーネントの設定に使用される JSON フィールドを示しています。
プロパティ名 | 説明 | タイプ | デフォルト値 | 必須またはオプション |
attributes | バックエンドシステムから予期されるデータのプロパティ名。サブプロパティを参照してください: | MultiValueSelector | なし | オプション |
id | バックエンドシステムにおける属性のプロパティ名の識別子。たとえば、“Category#Display” です。 | String | "" | 必須 |
ordinal | コンポーネントに表示される属性の順序。0 は初期の左端の位置を示します。 | Integer | なし | オプション |
objectType | 属性をフェッチするオブジェクトタイプ。 | String | "" | 必須 |
adapter | バックエンドシステムのソースコンフィギュレーション。サブプロパティを参照してください: | JSON | なし | 必須 |
instanceName | コネクタインスタンス。バックエンドシステムへの接続に使用するコネクタを意味します。 | String | "" | 必須 |
thingName | データの取得元となるバックエンドシステムまたはアダプタの名前。 | String | "" | 必須 |
inTailoring | 調整ページでアイテム ID コンポーネントが調整可能になっているかどうか。オプション : true、false。 | Boolean | false | オプション |
title | アイテム ID パネルの最上部に表示されるメインタイトル。サブプロパティを参照してください: | なし | なし | 必須 |
pattern | コンポーネントのユーザーインタフェースにプライマリタイトルとして表示される文字列。パターンには、動的に置換される数値識別子が含まれています。文字列内の各数値識別子は、id フィールドで指定されたプロパティ名のいずれかに対応しています。 | String | "" | 必須 |
id | バックエンドシステムにおける属性のプロパティ名の識別子。たとえば、“Subject|SubjectName” です。 | String | "" | 必須 |
numericIdentifier | 各 id には数値識別子があります。パターン文字列内の数値識別子は、id に取得された値に置き換えられます。 | Integer | 1 | 必須 |
objectType | 属性をフェッチするオブジェクトタイプ。 | String | "" | 必須 |
adapter | バックエンドシステムのソースコンフィギュレーション。サブプロパティを参照してください: | adapter | なし | 必須 |
instanceName | コネクタインスタンス。バックエンドシステムへの接続に使用するコネクタを意味します。 | String | "" | 必須 |
thingName | データの取得元となるバックエンドシステムまたはアダプタの名前。 | String | "" | 必須 |
secondaryTitle | セカンダリタイトル。アイテム ID パネルのプライマリタイトルの下に表示されます。サブプロパティを参照してください: | なし | なし | 必須 |
pattern | コンポーネントのユーザーインタフェースにセカンダリタイトルとして表示される文字列。パターンには、動的に置換される数値識別子が含まれています。文字列内の各数値識別子は、id フィールドで指定されたプロパティ名のいずれかに対応しています。 | String | "" | 必須 |
id | バックエンドシステムにおける属性のプロパティ名の識別子。たとえば、“Activity|Name” です。 | String | "" | 必須 |
numericIdentifier | 各 id には数値識別子があります。パターン文字列内の数値識別子は、id に取得された値に置き換えられます。 | Integer | 1 | 必須 |
objectType | 属性をフェッチするオブジェクトタイプ。 | String | "" | 必須 |
adapter | バックエンドシステムのソースコンフィギュレーション。サブプロパティを参照してください: | adapter | なし | 必須 |
instanceName | コネクタインスタンス。バックエンドシステムへの接続に使用するコネクタを意味します。 | String | "" | 必須 |
thingName | データの取得元となるバックエンドシステムまたはアダプタの名前。 | String | "" | 必須 |
modelThing | サブプロパティを参照してください: | なし | なし | 必須 |
entityName | データを取得するモデル Thing の名前。 | String | "PTC.ItemIdentity ModelThing" | 必須 |
version | コンフィギュレーションバージョン。 | String | “1.0.0” | オプション |
actions | ユーザーインタフェースの操作バーに表示される操作。詳細およびサブプロパティについては、 操作バーの再使用可能なコンポーネントを参照してください。 | なし | なし | オプション |
サンプルコンフィギュレーション
以下の JSON コンフィギュレーションのサンプルは、そのデフォルトコンフィギュレーションのアイテム ID 用です。
{
"secondaryTitle": {
"pattern": "",
"fields": {
"data": [
{
"itemListsData": [
{
"items": [
{
"numericIdentifier": 1,
"id": ""
}
],
"objectType": ""
}
],
"adapter": {
"instanceName": "",
"thingName": ""
}
}
]
}
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"id": ""
}
],
"objectType": ""
},
{
"items": [
{
"id": ""
}
],
"objectType": ""
}
],
"adapter": {
"instanceName": "",
"thingName": ""
}
}
]
},
"inTailoring": true
},
"title": {
"pattern": "",
"fields": {
"data": [
{
"itemListsData": [
{
"items": [
{
"numericIdentifier": 1,
"id": ""
}
],
"objectType": ""
}
],
"adapter": {
"instanceName": "",
"thingName": ""
}
}
]
}
},
"actions": {
"maxItemsToShow": {
"value": 2
},
"modelThingName": {
"entityName": "PTC.ActionBarModel.Thing"
},
"actions": {
"selectedValues": {
"data": [
{
"itemListsData": [],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
}
},
"modelThing": {
"entityName": "PTC.ItemIdentityModelThing",
"version": "1.0.0"
}
}
