属性
定義と用法
属性コンポーネントは、名前と値のペアを表示するウィジェットです。値は常に名前の下に表示されます。さまざまなデータ型の値を表示できます。グループ名を使用して、一連の属性をグループとして表示できます。
以下は属性コンポーネントを示すサンプルイメージです。
選択した部品またはドキュメントの属性がプレビュー枠に表示されます。これは、次のイメージに示すように、画面の右側に表示されます。
次の方法で、属性コンポーネントを設定できます。
• 表示する属性を定義する。
• レイアウトおよび関連する表示を設定する。
• 属性グループのタイトルを定義する (これはレイアウトが垂直の属性グループにのみ使用できます)。
• デコレータを使用して、属性の既成のタスクのいずれかにリンクを追加します。現在のところ、デコレータリストで検出された 1 つ目のデコレータだけがサポートされています。
属性へのリンクを追加するには、コンフィギュレーションで、appId と thingName (PTC.Nav.LinkToAppDecoratorThing) を含むデコレータを属性に追加します。以下に例を示します。
 | ThingWorx Navigate 9.4.0 以降では、decoratedType キーがコンフィギュレーションの metadata セクションにある decoration キーの下に移動しています。 |
metadata: {
Number: {
"label": "Number",
"type": "STRING",
"decoration": {
"decoratedType": "HTML",
"decorators": [{
"thingName": "PTC.Nav.LinkToAppDecoratorThing",
"parameters": {
"appId": "PTC.Nav.ViewDesignFiles"
}
}]
}
Number: {
"label": "Number",
"type": "STRING",
"decoration": {
"decoratedType": "HTML",
"decorators": [{
"thingName": "PTC.Nav.LinkToAppDecoratorThing",
"parameters": {
"appId": "PTC.Nav.ViewDesignFiles"
}
}]
}
以下に示す各タスクのアプリケーション ID を使用して、次のタスクに移動できます。
タスク | アプリケーション ID |
|---|---|
部品タスクコレクション | |
設計ファイルを表示 | PTC.Nav.ViewDesignFiles |
図面を表示 | PTC.Nav.ViewDrawing |
3D で表示 & 測定 | PTC.Nav.ViewAndMeasureIn3D |
部品プロパティを表示 | PTC.Nav.ViewPartProperties |
部品リストを表示 | PTC.Nav.ViewPartList |
部品構造を表示 | PTC.Nav.ViewPartStructure |
ドキュメントタスクコレクション | |
ドキュメントを表示 | PTC.Nav.ViewDocument |
ドキュメント構造を表示 | PTC.Nav.ViewDocumentStructure |
属性ジェネリックは、属性コンポーネントに使用できるジェネリックの定義済みコンフィギュレーションです。
バインドプロパティ
入力 | ||
|---|---|---|
プロパティ名 | 説明 | プロパティタイプ |
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 | 属性コンポーネントのインスタンスを一意に識別します。この値は、その特定のインスタンスの調整情報を検索するために内部で使用されます。 このバインドプロパティは、カスタムタスクに専用の調整ページがある場合にのみ使用します。 | String |
SubComponentConfiguration | このコンポーネントを別のコンポーネント内または組み込みマッシュアップ内でサブコンポーネントとして使用する場合は、このプロパティにコンフィギュレーションをバインドします。 サンプル JSON: { "implementationThingName":"PTC.Nav.AttributesGenericBusinessLogicThing", "configuration":{ "layout":{ "selectedKey":"horizontal", "additionalData":{ }, "version":"1.0.0" }, "attributes":{ "sets":[ { "data":{ "selectedValues":{ "data":[ { "itemListsData":[ { "items":[ { "id":"Role#Display", "ordinal":0 }, { "id":"Activity|Deadline", "ordinal":5 }, { "id":"Status#Display", "ordinal":4 } ], "objectType":"PTC.Workflow.WorkItem" }, { "items":[ { "id":"Category#Display", "ordinal":1 }, { "id":"RequestPriority#Display", "ordinal":3 } ], "objectType":"PTC.ChangeMgmt.ChangeRequest" } ], "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" } } ] } } } ] } } } | JSON |
コンフィギュレーションプロパティ
次のテーブルとイメージは、このコンポーネントの設定に使用される JSON プロパティを示しています。
コンフィギュレーションの構造の詳細については、コンポーネントのコンフィギュレーション構造を参照してください。
サブプロパティの詳細については、サブプロパティとコンテナキーを参照してください。
プロパティ名 | 説明 | プロパティタイプ | デフォルト値 | 必須またはオプション | |
|---|---|---|---|---|---|
attributes | バックエンドシステムからデータをフェッチする必要がある属性のリスト。 Windchill の場合、これらのプロパティ名が Windchill REST Services EDM で定義されているものと一致する必要があります。 | なし | 必須 | ||
isMultiLine | コンテンツをラップするかどうかを指定します。オプション : true、false。 このプロパティは、layout のサブプロパティであり、layout が vertical に設定されている場合にのみ関連します。そのコンテナキーは isMultilineDefinition です。 | なし | 必須 | ||
layout | ユーザーインタフェースでの属性の配置方法を指定します。次のオプションがあります。 • vertical: 属性は上下に重ねて表示されます。 • horizontal: 属性は横に並べて表示されます。 layout に使用可能なサブプロパティは、vertical と horizontal のどちらが選択されているかによって異なります。詳細については、属性ジェネリックのサンプルコンフィギュレーションを参照してください。 | なし | 必須 | ||
maxHeight | ユーザーインタフェースでの属性名と値の両方の最大高さ。 コンテンツがプロパティ maxHeight の値を超えている場合、「詳細表示/詳細を隠す」リンクまたはボタンを使用できます。 このプロパティは、以下の 2 つの場合にのみ関連します。 • layout が horizontal に設定されている場合。この場合、これは layout のサブプロパティです。 • layout が vertical に設定され、isMultiLine が true に設定されている場合。この場合、これは isMultiLine のサブプロパティです。 そのコンテナキーは dimensionDefinition です。 | なし | 必須 | ||
maxWidth | ユーザーインタフェースでの属性名と値の最大幅。 このプロパティは、以下の 2 つの場合にのみ関連します。 • layout が horizontal に設定されている場合。この場合、これは layout のサブプロパティです。 • layout が vertical に設定され、isMultiLine が false に設定されている場合。この場合、これは isMultiLine のサブプロパティです。 そのコンテナキーは dimensionDefinition です。 | なし | 必須 | ||
messageWhenNoAttributes | 属性が使用できない場合にメッセージを表示できます。 この値は空のままにできます。この場合、メッセージは表示されず、特別なプレースホルダーは保持されません。 | なし | オプション | ||
サンプルコンフィギュレーション
属性コンポーネントのサンプルコンフィギュレーションについては、属性ジェネリックのコンフィギュレーションを参照してください。
カスタマイズサービス
コンフィギュレーションに加え、コンポーネントごとにビジネスロジックを拡張してコンポーネントをカスタマイズできます。各コンポーネントのビジネスロジックには、拡張およびオーバーライド可能な 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 で終わるオブジェクトタイプを持つ属性は、追加の属性として扱われます。その他すべての属性は既成の属性と見なされます。 パラメータ: attributes (必須) - 既成の属性と追加の属性のリストを含む JSON。 configuration (オプション) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 戻り値: CCOフォーマットの JSON |
GetAttributesValues | 属性とその値を含む JSON を返します。 パラメータ: input (必須) - バックエンドシステムからフェッチするデータの入力 ID およびバックエンドシステムのアダプタ情報を含む、CCOフォーマットの JSON。 configuration (オプション) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 attributes (必須) - 既成の属性と追加の属性のリストを含む JSON。 戻り値: CCOフォーマットの JSON |
GetAdditionalAttributesValues | 追加の属性の値を含む JSON を返します。このサービスは、コンポーネントの実装によって実装されなければなりません。 パラメータ: input (必須) - バックエンドシステムからフェッチするデータの入力 ID およびバックエンドシステムのアダプタ情報を含む、CCOフォーマットの JSON。 configuration (オプション) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 attributes (必須) - 追加の属性のリストを含む JSON。 OOTBAttributesValues (オプション) - GetAttributesValues によって返された既成の属性の値を含む、CCOフォーマットの JSON。これらの値を使用して、追加の属性の値を計算できます。 戻り値: CCOフォーマットの JSON |
GetAdditionalAttributes | 使用可能な既成の属性のリストに追加される、追加の属性のリストを返します。 パラメータ: なし 戻り値: JSON |
UpdateAvailableAttributes | 属性リスト内の 1 つまたは複数の属性を更新し、最終リストを返します。 パラメータ: attributes (必須) - 既成の属性と追加の属性のリストを含む JSON。 戻り値: JSON |
実装定義
属性コンポーネントの実装定義については、属性ジェネリックのコンフィギュレーションを参照してください。