CM.Resource Pool - Templates für Ressourcendaten

Einführung in die Verwendung von Templates für die Anzeige von Ressourcendaten

Im ConSol CM Web Client werden Ressourcendatensätze an mehreren Stellen in der auf den Templates basierenden Kurzform angezeigt. Im Ticketprotokoll werden möglicherweise der Ressourcenname, die Inventarnummer und der Standort benötigt, wohingegen in der Schnellsuche nur der Name und die Inventarnummer angezeigt werden sollen. In diesem Abschnitt wird erklärt, wo die Kurzformen verwendet werden, und wie Sie die zugehörigen Templates mit dem Admin Tool konfigurieren können.

Templates werden immer für den Ressourcentyp definiert. In unserem Beispiel ist HP_Printer der Ressourcentyp, d. h. die Templates gelten für alle realen HP-Drucker, die im CM-System gespeichert sind.

Die Konfiguration basiert auf folgendem Prinzip (sehr ähnlich wie das Prinzip für die Anzeige von Kundendaten):

Erstellen und Editieren von Templates für das Format von Ressourcendaten

Um Templates für das Format von Ressourcendaten zu erstellen und zu editieren, editieren Sie zuerst den gewünschten Ressourcentyp im Admin Tool und geben Sie dort die Namen der Templates ein. Wählen Sie dazu beliebige Namen oder halten Sie sich an die Konventionen Ihres Unternehmens bzgl. der Benennung.

Abbildung 534: ConSol CM Admin Tool - Definieren eines Templates für das Ressourcendatenformat eines Ressourcentyps

Im nächsten Schritt müssen Sie die entsprechenden Templates erstellen und im Bereich Skripte und Templates speichern. Eine detaillierte Beschreibung finden Sie im folgenden Abschnitt.

Coding von Templates für das Format von Ressourcendaten

Allgemeines Prinzip

Die Templates werden in der FreeMarker-Notation geschrieben. Detaillierte Informationen dazu finden Sie auf der FreeMarker-Website.

Innerhalb der Templates arbeiten Sie mit drei Objekttypen:

  1. resource: Dies ist das aktuelle Ressourcenobjekt.
  2. Der technische Name der Ressourcenfeldgruppe.
  3. Der technische Name des Ressourcenfelds.

Beachten Sie, dass es innerhalb eines Ressourcentyps mehr als eine Ressourcenfeldgruppe geben kann!

Abbildung 535: ConSol CM Admin Tool - Beim Definieren der Templates für Ressourcendaten verwendete Objekte

Die Ressourcen-Templates dürfen nur eine Zeile haben! Zeilenumbrüche sind nicht zulässig!

Beispiel für Templates

// Example 1

// Resource Field group is named vehicleProperties, Resource Fields are named vehicleIdentification and vehicleLicense

${resource.get("vehicleProperties", "vehicleIdentification") + ' (' + resource.get("vehicleProperties", "vehicleLicense") + ')'}

// Example 2

// // Resource Field group is named publicTransportProperties, Resource Fields is named passName

${resource.get("publicTransportProperties", "passName")}

Lokalisieren von Werten von Sortierten Listen in Ressourcen-Templates

Ab ConSol CM-Version 6.10.5.4 können Werte von Sortierten Listen lokalisiert werden, d. h. Sie können den lokalisierten Wert im Web Client anzeigen. Die Sortierte Liste "SLA_country" enthält zum Beispiel eine Liste der Länder, in denen eine SLA gültig ist. Im Admin Tool werden technische Werte verwendet und es muss für jede gewünschte Sprache ein lokalisierter Wert definiert werden. Im Web Client soll der richtige Ländername in der im Browser eingestellten Sprache angezeigt werden. Wenn im Browser keine Sprache eingestellt ist, wird die Standardsprache von CM verwendet.

Das folgende Beispiel funktioniert mit der Sortierten Liste "SLA_country".

SLA: ${resource.getFieldValue("SLA_Fields_basic","SLA_Name")!} (${localize(resource.getFieldValue("SLA_Fields_basic","SLA_country"))!})

Abbildung 536: ConSol CM Web Client: Anzeige des Wertes einer Sortierten Liste mittels Ressourcen-Template

Template-Typen

Es können folgende Template-Typen definiert werden:

Standard

