ドキュメント ID
ドキュメント ID は、アイテム ID コンポーネントの定義済みコンフィギュレーションであり、ドキュメントに関する基本情報を含むパネルが表示されます。このパネルには、プライマリタイトルとセカンダリタイトル、イメージ、セカンダリアイコン、および ID 属性が表示されます。セカンダリアイコンは、そのドキュメントタイプのアイコンを Windchill から使用して、ドキュメントタイプを示します。このパネルに表示されるデフォルトの属性は、「バージョン」、「状態」、「最終修正日」、「コンテキスト」です。ドキュメント ID のコンフィギュレーションには、「ドキュメントを開く」、「問題を報告」、および「Windchill で表示」の操作も表示されます。
「ドキュメント ID」定義済みコンフィギュレーションのサンプルイメージを以下に示します。
バインドプロパティ
ドキュメント ID のバインドについては、アイテム IDコンポーネントを参照してください。
 | ドキュメント ID の場合、入力バインドプロパティで PTC.DocMgmt.Document オブジェクトタイプがサポートされています。 |
コンフィギュレーションプロパティ
ドキュメント ID の設定については、アイテム IDコンポーネントを参照してください。
コンフィギュレーションの構造の詳細については、コンポーネントのコンフィギュレーション構造を参照してください。
サブプロパティの詳細については、サブプロパティとコンテナキーを参照してください。
サンプルコンフィギュレーション
{
"primaryTitle": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"numericIdentifier": 1,
"id": "Number"
},
{
"numericIdentifier": 2,
"id": "Name"
}
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
},
"pattern": "%1, %2",
"filteredValues": {
"data": [
{
"itemListsData": [
{
"objectType": ""
}
],
"adapter": {
"instanceName": "",
"thingName": ""
}
}
]
}
},
"actionBarConfiguration": {
"value": {}
},
"showSecondaryIcon": {
"version": "1.0.0",
"value": true
},
"secondaryTitle": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"numericIdentifier": 1,
"id": "DocTypeName"
}
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
},
"pattern": "%1",
"filteredValues": {
"data": [
{
"itemListsData": [
{
"objectType": ""
}
],
"adapter": {
"instanceName": "",
"thingName": ""
}
}
]
}
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"id": "Version",
"ordinal": 0
},
{
"id": "State#Display",
"ordinal": 1
},
{
"id": "LastModified",
"ordinal": 2
},
{
"id": "Context|Name",
"ordinal": 3
}
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
},
"inTailoring": true,
"filteredValues": {
"data": [
{
"itemListsData": [
{
"objectType": ""
}
],
"adapter": {
"instanceName": "",
"thingName": ""
}
}
]
}
},
"showImage": {
"version": "1.0.0",
"value": true,
"additionalData": {
"itemIdentityShowImageDefinition": {
"defaultImagePath": {
"value": "/Thingworx/MediaEntities/PTC.Nav.BigDocumentThumbnail"
}
}
}
},
"enableExpandCollapse": {
"version": "1.0.0",
"value": true
},
"baseConfigurationVersion": {
"value": "nav.1"
},
"implementationConfigurationVersion": {
"value": "nav.1"
}
}
"primaryTitle": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"numericIdentifier": 1,
"id": "Number"
},
{
"numericIdentifier": 2,
"id": "Name"
}
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
},
"pattern": "%1, %2",
"filteredValues": {
"data": [
{
"itemListsData": [
{
"objectType": ""
}
],
"adapter": {
"instanceName": "",
"thingName": ""
}
}
]
}
},
"actionBarConfiguration": {
"value": {}
},
"showSecondaryIcon": {
"version": "1.0.0",
"value": true
},
"secondaryTitle": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"numericIdentifier": 1,
"id": "DocTypeName"
}
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
},
"pattern": "%1",
"filteredValues": {
"data": [
{
"itemListsData": [
{
"objectType": ""
}
],
"adapter": {
"instanceName": "",
"thingName": ""
}
}
]
}
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"id": "Version",
"ordinal": 0
},
{
"id": "State#Display",
"ordinal": 1
},
{
"id": "LastModified",
"ordinal": 2
},
{
"id": "Context|Name",
"ordinal": 3
}
],
"objectType": "PTC.DocMgmt.Document"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
},
"inTailoring": true,
"filteredValues": {
"data": [
{
"itemListsData": [
{
"objectType": ""
}
],
"adapter": {
"instanceName": "",
"thingName": ""
}
}
]
}
},
"showImage": {
"version": "1.0.0",
"value": true,
"additionalData": {
"itemIdentityShowImageDefinition": {
"defaultImagePath": {
"value": "/Thingworx/MediaEntities/PTC.Nav.BigDocumentThumbnail"
}
}
}
},
"enableExpandCollapse": {
"version": "1.0.0",
"value": true
},
"baseConfigurationVersion": {
"value": "nav.1"
},
"implementationConfigurationVersion": {
"value": "nav.1"
}
}
カスタマイズサービス
コンフィギュレーションに加え、コンポーネントごとにビジネスロジックを拡張してコンポーネントをカスタマイズできます。各コンポーネントのビジネスロジックには、拡張およびオーバーライド可能な Thing Template 内のサービスが含まれています。次のテーブルは、このコンポーネントのオーバーライド可能なサービスの詳細を示しています。
各サービスの戻り値とパラメータの例については、カスタマイズサービスの入力/出力の例を参照してください。
名前 | 説明 |
|---|---|
GetConfigurations | ドキュメント ID の実装で使用可能なコンフィギュレーションを返します。 パラメータ: なし 戻り値: JSON |
GetImplementationLabel | コンポーネントのローカライズ名、またはローカライズ名を取得するために使用できるトークンを返します。このローカライズ名は Mashup Builder のユーザーインタフェースに表示されます。 パラメータ: なし 戻り値: String |
GetItemIdentityAttributes | コンフィギュレーションをチェックし、必要なその他の属性を追加してから、GetAttributeValues を呼び出して、バックエンドシステムからすべての属性値をフェッチします。 イメージまたはセカンダリアイコンが表示されるように設定されている場合、返される JSON にそれらが追加されるので、GetAttributeValues はバックエンドシステムからそれらの値もフェッチします。 パラメータ: input (必須) - バックエンドシステムからフェッチするデータの入力 ID およびバックエンドシステムのアダプタ情報を含む、CCOフォーマットの JSON。 configuration (オプション) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 attributes (必須) - コンフィギュレーションで定義されているか、調整によって設定された、属性のリストを含む JSON。 戻り値: JSON |
GetAttributesValues | 属性とその値を含む JSON を返します。 パラメータ: input (必須) - バックエンドシステムからフェッチするデータの入力 ID およびバックエンドシステムのアダプタ情報を含む、CCOフォーマットの JSON。 configuration (オプション) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 attributes (必須) - 属性のリストを含む JSON。 戻り値: CCOフォーマットの JSON |
実装定義
{
"array":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"additionalDefinition":[
],
"updateServiceName":"",
"supportedTypes":{
"data":[
{
"itemListsData":[
{
"selectionGroupIds":[
"DOCUMENT"
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring":true
},
"addServiceName":""
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.PatternSelector"
},
"mandatory":true,
"key":"primaryTitle"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"additionalDefinition":[
],
"updateServiceName":"",
"supportedTypes":{
"data":[
{
"itemListsData":[
{
"selectionGroupIds":[
"DOCUMENT"
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring":true
},
"addServiceName":""
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.PatternSelector"
},
"mandatory":true,
"key":"secondaryTitle"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"additionalDefinition":[
],
"updateServiceName":"",
"minimumSelectedAttributes":null,
"supportedTypes":{
"data":[
{
"itemListsData":[
{
"selectionGroupIds":[
"DOCUMENT"
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring":true
},
"addServiceName":"",
"maximumSelectedAttributes":"5"
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory":false,
"key":"attributes"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"directDefinition":[
]
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.DefinitionGroup"
},
"mandatory":false,
"key":"actionBarConfiguration"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":false,
"true":{
"additionalDefinition":[
{
"directDefinition":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Textbox"
},
"mandatory":false,
"key":"defaultImagePath"
}
],
"key":"itemIdentityShowImageDefinition"
}
],
"label":"[[PTC.Nav.Yes]]"
},
"false":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.No]]"
}
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Toggle"
},
"mandatory":false,
"key":"showImage"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":false,
"true":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.Yes]]"
},
"false":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.No]]"
}
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Toggle"
},
"mandatory":false,
"key":"showSecondaryIcon"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":true,
"true":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.Yes]]"
},
"false":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.No]]"
}
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Toggle"
},
"mandatory":true,
"key":"enableExpandCollapse"
}
]
}
"array":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"additionalDefinition":[
],
"updateServiceName":"",
"supportedTypes":{
"data":[
{
"itemListsData":[
{
"selectionGroupIds":[
"DOCUMENT"
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring":true
},
"addServiceName":""
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.PatternSelector"
},
"mandatory":true,
"key":"primaryTitle"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"additionalDefinition":[
],
"updateServiceName":"",
"supportedTypes":{
"data":[
{
"itemListsData":[
{
"selectionGroupIds":[
"DOCUMENT"
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring":true
},
"addServiceName":""
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.PatternSelector"
},
"mandatory":true,
"key":"secondaryTitle"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"additionalDefinition":[
],
"updateServiceName":"",
"minimumSelectedAttributes":null,
"supportedTypes":{
"data":[
{
"itemListsData":[
{
"selectionGroupIds":[
"DOCUMENT"
],
"objectType":"PTC.DocMgmt.Document"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring":true
},
"addServiceName":"",
"maximumSelectedAttributes":"5"
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory":false,
"key":"attributes"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"directDefinition":[
]
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.DefinitionGroup"
},
"mandatory":false,
"key":"actionBarConfiguration"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":false,
"true":{
"additionalDefinition":[
{
"directDefinition":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Textbox"
},
"mandatory":false,
"key":"defaultImagePath"
}
],
"key":"itemIdentityShowImageDefinition"
}
],
"label":"[[PTC.Nav.Yes]]"
},
"false":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.No]]"
}
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Toggle"
},
"mandatory":false,
"key":"showImage"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":false,
"true":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.Yes]]"
},
"false":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.No]]"
}
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Toggle"
},
"mandatory":false,
"key":"showSecondaryIcon"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":true,
"true":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.Yes]]"
},
"false":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.No]]"
}
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Toggle"
},
"mandatory":true,
"key":"enableExpandCollapse"
}
]
}