Advanced Customization > Using Reusable Components > Available Reusable Components > Item Identity
  
Item Identity
Definition and Usage
The Item Identity reusable component is a widget that lets you display basic information, also known as identity information, on a specific item. The information appears in a panel, typically at the top of the item page. The panel contains the main title, secondary title, and various identity attributes for the item. It also contains an embedded Action Bar, which contains actions that you can execute on the item. You can expand or collapse the Item Identity panel using the arrow in the top left of the panel. When collapsed, only the primary title and the Action Bar are visible.
You can configure the Item Identity reusable component in the following ways:
• Define the identity attributes to display
• Configure the actions available in the embedded Action Bar
• Define the main and secondary titles
The following is a sample image showing the Item Identity reusable component:
Task Identity is the only predefined configuration available for the Item Identity reusable component. See Task Identity for more information and a sample configuration.
Binding Properties
The Item Identity component has two properties available for binding:
• Input— this JSON is the input ID for which data needs to be fetched from the backend system. This information is provided in a CCO (Common Communication Object) format. The following is a sample:
{
"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— this string is the instance name of the component. It is tightly coupled to tailoring. TailoringName is used to fetch the saved tailoring information for each component.
Configuration Fields
The following table shows the JSON fields used to configure this component.
Property Name
Description
Type
Default Value
Required or Optional
attributes
Property names for which the data is expected from backend system. See subproperties:
MultiValueSelector
N/A
Optional
id
The property-name identifier of the attribute in the backend system. For example, “Category#Display”.
String
""
Required
ordinal
Order in which attributes appear in the component. 0 indicates the initial leftmost position.
Integer
N/A
Optional
objectType
Object type for which the attributes are to be fetched.
String
""
Required
adapter
Source configuration for the backend system. See subproperties:
JSON
N/A
Required
instanceName
Connector instance, meaning which connector to use to connect to the backend system.
String
""
Required
thingName
Name of the backend system or adapter from which data is retrieved.
String
""
Required
inTailoring
Whether or not the Item Identity component is tailorable in the tailoring page. Options: true, false.
Boolean
false
Optional
title
The main title which appears at the top of the Item identity panel. See subproperties:
N/A
N/A
Required
pattern
String that appears as primary title in the component user interface. Pattern contains numeric identifiers that are replaced dynamically. Each numeric identifier in the string corresponds to one of the property names given in id field.
String
""
Required
id
The property-name identifier of the attribute in the backend system. For example, “Subject|SubjectName”.
String
""
Required
numericIdentifier
Each id has a numeric identifier. The numeric identifier is substituted in the pattern string with the value retrieved for the id.
Integer
1
Required
objectType
Object type for which the attributes are to be fetched.
String
""
Required
adapter
Source configuration for the backend system. See subproperties:
adapter
N/A
Required
instanceName
Connector instance, meaning which connector to use to connect to the backend system.
String
""
Required
thingName
Name of the backend system or adapter from which data is retrieved.
String
""
Required
secondaryTitle
The secondary title, which appears below the primary title in the Item Identity Panel. See subproperties:
N/A
N/A
Required
pattern
String that appears as secondary title in the component user interface. Pattern contains numeric identifiers that are replaced dynamically. Each numeric identifier in the string corresponds to one of the property names given in id field.
String
""
Required
id
The property-name identifier of the attribute in the backend system. For example, “Activity|Name”.
String
""
Required
numericIdentifier
Each id has a numeric identifier. The numeric identifier is substituted in the pattern string with the value retrieved for the id.
Integer
1
Required
objectType
Object type for which the attributes are to be fetched.
String
""
Required
adapter
Source configuration for the backend system. See subproperties:
adapter
N/A
Required
instanceName
Connector instance, meaning which connector to use to connect to the backend system.
String
""
Required
thingName
Name of the backend system or adapter from which data is retrieved.
String
""
Required
modelThing
See subproperties:
N/A
N/A
Required
entityName
The name of the model Thing that gets the data.
String
"PTC.ItemIdentity
ModelThing"
Required
version
Configuration version.
String
“1.0.0”
Optional
actions
Actions to show in the Action Bar in the user interface. See the Action Bar reusable component for more information and subproperties.
N/A
N/A
Optional
Sample Configuration
The following sample JSON configuration is for the Item Identity in its default configuration.
{
"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"
}
}