Elementliste
Definition und Verwendung
Die Komponente "Elementliste" ist ein enthaltenes Mashup, welches das Anzeigen einer Liste von Elementen aus einem Datensatz in einer Rasteransicht ermöglicht. Außerdem können Endbenutzer die Liste durchsuchen, sortieren und filtern sowie Aktionen für die gesamte Liste oder spezifische Listenelemente durchführen.
Die folgende Beispielabbildung zeigt die Komponente "Elementliste":
Die Komponente "Elementliste" kann auf folgende Weise konfiguriert werden:
• Aktivieren/Deaktivieren von Suche und Filterung
• Festlegen anfänglicher Optionen für Filterung und Sortieren
• Festlegen der maximalen Anzahl an Zeilen im Raster
• Festlegen, ob Elemente in der Liste ausgewählt werden können, und wenn ja, ob ein oder mehrere Elemente ausgewählt werden können
• Konfigurieren der in der eingebetteten Aktionsleiste zur Verfügung stehenden Aktionen
• Auswahl, ob die Aktion "Exportieren" angezeigt werden soll
Der Benutzer kann die Elementliste mithilfe der Filterfelds filtern oder unter Verwendung des Suchfelds durchsuchen. Sind das Filter- und das Suchfeld in der Konfiguration jedoch nicht aktiviert, so ist weder das Filtern noch das Durchsuchen möglich. Sie können auf einen Spaltentitel klicken, um die Liste anhand dieser Spalte zu sortieren. Klicken Sie erneut auf den Spaltentitel, um die Sortierreihenfolge umzukehren.
Die Komponente "Elementliste" enthält eine eingebettete Komponente "Aktionsliste". Durch Konfigurieren der Aktionsleiste können Sie weitere Funktionen aktivieren, z.B. das Ausführen einer Aktion für ein oder mehrere Listenelemente. Siehe Aktionsleiste (Beta) für weitere Informationen. Standardmäßig enthält "Elementliste" die Aktion Exportieren, die alle den Filterkriterien entsprechenden Elemente in eine CSV-Datei exportiert.
Die Elementliste enthält auch eine Schaltfläche Standards wiederherstellen. Die Schaltfläche Standards wiederherstellen stellt die Standardeinstellungen für die Filterung, die Suche sowie Operationen auf Rasterebene (einschließlich Sortieren, Austauschen, Anzeigen und Ausblenden von Spalten) wieder her.
Aktivität, Betroffene Elemente, Anhänge und Aufgaben sind die vordefinierten Konfigurationen, die für die Komponente "Elementliste" verfügbar sind.
Bindende Eigenschaften
Eingabe | ||
|---|---|---|
Eigenschaftenname | Beschreibung | Eigenschaftstyp |
input | Dient zum Identifizieren der Daten, die aus dem Backend-System abgerufen werden sollen. Wenn eine Eingabe erforderlich ist, legen Sie für die Konfigurationseigenschaft waitForInput den Wert true fest. Beispiel-JSON: { "version":"1.0.0", "data":[ { "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" }, "itemListsData":[ { "items":[ { "id":{ "value":"OR:wt.workflow.work.WorkItem:1432583" } } ], "objectType":"PTC.Workflow.WorkItem" } ] } ] } | JSON im CCO-Format |
tailoringName | Identifiziert eine Instanz der Komponente "Elementliste" eindeutig. Dieser Wert wird intern für die Suche nach Anpassungsinformationen für die bestimmte Instanz verwendet. Verwenden Sie diese Bindungseigenschaft nur, wenn eine dedizierte Anpassungsseite für Ihre benutzerdefinierte Aufgabe vorhanden ist. | |
Ausgabe | ||
|---|---|---|
Eigenschaftenname | Beschreibung | Eigenschaftstyp |
totalItemsNumber | Anzahl der Listenelemente, die den Such- und Filterkriterien entsprechen | Integer |
selectedItems | Dient zum Identifizieren der ausgewählten Rasterelemente und ihrer Attribute. Diese Eigenschaft kann an die input-Bindungseigenschaft anderer Komponenten gebunden werden. Beispiel-JSON: { "timeStamp":"2019-08-25 18:53:33.476", "data":[ { "itemListsData":[ { "items":[ { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143921" } }, { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143928" } } ], "objectType":"PTC.Workflow.WorkItem" } ], "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" } } ], "version":"1.0.0", "statusMessage":"OK", "status":"200" } | JSON im CCO-Format |
Konfigurationseigenschaften
Die folgende Tabelle zeigt die für die Konfiguration dieser Komponente verwendeten JSON-Felder an.
Weitere Informationen zur Struktur der Konfiguration finden Sie unter Konfigurationsstruktur von Komponenten.
Weitere Informationen zu Untereigenschaften finden Sie unter Untereigenschaften und Container-Schlüssel.
Eigenschaftenname | Beschreibung | Eigenschaftstyp | Standardwert | Erforderlich oder optional | |
|---|---|---|---|---|---|
actionBarConfiguration | Konfiguration der eingebetteten Aktionsleiste. Siehe Aktionsleiste (Beta) für weitere Informationen. | -/- | Optional | ||
attributes | Anzuzeigende Attribute. Diese werden als Spaltentitel im Raster angezeigt. | -/- | Erforderlich | ||
defaultSelectedFilterValue | Der ursprünglich ausgewählte Wert oder die ursprünglich ausgewählten Werte, nach dem bzw. denen gefiltert werden soll. Bei keiner Angabe findet keine standardmäßige Filterung statt. Diese Eigenschaft ist eine Untereigenschaft von filterFields und nur relevant, wenn filterFields in der Konfiguration enthalten ist. Der Container-Schlüssel ist itemListFilterFieldDefinition. | -/- | Optional | ||
defaultSortDirection | Die Richtung der Standardsortierung. Optionen: asc signalisiert eine aufsteigende Reihenfolge und dsc eine absteigende. Ist diese Eigenschaft leer, so ist die Sortierreihenfolge aufsteigend. Diese Eigenschaft ist eine Untereigenschaft von defaultSortField und nur relevant, wenn defaultSortField in der Konfiguration enthalten ist. Der Container-Schlüssel ist itemListDefaultSortFieldDefinition. | asc | Optional | ||
defaultSortField | Die ursprüngliche Spalte, nach der sortiert werden soll. Wenn keine Angabe erfolgt, wird die Elementliste nach der ersten Spalte sortiert. | -/- | Optional | ||
enableSearch | Legt fest, ob das Suchfeld angezeigt werden soll Optionen: true, false. | true | Optional | ||
filterFields | Die IDs im Backend-System der Felder, nach denen die Daten zu filtern sind. Wenn keine Angabe erfolgt, besteht keine Möglichkeit zum Filtern der Daten. | -/- | Optional | ||
filterLabelOverride | Eine Beschriftung für den Filter, der den vom Dienst GetItems zurückgegebenen Anzeigewert überschreibt. Diese Eigenschaft ist eine Untereigenschaft von filterFields und nur relevant, wenn filterFields in der Konfiguration enthalten ist. Ihr Container-Schlüssel ist itemListFilterFieldDefinition. | -/- | Optional | ||
implementationConfigurations | Eintrittspunkt für den Anwendungs-Generator, um zusätzliche, für die Implementierung nötige Werte zur weiteren Anpassung der Komponente zu übergeben | -/- | Optional | ||
label | Der Titel der Elementliste | [[PTC.ItemList]] | Optional | ||
maxNumberOfRowsInGrid | Maximale Anzahl der im Rasterbereich anzuzeigenden Zeilen. Es wird empfohlen, einen Wert kleiner als 10.000 einzugeben. | 500 | Optional | ||
searchHintText | Der im Suchfeld angezeigte Hinweistext Diese Eigenschaft ist eine Untereigenschaft von enableSearch und ist nur relevant, wenn enableSearch auf true festgelegt ist. Der Container-Schlüssel ist itemListSearchDefinition. | Find Item | Optional | ||
selectionType | Legt fest, wie viele Elemente im Raster auf einmal ausgewählt werden können. Optionen: • none – Rasterelemente können nicht ausgewählt werden. • single – es kann jeweils ein Rasterelement ausgewählt werden. • multi – ein oder mehrere Rasterelemente können gleichzeitig ausgewählt werden. | multi | Optional | ||
showExportAction | Aktiviert oder deaktiviert die Aktion "Exportieren". Optionen: true, false. | true | Optional | ||
waitForInput | Legt fest, ob zur Laufzeit auf einen Wert gewartet werden soll, der an den Eingabe-Mashup-Parameter der Elementliste übergeben wird, bevor Elemente zum Füllen des Rasters abgerufen werden. Optionen: true, false. | false | Optional | ||
Beispielkonfiguration
Beispielkonfigurationen für die Komponente "Elementliste" finden Sie unter Aktivität, Betroffene Elemente, Anhänge und Aufgaben.
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.
 | Wenn Sie ein JSON-Objekt im CCO-Format von einer Geschäftslogik-Implementierungskomponente in die Elementlisten-Komponente zurückgegeben, schließen Sie nur Attribute eines einzelnen Objekttyps ein. Derzeit unterstützt die Elementliste das Einschließen von Attributen unterschiedlicher Objekttypen nicht. |
