Liste der Feldannotationen

cmweb-common (Typ)

groupable

• Typ: cmweb-common
• Beschreibung: Ermöglicht die Gruppierung in der Ticketliste.
• Werte:
  • true: Wird nur für Datenfelder des Typs enum verwendet. Entfernen Sie die Annotation, wenn Sie die Gruppierung deaktivieren möchten.

sortable

• Typ: cmweb-common
• BeschreibungErmöglicht die Sortierung in der Ticketliste.
• Werte:
  • true: Wird für Datenfelder des Typs date oder enum verwendet. Entfernen Sie die Annotation, wenn Sie die Sortierung deaktivieren möchten.
    Für Felder des Typs enum : Funktioniert nur, wenn alle Werte des enum-Feldes indiziert werden.

common (Typ)

leave-trailing-zeros

• Typ: common
• Beschreibung: Wird für die Anzeige von Festkommazahlen verwendet.
• Werte:
  • true / false: Nullen am Ende der Nachkommastellen werden nicht abgeschnitten, wenn der Wert true ist.

readonly

• Typ: common
• BeschreibungZeigt an, dass das Ticketfeld nicht verändert werden kann.
• Werte:
  • true / false: Das Feld ist schreibgeschützt, wenn der Wert auf true gesetzt ist. Wenn kein Wert oder ein anderer Wert als false gesetzt ist, wird true angenommen.

visibility

• Typ: common
• Beschreibung: Definiert, wann das Feld sichtbar ist.
• Werte:
  • edit: Das Feld wird im Bearbeitungsmodus angezeigt.
  • view: Das Feld wird im Ansichtsmodus angezeigt.
  • none: Das Feld ist nicht sichtbar.
  • Wenn ein anderer Wert oder kein Wert gesetzt ist, ist das Feld immer sichtbar.

component-type (Typ)

boolean-type

• Typ: component-type
• Beschreibung: Definition des Layouts eines Boolean-Felds.
• Werte:
  • checkbox (Standardwert): Das Feld kann markiert werden (standardmäßig auf false gesetzt).
  • radio: 2 Radio-Buttons (ja/nein) zur Auswahl (es kann nur einer aktiv sein).
  • select: Drop-down-Feld mit 2 Werten (ja/nein).

enum-in-search-type

• Typ: component-type
• Beschreibung: Definiert, ob für ein Feld des Datentyps enum bei einer Suche über mehrere Werte gesucht werden kann.
• Werte:
  • single (Standardwert) / multiple: Wenn der Wert multiple gesetzt ist, kann über mehrere Werte gesucht werden.

enum-type

• Typ: component-type
• Beschreibung: Definition des Layouts der Listenansicht
• Werte:
  • select (Standardwert): Drop-down-Liste für die Auswahl.
  • radio: Liste mit Radio-Buttons für die Auswahl (es kann nur eine Option aktiv sein).
  • autocomplete: Drop-down-Liste für die Auswahl. Das Feld ist ein Eingabefeld, mit dem die Liste gefiltert werden kann.

list-type

• Typ: component-type
• Beschreibung: Deaktiviert die Optionen zum Hinzufügen bzw. Löschen bei Datenfeldern des Typs list oder struct.
• Werte:
  • fixed-size: Es ist nicht möglich, Felder/Zeilen zu löschen oder hinzuzufügen.
  • non-shrinkable: Es ist nicht möglich, Felder/Zeilen zu löschen.
  • non-growable: Es ist nicht möglich, Felder/Zeilen hinzuzufügen.

text-type

