Dokumentstruktur
Die Dokumentstruktur ist eine vordefinierte Konfiguration der Komponente "Elementliste". Die Dokumentstruktur enthält einen Strukturbaum, der die hierarchische Beziehung zwischen einem Dokument und dessen untergeordneten Elementen anzeigt. Für jedes Element im Baum zeigt die Dokumentstruktur Attribute an, die Sie über die Konfiguration auswählen können. Die Standardattribute sind Nummer, Name und Lebenszyklusstatus.
Sie können die Dokumentstruktur konfigurieren, um die anfängliche Erweiterungsebene der Baumstruktur festzulegen. Standardmäßig ist die anfängliche Erweiterungsebene auf 3 festgelegt. Benutzer können Elemente im Baum erweitern und verkleinern.
Der Dokumentstrukturbaum enthält einen Einzug in der Spalte ganz links, um die Strukturebene optisch zu verdeutlichen. Die erste Spalte in der Tabelle lautet standardmäßig: Nummer. Für alle Spalten außer der Spalte "Nummer" können Sie die Spaltenreihenfolge über die Konfiguration festlegen.
In der Dokumentstruktur wird das Exportieren von Baumdaten nicht unterstützt.
Die folgende Beispielabbildung zeigt die vordefinierte Konfiguration "Dokumentstruktur":
Dokumentstruktur-Komponente in der Navigate Benutzeroberfläche
* 
Wenn ein Benutzer, der einen Strukturbaum anzeigt, keine Zugriffsrechte für ein Element in der Struktur besitzt, so wird dieses Element nicht angezeigt. Es wird die folgende Meldung angezeigt: "Einige Elemente sind ausgeblendet, da Sie nicht über die entsprechenden Zugriffsrechte verfügen."
Bindende Eigenschaften 
Informationen zum Binden der "Dokumentstruktur" finden Sie in der Komponente Elementliste.
* 
Für "Dokumentstruktur" unterstützt die Eingabe-Bindungseigenschaft den Objekttyp PTC.DocMgmt.Document.
Die Ausgabe der Bindungseigenschaft selectedItems enthält Elemente mit dem Objekttyp PTC.DocMgmt.DocStructure.
Konfigurationseigenschaften 
Eine Liste aller verfügbaren Konfigurationseigenschaften für "Dokumentstruktur" finden Sie in der Tabelle "Konfigurationseigenschaften" für die Komponente Elementliste. Die folgende Tabelle enthält zusätzliche Informationen, die für "Dokumentstruktur" in Bezug auf die Konfigurationseigenschaften spezifisch sind.
Weitere Informationen zur Struktur der Konfiguration finden Sie unter Konfigurationsstruktur von Komponenten.
Weitere Informationen zu Untereigenschaften finden Sie unter Untereigenschaften und Container-Schlüssel.
Eigenschaftsname
Beschreibung
Eigenschaftstyp
Standardwert
Erforderlich oder optional
attributes
Weitere Informationen finden Sie unter Elementliste.
Akzeptiert Attribute des Objekttyps PTC.DocMgmt.DocStructure.
Außerdem wird das Attribut DefaultPDFRepresentation mit dem Objekttyp PTC.DocMgmt.DocStructure:PTC.Visualization.Representation.Custom.Adapter akzeptiert. Wenn das Attribut DefaultPDFRepresentation in der Konfiguration enthalten ist, enthält die Dokumentstrukturstruktur eine Spalte Darstellung. Die Spalte Darstellung enthält einen Link, um die Darstellung für jedes Dokument anzuzeigen, für das eine solche verfügbar ist.
Standardmäßig wird der Dokumentstrukturbaum nach dem ersten Attribut sortiert, d.h. dem Attribut mit dem niedrigsten nicht negativen Ordinalwert.
-/-
Erforderlich
Beispielkonfiguration 
{
"attributes":{
"inTailoring":true,
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":"DefaultPDFRepresentation",
"ordinal":3
}
],
"objectType":"PTC.DocMgmt.DocStructure:PTC.Visualization.Representation.Custom.Adapter"
},
{
"items":[
{
"id":"Document|Number",
"ordinal":0
},
{
"id":"Document|Name",
"ordinal":1
},
{
"id":"Document|State#Display",
"ordinal":2
}
],
"objectType":"PTC.DocMgmt.DocStructure"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
}
},
"defaultExpansionLevel":{
"selectedKey":[
"3"
]
},
"enableSearch":{
"value":false
},
"label":{
"value":""
},
"selectionType":{
"selectedKey":"single"
},
"showExportAction":{
"value":false
},
"waitForInput":{
"value":true
},
"baseConfigurationVersion":{
"value":"nav.3"
},
"implementationConfigurationVersion":{
"value":"nav.1"
}
}
Anpassungsdienste 
Zusätzlich zur Konfiguration unterstützt jede Komponente das Anpassen durch Erweitern ihrer Geschäftslogik. Die Geschäftslogik jeder Komponente umfasst überschreibbare Dienste in einer Dingvorlage, die Sie erweitern und überschreiben können. Die überschreibbaren Dienste für diese Komponente sind in der nachfolgenden Tabelle aufgeführt.
Beispiele für Rückgaben und Parameter für jeden Dienst finden Sie unter Beispiele für Eingaben/Ausgaben für Anpassungsdienste.
Name
Beschreibung
DefHookAttributesTypesInfo
Gibt ein JSON-Array mit Adapterinformationen und den von "Dokumentstruktur" unterstützten Objekttypen der Attribute zurück.
Parameter: Keine
Gibt zurück: JSON-Array
GetConfigurations
Gibt die verfügbaren Konfigurationen für die Dokumentstruktur zurück.
Parameter: Keine
Gibt zurück: JSON
GetImplementationSettings
Gibt die Einstellungsdaten der Dokumentstruktur-Implementierung zurück. Implementierungen können diesen Dienst überschreiben, um ihre eigenen Einstellungen festzulegen. Weitere Informationen finden Sie im Thema Zusätzliche Informationen zum Dienst "GetImplementationSettings" für die Elementliste.
Parameter: Keine
Gibt zurück: JSON-Objekt
GetItems
Gibt die Struktur für das Dokument zurück, das in der Eingabe angegeben wurde.
Parameter:
input (Erforderlich) – JSON im CCO-Format, das die Eingabe-ID für die aus dem Backend-System abzurufenden Daten sowie die Adapterinformationen für das Backend-System enthält
configuration (Erforderlich) – JSON mit der endgültigen zusammengeführten Konfiguration, die aus der Anpassungsmanager-Ressource abgerufen wurde
Gibt zurück: JSON im CCO-Format
MapItemToInputObject
Ordnet ein Dokumentstrukturelement einer Eingabe zu, die dann vom Dienst GetItems verwendet werden kann.
Parameter:
input (Optional) – JSON im CCO-Format, die die Eingabe-ID für das Dokument im Strukturstamm enthält.
item (Erforderlich) – JSON, die das zuzuordnende Dokument enthält.
Gibt zurück: JSON im CCO-Format mit einem einzelnen Dokument, das nur das Attribut id enthält.
Implementierungsdefinition 
{
"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": [
"PSI"
],
"objectType": "PTC.DocMgmt.DocStructure"
}
],
"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": [
"PSI"
],
"objectType": "PTC.DocMgmt.DocStructure"
}
],
"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]]"
}
}
},
"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": [
"PSI"
],
"objectType": "PTC.DocMgmt.DocStructure"
}
],
"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": {}
},
"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
}
}
},
"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]]"
}
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "showExportAction"
},
{
"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]]"
}
}
},
"elementVersion": "1.0.0",
"elementName": "PTC.Nav.DynamicForm.Toggle"
},
"mandatory": false,
"key": "waitForInput"
}
]
}
War dies hilfreich?