Name | Beschreibung |
|---|---|
GetConfigurations | Gibt die verfügbaren Konfigurationen für die Implementierung der Komponente zurück. Parameter: Keine Gibt zurück: JSON |
GetImplementationLabel | Gibt entweder den lokalisierten Namen der Komponente oder das Token zurück, die verwendet werden können, um den lokalisierten Namen abzurufen. Dieser lokalisierte Name wird in der Benutzeroberfläche von Mashup Builder angezeigt. Parameter: Keine Gibt zurück: Zeichenfolge |
GetItems | Gibt die Liste der Elemente aus dem Backend-System zurück. Überschreiben Sie diesen Dienst, um benutzerdefinierten Daten abzurufen, um eine benutzerdefinierte Implementierung der Elementliste zu erstellen. Parameter: input (Optional) – JSON im CCO-Format, das die Eingabe-ID für die aus dem Backend-System abzurufenden Daten und die Adapterinformationen für das Backend-System enthält Wenn Sie diesen Parameter verwenden, stellen Sie sicher, dass die Konfigurationseigenschaft waitForInput auf true festgelegt ist. configuration (Erforderlich) – JSON mit der endgültigen zusammengeführten Konfiguration, die aus der Anpassungsmanager-Ressource abgerufen wurde Gibt zurück: JSON im CCO-Format |
InitializeFilters | Gibt die Filtertypdefinition für jedes der Filterfelder in der Konfiguration zurück. Parameter: input (Optional) – JSON im CCO-Format, das die Eingabe-ID für die aus dem Backend-System abzurufenden Daten und die Adapterinformationen für das Backend-System enthält configuration (Erforderlich) – JSON mit der endgültigen Konfiguration, die aus der Anpassungsmanager-Ressource abgerufen wurde Gibt zurück: JSON im CCO-Format |
DefHookImplementationConfigurationDefinitionGroup | Gibt die implementierungsspezifische Definition mit den benutzerdefinierten Konfigurationen für die Implementierung zurück. Parameter: Keine Gibt zurück: JSON-Array |
DefHookImplementationAttributesDefinition | Gibt die implementierungsspezifische Definition für die ausgewählten Attribute zurück. Parameter: Keine Gibt zurück: JSON-Array |
DefHookMaxRowsProperties | Gibt die Eigenschaften für die maximale Anzahl von Zeilen zurück, die im Rasterbereich angezeigt werden sollen. Parameter: Keine Gibt zurück: JSON |
Implementierungsdefinition
Implementierungsdefinitionen für die Komponente "Elementliste" finden Sie unter Aktivität, Betroffene Elemente, Anhänge und Aufgaben.