• Typ: component-type
• Beschreibung: Definiert mögliche Arten eines Felds des Datentyps string .
• Werte:
  • text (Standardwert): Einzeiliges Eingabefeld
  • textarea: Mehrzeiliges Eingabefeld
  • password: Eingabefeld für Passwörter.
    Das Passwort wird im Ansichtsmodus als ******* angezeigt.
  • label: Eingabe wird als Label angezeigt, d.h. das Feld wird nur angezeigt, es ist keine Dateneingabe möglich.
  • autocomplete: Das Feld wird als Autocomplete-Liste verwendet. Eine detaillierte Erklärung dazu finden Sie im ConSol CM Administratorhandbuch, Abschnitt Admin-Tool-Skripte, Skriptbasierte Autocomplete-Listen.
  • url: Eingabe wird im Anzeige-Modus als Link dargestellt. Der String muss dafür diesem URL-Muster entsprechen:
    "^((?:mailto\:|(?:(?:ht|f)tps?)\://)1\S+)(?: (?:\| )?(.*))?$"
    Beispiel: "http://consol.de ConSol"
  • file-url: Die Eingabe wird als Link auf eine Datei im Dateisystem angezeigt. Der Webbrowser muss solche Links zulassen/unterstützen! Informationen dazu finden Sie im Abschnitt Details über String-Felder: Verwenden von Annotationen zum Anpassen von Strings. Dieser Link wird auch als Tooltip angezeigt.

    Die URL ist korrekt formatiert, wenn folgende Bedingungen erfüllt sind:

    Sie beginnt mit file: gefolgt von normalen Schrägstrichen:

    • drei Schrägstriche "///" für Dateien, die sich auf demselben Computer befinden wie der Browser (alternativ "//localhost/") oder
    • zwei Schrägstriche gefolgt vom Servernamen und einem weiteren Schrägstrich für Dateien auf Dateiservern, die vom Rechner, auf dem der Webbrowser läuft, erreichbar sind.

    Danach folgt der vollständige Dateipfad, der mit dem Dateinamen endet. Auf Microsoft Windows-Systemen wird der Pfad ebenfalls mit normalen Schrägstrichen anstelle von umgekehrten Schrägstrichen geschrieben.

    Der Laufwerksbuchstabe eines lokalen Pfads auf Microsoft Windows-Systemen wird wie üblich verwendet, zum Beispiel C:. Pfade mit Leerzeichen und Sonderzeichen wie "{, }, ^, #, ?" müssen auf Microsoft Windows-Systemen mit Prozentzeichen kodiert werden (z. B. mit "%20" für ein Leerzeichen).

    Beispiel-URLs:

    • file://file-server/path/to/my/file.ext
    • file:///linux/local/file.pdf
    • file:///C:/Users/myuser/localfile.doc

contact authentication (Typ)

ldapid

• Typ: contact authentication
• Beschreibung: Wird in einer Kundenfeldgruppe des Typs Kontakt für das Kundenfeld verwendet, das die LDAP-ID für die Authentifizierung in CM/Track enthält.
• Werte: Gibt an, dass das Feld im Authentifizierungsprozess als LDAP-ID verwendet wird. Als Datentyp ist string erforderlich.
  Da die Definition auf Kundengruppenebene vorgenommen wird, kann die LDAP-Authentifizierung im gemischten Modus verwendet werden, d. h. es kann für einige Kundengruppen LDAP verwendet werden und für andere Kundengruppen die reguläre Authentifizierung.

password

• Typ: contact authentication
• Beschreibung: Gibt an, dass das Feld im Authentifizierungsprozess als Passwort verwendet wird.
• Werte:
  • <string>: Für CM/Track verwendet.

username

• Typ: contact authentification
• Beschreibung: Gibt an, dass dieses Feld im Authentifizierungsprozess als Anmeldename verwendet wird.
• Werte:
  • true / false: Für CM/Track verwendet.

dwh (Typ)

dwh-no-history-field

• Typ: dwh
• Beschreibung: Die Annotation wird verwendet, um festzulegen, dass das Feld nicht im DWH protokolliert wird.
• Werte:
  • true / false: Seit Version 6.10.2.0.

reportable

• Typ: dwh
• Beschreibung: Gibt an, dass das Feld für Reports verwendet werden kann und an das DWH übertragen werden soll.
• Werte:
  • true / false: Das Feld kann in Reports verwendet werden, wenn der Wert auf true gesetzt ist.

indexing (Typ)

field indexed

• Typ: indexing
• Beschreibung: Gibt an, dass für das Feld ein Datenbankindex erstellt wird. Wenn es möglich sein soll, Ergebnistabellen (im Web Client) durch Klicken auf die Spaltenüberschrift nach einer Spalte zu sortieren, muss das entsprechende Feld indiziert sein!
• Werte:
  • transitive (Standardwert): Alle Daten werden angezeigt (Ticketdaten, Kundendaten und Ressourcendaten).
  • unit: Für Kundendaten verwendet. Es werden nur die Unit und die Parent Unit (d. h. Firma) als Suchergebnis zurückgegeben, Tickets werden nicht angezeigt.
  • local: Für Kundendaten verwendet. Es wird nur die Unit als Suchergebnis zurückgegeben, Firmen und Tickets werden nicht angezeigt.
  • <Annotation nicht gesetzt>: Das Feld ist nicht indiziert.

