Design Files
Design Files is a predefined configuration of the Item List component that displays a list of design files for both Parts and CAD documents, including described by documents, referenced by documents, attachments, and representations. Design Files has similar search, sort, filter and restore defaults capabilities as Item List. For each file, Design Files displays attributes which you can choose via configuration. The default attributes are Name and Formats, which are custom attributes. Name contains a link to download the file and Formats contains a drop-down menu with all other available formats for download, and is only relevant for representations.
The following is a sample image showing the Design Files predefined configuration:
Binding Properties
For information on binding Design Files, see the Item List component.
 | • For Design Files, the input binding property supports the PTC.CADDocumentMgmt.CADDocument and PTC.ProdMgmt.Part object types. • The output of the selectedItems binding property contains items with the PTC.ContentItem and PTC.VisualizationRepresentation object types. |
Configuration Properties
For a list of all available configuration properties for Design Files, see the Configuration Properties table for the Item List component. The following table provides additional information that is specific to Design Files 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 | |||
|---|---|---|---|---|---|---|---|
fileFormatSelection | Determines what representation file formats are retrieved and displayed in the drop-down menu in the Formats column. This sub-property is only relevant when the representations key is included in the relationships property. Options: • specifiedFormats– only retrieves the specified file formats; use the formats property to specify file formats to include. The file formats are displayed in the drop-down menu in the same order that they are listed in the formats property. • allFormats– retrieves all available file formats. If there is a PDF format available for the design file, the Name column contains a link to download the PDF, and PDF is the first format listed in the drop-down menu.
This sub-property is placed under the designFileImplementationDefinition property in the component configuration. | specifiedFormats | Required | ||||
showImplementationActions | When this property includes the downloadZip key, Design Files includes a download all button in the embedded Action Bar. This allows users to download all design files. downloadZip is the only value supported by Design Files for this property. | N/A | Optional | ||||
formats | The list of specified formats to retrieve for representations. Formats should be separated with a space. The order in which the formats are listed here dictates the order that they appear in the drop-down menu in the Formats column. This is a sub-property to fileFormatSelection and is only relevant when fileFormatSelection is set to specifiedFormats. | PDF DXF PLT CGM | Required | ||||
relationships | The list of types of design files to display based on the relationship to the part or CAD document. Can include one or more of the following keys: • describedByDocuments to display described by documents • referenceDocuments to display referenced by documents • attachments to display attachments • representations to display representations
| N/A | Required | ||||
attributes | See Item List for more information. Accepts attributes of the PTC.ContentItem and PTC.VisualizationRepresentation object types. Additionally, accepts the Name and Formats attributes, which have the PTC.Nav.DesignFiles.Custom.Implementation and PTC.Visualization.Representation.Custom.Implementation object types respectively. | N/A | Required | ||||
defaultSortField | See Item List for more information. Accepts attributes of the PTC.ContentItem and PTC.VisualizationRepresentation object types. Additionally, accepts the Name and Formats attributes, which have the PTC.Nav.DesignFiles.Custom.Implementation and PTC.Visualization.Representation.Custom.Implementation object types respectively. | N/A | Optional | ||||
Sample Configuration
{
"showImplementationActions":{
"selected":[
{
"key":"downloadZip"
}
]
},
"selectionType":{
"selectedKey":"none"
},
"waitForInput":{
"value":true
},
"implementationConfiguration":{
"inTailoring":true,
"value":{
"relationships":{
"selected":[
{
"key":"describedByDocuments"
},
{
"key":"referenceDocuments"
},
{
"key":"attachments"
},
{
"key":"representations",
"additionalData":{
"designFileImplementationDefinition":{
"value":{
"fileFormatSelection":{
"selectedKey":"specifiedFormats",
"additionalData":{
"formatsDefinition":{
"formats":{
"value":"PDF DXF PLT CGM"
}
}
}
},
"fileSelection":{
"selectedKey":"defaultFile"
}
}
}
}
}
]
}
}
},
"baseConfigurationVersion":{
"value":"nav.3"
},
"implementationConfigurationVersion":{
"value":"nav.1"
},
"defaultSortFields":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"additionalData":{
"itemListDefaultSortFieldDefinition":{
"defaultSortDirection":{
"selectedKey":"asc"
}
}
},
"id":"Name"
}
],
"objectType":"PTC.Nav.DesignFiles.Custom.Implementation"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
}
},
"attributes":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":"Name",
"ordinal":0
}
],
"objectType":"PTC.Nav.DesignFiles.Custom.Implementation"
},
{
"items":[
{
"id":"Formats",
"ordinal":1
}
],
"objectType":"PTC.Visualization.Representation.Custom.Implementation"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
}
},
"label":{
"value":""
},
"showExportAction":{
"value":false
},
"enableSearch":{
"additionalData":{
"itemListSearchDefinition":{
"searchHintText":{
"value":"[[PTC.Nav.DesignFiles.FindDesignLabel]]"
}
}
},
"value":true
}
}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 Design Files. Parameters: None Returns: JSON |
GetImplementationSettings | Returns the settings data, which includes data for the download all button. This data is used internally by the Design Files implementation. Parameters: None Returns: JSON object |
GetItems | Returns the list of design files from the backend system, together with their attributes and 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 (Required)– JSON with the configuration. Returns: JSON in CCO format |
DefHookGetImplementationActionsList | Returns the actions listed under the implementationActions key in the GetImplementationSettings service. Parameters: None Returns: JSON:Array |
DefHookImplementationConfigurationDefinitionGroup | Returns the Design Files implementation definition with the available custom configurations. Includes the definition for the relationships, fileFormatsToDisplay, and specifiedFormats configuration properties. Parameters: None Returns: JSON:Array |
Implementation Definition
{
"array":[
{
"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":{
"additionalDefinition":[
{
"directDefinition":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Textbox"
},
"mandatory":false,
"key":"fieldTitleOverride"
}
],
"key":"itemListAttributesDefinition"
},
{
"directDefinition":[
],
"key":"implementationAttributesDefinition"
}
],
"updateServiceName":"",
"minimumSelectedAttributes":null,
"supportedTypes":{
"data":[
{
"itemListsData":[
{
"selectionGroupIds":[
"PCI"
],
"objectType":"PTC.ContentItem"
},
{
"selectionGroupIds":[
"PVR"
],
"objectType":"PTC.Visualization.Representation"
},
{
"selectionGroupIds":[
"PNDCI"
],
"objectType":"PTC.Nav.DesignFiles.Custom.Implementation"
},
{
"selectionGroupIds":[
"PVRCI"
],
"objectType":"PTC.Visualization.Representation.Custom.Implementation"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring":false
},
"addServiceName":"",
"maximumSelectedAttributes":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory":true,
"key":"attributes"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"options":[
{
"label":"1",
"key":"1"
},
{
"label":"2",
"key":"2"
},
{
"label":"3",
"key":"3"
},
{
"label":"4",
"key":"4"
},
{
"label":"5",
"key":"5"
},
{
"label":"6",
"key":"6"
},
{
"label":"7",
"key":"7"
},
{
"label":"8",
"key":"8"
},
{
"label":"9",
"key":"9"
},
{
"label":"-1",
"key":"-1"
}
],
"updateServiceName":null,
"addServiceName":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Dropdown"
},
"mandatory":false,
"key":"defaultExpansionLevel"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"additionalDefinition":[
{
"directDefinition":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"options":[
{
"description":"Sort column in ascending order",
"label":"[[PTC.Nav.ItemList.SortOrder.Asc]]",
"key":"asc"
},
{
"description":"Sort column in descending order",
"label":"[[PTC.Nav.ItemList.SortOrder.Dsc]]",
"key":"dsc"
}
],
"updateServiceName":null,
"addServiceName":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.RadioButton"
},
"mandatory":false,
"key":"defaultSortDirection"
}
],
"key":"itemListDefaultSortFieldDefinition"
}
],
"updateServiceName":"",
"minimumSelectedAttributes":null,
"supportedTypes":{
"data":[
{
"itemListsData":[
{
"selectionGroupIds":[
"PCI"
],
"objectType":"PTC.ContentItem"
},
{
"selectionGroupIds":[
"PVR"
],
"objectType":"PTC.Visualization.Representation"
},
{
"selectionGroupIds":[
"PNDCI"
],
"objectType":"PTC.Nav.DesignFiles.Custom.Implementation"
},
{
"selectionGroupIds":[
"PVRCI"
],
"objectType":"PTC.Visualization.Representation.Custom.Implementation"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring":false
},
"addServiceName":"",
"maximumSelectedAttributes":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory":false,
"key":"defaultSortFields"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":true,
"true":{
"additionalDefinition":[
{
"directDefinition":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Textbox"
},
"mandatory":false,
"key":"searchHintText"
}
],
"key":"itemListSearchDefinition"
}
],
"label":"[[PTC.Nav.Yes]]"
},
"false":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.No]]"
},
"label":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Toggle"
},
"mandatory":false,
"key":"enableSearch"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"additionalDefinition":[
{
"directDefinition":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"dynamicallySetTypeServiceName":"GetFilterTypeDefinitionForFilterField",
"type":{
"enum":{
"options":[
],
"updateServiceName":null,
"dynamicallySetOptionsServiceName":null,
"addServiceName":null,
"multiSelect":null
}
}
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.FieldFilter"
},
"mandatory":false,
"key":"defaultSelectedFilterValues"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Textbox"
},
"mandatory":false,
"key":"filterLabelOverride"
}
],
"key":"itemListFilterFieldDefinition"
}
],
"updateServiceName":"",
"minimumSelectedAttributes":0,
"supportedTypes":{
"data":[
{
"itemListsData":[
{
"selectionGroupIds":[
"PCI"
],
"objectType":"PTC.ContentItem"
},
{
"selectionGroupIds":[
"PVR"
],
"objectType":"PTC.Visualization.Representation"
},
{
"selectionGroupIds":[
"PNDCI"
],
"objectType":"PTC.Nav.DesignFiles.Custom.Implementation"
},
{
"selectionGroupIds":[
"PVRCI"
],
"objectType":"PTC.Visualization.Representation.Custom.Implementation"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"allowSubsetForTailoring":false
},
"addServiceName":"",
"maximumSelectedAttributes":1
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.AttributesSelector"
},
"mandatory":false,
"key":"filterFields"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"directDefinition":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":"",
"overflow":null,
"minimumSelectedItems":null,
"options":[
{
"data":{
},
"description":"[[PTC.Nav.DesignFiles.Configuration.DescribedByDocuments_HelpText]]",
"label":"[[PTC.Nav.DesignFiles.Configuration.DescribedByDocuments]]",
"key":"describedByDocuments"
},
{
"data":{
},
"description":"[[PTC.Nav.DesignFiles.Configuration.ReferenceDocuments_HelpText]]",
"label":"[[PTC.Nav.DesignFiles.Configuration.ReferenceDocuments]]",
"key":"referenceDocuments"
},
{
"data":{
},
"description":"[[PTC.Nav.DesignFiles.Configuration.Attachments_HelpText]]",
"label":"[[PTC.Nav.DesignFiles.Configuration.Attachments]]",
"key":"attachments"
},
{
"data":{
},
"additionalDefinition":[
{
"directDefinition":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"options":[
{
"description":"[[PTC.Nav.DesignFiles.Configuration.AllFiles_HelpText]]",
"label":"[[PTC.Nav.DesignFiles.Configuration.AllFiles]]",
"key":"defaultFile"
},
{
"description":"[[PTC.Nav.DesignFiles.Configuration.DefaultFile_HelpText]]",
"label":"[[PTC.Nav.DesignFiles.Configuration.DefaultFile]]",
"key":"allFiles"
}
],
"updateServiceName":null,
"addServiceName":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.RadioButton"
},
"mandatory":true,
"key":"fileSelection"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"options":[
{
"description":"[[PTC.Nav.BusinessLogicCommon.Configuration.AllFormats_HelpText]]",
"label":"[[PTC.Nav.BusinessLogicCommon.Configuration.AllFormats]]",
"key":"allFormats"
},
{
"additionalDefinition":[
{
"directDefinition":[
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Textbox"
},
"mandatory":true,
"key":"formats"
}
],
"key":"formatsDefinition"
}
],
"description":"[[PTC.Nav.BusinessLogicCommon.Configuration.SpecifiedFormats_HelpText]]",
"label":"[[PTC.Nav.BusinessLogicCommon.Configuration.SpecifiedFormats]]",
"key":"specifiedFormats"
}
],
"updateServiceName":null,
"addServiceName":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.RadioButton"
},
"mandatory":true,
"key":"fileFormatSelection"
}
],
"key":"designFileImplementationDefinition"
}
],
"description":"[[PTC.Nav.DesignFiles.Configuration.Representations_HelpText]]",
"label":"[[PTC.Nav.DesignFiles.Configuration.Representations]]",
"key":"representations"
}
],
"updateServiceName":null,
"minimumSelectedAttributes":"1",
"addServiceName":null,
"constraints":{
"enforceMinimumSelectedItems":{
"message":"[[PTC.Nav.DesignFiles.Configuration.SelectAtleastOneRelationship_ErrorText]]"
}
}
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.CheckboxArray"
},
"mandatory":true,
"key":"relationships"
}
]
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.DefinitionGroup"
},
"mandatory":false,
"key":"implementationConfiguration"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Textbox"
},
"mandatory":false,
"key":"label"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"minValue":50,
"default":500,
"maxValue":10000,
"step":50
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Number"
},
"mandatory":false,
"key":"maxNumberOfRowsInGrid"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"options":[
{
"description":"Disallow items selection",
"label":"[[PTC.Nav.ItemList.SelectionType.None]]",
"key":"none"
},
{
"description":"Allow single item selection",
"label":"[[PTC.Nav.ItemList.SelectionType.Single]]",
"key":"single"
},
{
"description":"Allow multiple items selection",
"label":"[[PTC.Nav.ItemList.SelectionType.Multiple]]",
"key":"multi"
}
],
"updateServiceName":null,
"addServiceName":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.RadioButton"
},
"mandatory":false,
"key":"selectionType"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":true,
"true":{
"additionalDefinition":[
{
"directDefinition":[
{
"property":{
"options":[
[
{
"label":"[[PTC.Nav.ItemList.ExportCSVActionLabel]]",
"key":"exportToCsv"
},
{
"label":"[[PTC.Nav.ItemList.ExportCSVAsExcelActionLabel]]",
"key":"exportToExcel"
}
]
]
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":"",
"overflow":null,
"minimumSelectedItems":null,
"options":[
],
"updateServiceName":null,
"addServiceName":null,
"constraints":{
}
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.CheckboxArray"
},
"mandatory":false,
"key":"exportTypes"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":false,
"true":{
"additionalDefinition":[
],
"label":null
},
"false":{
"additionalDefinition":[
],
"label":null
},
"label":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Toggle"
},
"mandatory":false,
"key":"exportUnFilteredData"
}
],
"key":"itemListExportDefinition"
}
],
"label":"[[PTC.Nav.Yes]]"
},
"false":{
"additionalDefinition":[
],
"label":"[[PTC.Nav.No]]"
},
"label":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.Toggle"
},
"mandatory":false,
"key":"showExportAction"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"listLabel":null,
"showFilter":false,
"minimumSelectedItems":0,
"showDropDown":false,
"options":[
{
"label":"[[PTC.Nav.BusinessLogicCommon.Configuration.DownloadAll]]",
"key":"downloadZip"
}
],
"updateServiceName":null,
"addServiceName":null,
"showClearSelectedItems":false,
"dropDownLabel":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.List"
},
"mandatory":false,
"key":"showImplementationActions"
},
{
"property":{
},
"value":{
"initializationData":{
"version":"1.0.0",
"constraints":{
},
"properties":{
"default":"alphanumeric",
"options":[
{
"description":"Alphanumeric sort order",
"label":"[[PTC.Nav.ItemList.SortOrder.Alphanumeric]]",
"key":"alphanumeric"
},
{
"description":"Natural sort order",
"label":"[[PTC.Nav.ItemList.SortOrder.Natural]]",
"key":"natural"
}
],
"updateServiceName":null,
"addServiceName":null
}
},
"elementVersion":"1.0.0",
"elementName":"PTC.Nav.DynamicForm.RadioButton"
},
"mandatory":false,
"key":"sortOrder"
},
{
"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":"waitForInput"
}
]
}