Dieses Template muss immer definiert werden. Wenn es nicht definiert ist, tritt im Web Client ein Fehler auf (statt dem Namen der Ressourcen dieses Typs wird unknown angezeigt). Wenn keine anderen Templates definiert wurden, wird das Template an allen Stellen im Web Client und, sofern es kein spezielles Template des Typs REST gibt, auch als REST-Template für CM.Track verwendet. Die in den folgenden Abschnitten beschriebenen Templates überschreiben das Standard-Template für bestimmte Stellen im Web Client.

HP Printer: ${resource.getFieldValue("HP_Printer_Fields_basic","inventory_number")!}

Das Template wird verwendet für

Schnell-Suche

Dieses Template definiert das Format der Ressourcendaten in den Ergebnissen der Schnellsuche. Ein Beispiel finden Sie im Abschnitt Schnellsuche.

Suche

Dieses Template definiert das Format der Ressourcendaten im Ergebnis (den Listen mit Vorschlägen) von Suchen nach Ressourcen, wenn eine Ressource mit einem anderen Objekt, z. B. einem Ticket verknüpft ist. Ein Beispiel finden Sie im Abschnitt Suche.

REST

Dieses Template definiert das Format von Ressourcendaten als Ergebnis der REST API. In der Standardkonfiguration werden keine Ressourcendaten im ConSol CM-Portal CM.Track angezeigt, das auf der REST-API basiert. Dieses Template gilt nur dann, wenn die REST-API direkt angesprochen wird, z. B. bei der Programmierung von ConSol CM-Schnittstellen. Ein Beispiel finden Sie im Abschnitt REST.

Protokoll

Dieses Template definiert das Format der Ressourcendaten im Ticket-, Kunden- und Ressourcenprotokoll, z. B. wenn eine Relation zu oder von einer Ressource hinzugefügt wurde. Ein Beispiel finden Sie im Abschnitt Protokollbereiche der Ressourcenseite, der Kundenseite und des Tickets.

Stellen im Web Client für die Verwendung von Templates

Templates werden an folgenden Stellen verwendet:

Titel der Ressourcenseite

Abbildung 537: ConSol CM Web Client - Titel der Ressourcenseite

Verwendetes Template: Standard (siehe obiges Beispiel)

Gezogene Ressource bei Drag-and-Drop-Vorgängen

ConSol CM Web Client - Gezogene Ressource bei Drag-and-Drop-Vorgängen

Verwendetes Template: Standard (siehe obiges Beispiel)

Favoriten

Abbildung 538: ConSol CM Web Client - Ressourcenname in den Favoriten

Verwendetes Template: Standard (siehe obiges Beispiel)

Schnellsuche

Abbildung 539: ConSol CM Web Client - Ergebnisse der Schnellsuche (Ressource)

Verwendetes Template: Schnell-Suche, sofern definiert. Andernfalls Standard.

HP Printer: ${resource.getFieldValue("HP_Printer_Fields_basic","name")!} - ${resource.getFieldValue("HP_Printer_Fields_basic","inventory_number")!}

Suche

Abbildung 540: ConSol CM Web Client - Ressource in der Liste der Vorschläge, Format basiert auf dem Suche-Template

Verwendetes Template: Suche, sofern definiert. Andernfalls Standard.

HP Printer: ${resource.getFieldValue("HP_Printer_Fields_basic","name")!} - - ${resource.getFieldValue("HP_Printer_Fields_basic","IP_address")!}

Protokollbereiche der Ressourcenseite, der Kundenseite und des Tickets

Das Protokoll-Template einer Ressource wird zum Beispiel dann angezeigt, wenn im Ticketprotokoll für die erweiterte Ansicht Anzeigen alle Einträge ausgewählt ist.

Abbildung 541: ConSol CM Web Client - Protokoll-Template für Ressourcendaten

Verwendetes Template: Protokoll, sofern definiert. Andernfalls Standard.

REST

Das folgende Beispiel zeigt eine Abfrage von Ressourcendaten durch einen REST Client und die entsprechende Antwort des ConSol CM-Servers über die REST API. Der Wert im Tag <mark> der XML-Ausgabe ist die Ressourceninformation, die mit dem REST-Template formatiert wurde. In diesem Beispiel umfasst das Template den Ressourcennamen (My new HP Printer) und die Inventarnummer (4712).

Abbildung 542: REST API - Liste aller Ressourcen

Abbildung 543: REST API - Details einer ausgewählten Ressource (ID 2)

HP Printer: ${resource.getFieldValue("HP_Printer_Fields_basic","name")!} - ${resource.getFieldValue("HP_Printer_Fields_basic","inventory_number")!}

Verwendetes Template: REST, sofern definiert. Andernfalls Standard.