phonetic

• Typ: indexing
• Beschreibung: Aktiviert die phonetische Suche für dieses Feld. Kann nur für Datenfelder des Typs String verwendet werden (für long oder short string ebenfalls).
• Werte: true/false. Wird automatisch auf true gesetzt, wenn die Annotation hinzugefügt wird.

layout (Typ)

colspan

• Typ: layout
• Beschreibung: Legt fest, wie viele Spalten für das Feld im Layout reserviert werden.
• Werte:
  • <Zahl>: Anzahl der Spalten.

field-group

• Typ: layout
• Beschreibung: Ermöglicht die Gruppierung der Felder im Ansichtsmodus. Die Annotation wird im Bearbeitungsmodus ignoriert.
• Werte:
  • <string>: Um Felder zu gruppieren, muss für jedes Feld dieselbe Zeichenfolge als Annotation gesetzt werden. Zwei oder mehr Datenfelder sind verbunden, wenn sie für diese Annotation den gleichen Wert besitzen. Die Gruppe der verbundenen Datenfelder wird nur angezeigt, wenn in allen von ihnen Werte gesetzt sind.
• Entfernt in ConSol CM-Version 6.11.0.1

fieldsize

• Typ: layout
• Beschreibung: Die angezeigte Feldgröße im Ticketlayout.
• Werte:
  • <Zeilen>;<Spalten>: Angezeigte Feldgröße.
    Format für Felder des Datentyps string und number: n gibt die Anzahl der Zeichen an. Für String-Felder ist das die Anzahl an Großbuchstaben M in einer Monospace-Schriftart).
    Format für textarea: Zeilen;Spalten (entspricht <textarea Zeilen="" Spalten="">).
    Sortierte Listen werden anstatt als Drop-down-Liste als Auswahlfeld mit n Elementen angezeigt. Format für Sortierte Listen: n.
    Hinweis: Diese Annotation dient nur zur Konfiguration des Layouts. Verwenden Sie für die Validierung maxlength vom Typ group validation.
  • <Zahl>: Für Datenfelder des Typs enum. Definiert, wie viele Werte im Listenfeld direkt sichtbar sind. Nur zu Layout-Zwecken.

label-group

• Typ: layout
• Beschreibung: Zeigt eine Gruppe von Feldern im Ansichtsmodus zusammen mit ihrem beschreibenden Label an. Die Annotation wird im Bearbeitungsmodus ignoriert.
• Werte:
  • <string>: Gibt eine Gruppe Datenfelder zusammen mit ihrem beschreibenden Label an. Die Annotation wird im Ansichtsmodus verwendet und im Bearbeitungsmodus ignoriert. Die Gruppe kann genau ein Label haben (ein Datenfeld des Typs string, dem die zusätzliche Annotation text-type mit dem Wert label zugewiesen ist). Das Label wird angezeigt, wenn für mindestens ein Datenfeld der Gruppe ein Wert gesetzt ist. Alle Felder mit demselben Label werden gruppiert und unter diesem Label angezeigt.
    Außerdem muss dem Label die Annotation label-group zugewiesen werden.

label-in-view

• Typ: layout
• Beschreibung: Zeigt den Wert des Datenfelds im Ansichtsmodus als Label an. Die Annotation wird im Bearbeitungsmodus ignoriert.
• Werte:
  • true: Entfernen Sie die Annotation, wenn das Label im Ansichtsmodus nicht angezeigt werden soll.

order-in-result

• Typ: layout
• Beschreibung: Zeigt das Feld in der Liste der Suchergebnisse als Spalte an der angegebenen Position an.
• Werte:
  • <Zahl>: Die Spalten sind aufsteigend sortiert.
    Seit CM-Version 6.0.1. Eine detaillierte Erklärung dazu finden Sie in der Infobox im Abschnitt Konfiguration von Suche und Indexer des ConSol CM Administratorhandbuchs.

position

• Typ: layout
• Beschreibung: Definiert die Position eines Feldes im Rasterlayout oder in einer (list of structs).
• Werte:
  • <Zahl>;<Zahl>: Die Werte geben die Zeile und Spalte an (Zeile;Spalte), die Nummerierung beginnt bei 0;0. Wenn kein Wert gesetzt ist, wird das Datenfeld in der ersten freien Zelle des Rasters angezeigt.
  • 0;<Zahl>: Es wird nur der Wert der Spalte verwendet, der Wert der Zeile wird ignoriert.

