Document Identity
Document Identity is a predefined configuration of the Item Identity component that displays a panel containing basic information about a document. The panel includes primary and secondary titles, an image, a secondary icon, and identity attributes. The secondary icon indicates the document type, using the icon from Windchill for that document type. The default attributes included in the panel are Version, State, Last Modified, and Context. The Document Identity configuration also displays the Open Document, Report a Problem, and View in Windchill actions.
The following is a sample image showing the Document Identity predefined configuration:
Binding Properties
For information on binding Document Identity, see the Item Identity component.
 | For Document Identity, the input binding property supports the PTC.DocMgmt.Document object type. |
Configuration Properties
For a list of all available configuration properties for Document Identity, see the Configuration Properties table for the Item Identity component. The following table provides additional information that is specific to Document Identity regarding configuration properties.
For more information on the structure of the configuration, see Component Configuration Structure.
For more information on sub-properties, see Sub-Properties and Container Keys.
Property Name | Description | Property Type | Default Value | Required or Optional | |
|---|---|---|---|---|---|
primaryTitle | See Item Identity for more information. Accepts attributes of the PTC.DocMgmt.Document object type. | N/A | Required | ||
secondaryTitle | See Item Identity for more information. Accepts attributes of the PTC.DocMgmt.Document object type. | N/A | Required | ||
attributes | See Item Identity for more information. Accepts attributes of the PTC.DocMgmt.Document object type. | N/A | Required | ||
Sample Configuration
{
"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":""
}
}
]
}
},
"expanded":{
"version":"1.0.0",
"value":true
},
"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"
}
}Customization Services
In addition to configuration, each component supports extending its business logic to customize the component. The business logic of each component includes overridable services in a Thing Template that you can extend and override. The overridable services for this component are detailed in the following table.
For examples of returns and parameters for each service, see Examples of Input/Output for Customization Services.
Name | Description |
|---|---|
GetConfigurations | Returns the available configurations for the Document Identity implementation. Parameters: None Returns: JSON |
GetImplementationLabel | Returns either the localized name of the component or the token that can be used to obtain the localized name. This localized name is displayed in the Mashup Builder user interface. Parameters: None Returns: String |
GetItemIdentityAttributes | Checks configuration and adds any additional attributes that are required, and then calls GetAttributeValues to fetch all attribute values from the backend system. If the image or secondary icon are configured to appear, they are added to the returned JSON, so that GetAttributeValues fetches their values from the backend system as well. Parameters: input (Required)– JSON in CCO format that includes the input ID for the data to be fetched from the backend system and the adapter information for the backend system. configuration (Optional)– JSON with the final merged configuration obtained from the Tailoring Manager resource. attributes (Required)– JSON with the list of attributes, as defined in the configuration or set via tailoring. Returns: JSON |
GetAttributesValues | Returns a JSON with attributes and their values. Parameters: input (Required)– JSON in CCO format that includes the input ID for the data to be fetched from the backend system and the adapter information for the backend system. configuration (Optional)– JSON with the final merged configuration obtained from the Tailoring Manager resource. attributes (Required)– JSON with the list of attributes. Returns: JSON in CCO format |
Implementation Definition
{
"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": [
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Textbox"
},
"mandatory": false,
"key": "actionBarConfigurationJSON"
}
]
}
},
"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]]"
},
"label": null
}
},
"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]]"
},
"label": null
}
},
"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]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": true,
"key": "enableExpandCollapse"
},
{
"property": {},
"value": {
"initializationData": {
"version": "1.0.0",
"constraints": {},
"properties": {
"default": true,
"true": {
"additionalDefinition": [],
"label": "[[PTC.Nav.Yes]]"
},
"false": {
"additionalDefinition": [],
"label": "[[PTC.Nav.No]]"
},
"label": null
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": true,
"key": "expanded"
}
]
}