rowspan

• Typ: layout
• Beschreibung: Legt fest, wie viele Zeilen das Feld im Layout belegt.
• Werte:
  • <Zahl>: Anzahl der Zeilen.

show-label-in-edit

• Typ: layout
• Beschreibung: Ob das Datenfeld im Bearbeitungsmodus mit Label angezeigt werden soll.
• Werte:
  • true / false: Seit Version 6.9.4.

show-label-in-view

• Typ: layout
• Beschreibung: Ob das Datenfeld im Ansichtsmodus mit Label angezeigt werden soll.
• Werte:
  • true / false: Seit Version 6.9.4.

show-tooltip

• Typ: layout
• Beschreibung: Ob das Datenfeld als Tooltip angezeigt werden soll.
• Werte:
  • true / false: Seit Version 6.9.4.

show-watermark

• Typ: layout
• Beschreibung: Ob das Datenfeld mit Wasserzeichen angezeigt werden soll.
• Werte:
  • true / false: Seit Version 6.9.4.

ticket-list-colspan

• Typ: layout
• Beschreibung: Definiert wie viele Spalten das Feld im Ticketlistenfeld belegt.
• Werte:
  • <Zahl>: Anzahl der Spalten.

ticket-list-position

• Typ: layout
• Beschreibung: Definiert die Position des Feldes im Ticketlistenfeld.
• Werte:
  • <Zahl>;<Zahl>: Die Werte geben die Zeile und Spalte an (Zeile;Spalte), die Nummerierung beginnt bei 0;0.

ticket-list-rowspan

• Typ: layout
• Beschreibung: Definiert wie viele Zeilen das Feld im Ticketlistenfeld belegt.
• Werte:
  • <Zahl>: Anzahl der Zeilen.

performance (Typ)

no-history-field

• Typ: performance
• Beschreibung: Gibt an, dass ein einzelnes Datenfeld nicht protokolliert werden soll. Überschreibt die Gruppenannotation no-history.
• Werte:
  • true / false: Die Annotation ist aktiv, wenn der Wert auf true gesetzt ist. Für Felder, die gespeichert aber nicht im Ticketprotokoll angezeigt werden sollen, wird die Annotation visibility configuration verwendet.
    In CM-Versionen bis 6.10.2 wird auch die Übertragung der Feldhistorie an das DWH mit dieser Annotation gesteuert.
    Verwenden Sie dazu ab CM-Version 6.10.2 die Annotation dwh-no-history-field.

phone commander (Typ)

dialable

• Typ: phone commander (CM/Phone)
• Beschreibung: Definiert ein Feld als Telefonnummer.
• Werte:
  • true: Für für CM/Phone verwendet. Markiert eine Telefonnummer als automatisch wählbar für ausgehende Anrufe im CTI-System.

resource (Typ)

resource-color

• Typ: resource
• Beschreibung:
• Werte:
  • true / false: Kann einem Feld des Datentyps enum mit einer Farbe zugewiesen werden. Die Farbe des ausgewählten Listenwerts wird als Hintergrundfarbe für das Ressourcen-Icon verwendet.

restapi (Typ)

customer exposure

• Typ: restapi
• Beschreibung: Gibt an, ob ein Datenfeld für Kunden über die REST-API verfügbar sein soll, z. B. in CM/Track.
• Werte:
  • full (Standardwert): Das Datenfeld ist zum Lesen und Schreiben verfügbar.
  • read: Das Datenfeld ist nur zum Lesen verfügbar.
  • none: Das Datenfeld ist nicht verfügbar. Dieser Wert kann hilfreich sein, wenn zum Beispiel eine ganze Ticketfeldgruppe mit customer exposure group = full |read konfiguriert wurde und einzelne Felder in CM/Track (oder allgemein über die REST-API) nicht verfügbar sein sollen.

search result (Typ)

contact search result column

• Typ: search result
• Beschreibung: Gibt an, ob das Feld standardmäßig in den Suchergebnissen angezeigt werden soll. Veraltet! Nicht mehr verwenden! In ConSol CM-Version 6.11 entfernt.
• Werte:
  • true:
    Entfernen Sie die Annotation, wenn das Feld nicht standardmäßig angezeigt werden soll.
    Seit CM-Version 6.1.3
    (Ersetzt durch order-in-result, contact search result column ist veraltet!)

ticket contact relation type (Typ)

contains contacts

• Typ: ticket contact relation type
• Beschreibung: Innerhalb eines Datenmodells darf nur eine Instanz dieser Annotation vorhanden sein! Sie wird nur für die Definition von Listenfeldern verwendet und gibt an, dass das Feld Unit-Referenzen zu Kontakten enthalten kann. Ab ConSol CM-Version 6.11 erzeugt das so annotierte Feld keine Einträge im Ticketprotokoll. Auf diese Weise wird die Ladezeit von Tickets, die viele Kunden haben, verringert.
• Werte:
  • true / false: Der Wert ist boolean. Gibt an, ob die Liste innerhalb eines Kontakts (true) oder eines Tickets (false) angezeigt wird.

ticket display (Typ)

enum field with ticket color

• Typ: ticket display
• Beschreibung: Legt die Hintergrundfarbe des Ticket-Icons in der Ticketliste und im Ticket fest.
• Werte:
  • true / false: Das Feld muss in den Sortierten Listen vorhanden sein, wo Listen, Werte und Farben definiert werden.

validation (Typ)

accuracy

• Typ: validation
• Beschreibung: Für Ticket-, Kunden und Ressourcenfelder des Typs Datum, um den Detailgrad der angezeigten Daten zu definieren
• Werte:
  • date (Standardwert): Datum wird ohne Zeit angezeigt.
  • date-time: Datum wird mit Zeit angezeigt.
  • only-time: Es wird nur die Zeit nicht aber das Datum angezeigt.

email

• Typ: validation
• Beschreibung: Verwendet, um bei E-Mail-Adressen zu prüfen, ob das Format korrekt ist, d. h. ob es <name>@<domain> entspricht.
• Werte:
  • true: Kann für Datenfelder des Typs string verwendet werden. Entfernen Sie die Annotation, wenn das Format nicht validiert werden soll.

format

• Typ: validation
• Beschreibung: Verwendet, um das Format von Datumsfeldern zu validieren.
• Werte:
  • <Datumsformat>: Das Muster für das Datum basiert auf SimpleDateFormat, z. B. dd.MM.yyyy.
    Denken Sie daran, den richtigen Wert für colspan einzusetzen, wenn das Format Stunden/Minuten beinhaltet. Eine Formatreferenz finden Sie in http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html.

matches

• Typ: validation
• Beschreibung: Prüft, ob die Eingabe in Datenfelder des Typs string einer angegebenen RegEx entspricht.
• Werte:
  • <string>: Kann bei Datenfeldern des Typs string verwendet werden.

maxLength

• Typ: validation
• Beschreibung: Definiert die maximale Länge der Eingabe in Datenfelder des Typs string.
• Werte:
  • <Zahl>: Kann für Datenfelder des Typs string verwendet werden.

maxValue

• Typ: validation
• Beschreibung: Definiert den Maximalwert für Datenfelder mit Zahlen.
• Werte:
  • <Zahl>: Kann für Datenfelder des Typs number verwendet werden, d. h. number und fixed-point number.

minLength

• Typ: validation
• Beschreibung: Definiert die minimale Länge der Eingabe in Datenfelder des Typs string.
• Werte:
  • <Zahl>: Kann für Datenfelder des Typs string verwendet werden.

minValue

• Typ: validation
• Beschreibung: Definiert den Minimalwert für Datenfelder mit Zahlen.
• Werte:
  • <Zahl>: Kann für Datenfelder des Typs number verwendet werden, d. h. number und fixed-point number.

required

• Typ: validation
• Beschreibung: Gibt an, dass es sich um ein Pflichtfeld handelt.
• Werte:
  • true / false: Das Feld ist ein Pflichtfeld, wenn der Wert auf true gesetzt ist. Der Benutzer kann das Ticket nicht speichern, ohne einen Wert in das Pflichtfeld eingegeben zu haben. Im Web Client sind Pflichtfelder mit einem roten Sternchen gekennzeichnet.

visibility (Typ)

visibility configuration

• Typ: visibility
• Beschreibung: Legt die Sichtbarkeit des Felds im Protokoll fest.
• Werte:
  • on every level: Das Feld wird im Protokoll in jedem Sichtbarkeitslevel angezeigt.
  • 2nd level and 3rd level: Das Feld wird im 2. und 3. Sichtbarkeitslevel des Protokolls angezeigt.
  • only 3rd level: Das Feld wird nur im 3. Sichtbarkeitslevel des Protokolls angezeigt.