Skip to main content

Expertenmodus

Warnung

Verwenden Sie den Expertenmodus nur, wenn Sie ausreichende Fachkenntnisse über die KIX-Struktur und über JSON besitzen. Insbesondere, wenn Sie Änderungen an den Standardformularen vornehmen. Im Fehlerfall könnten die Formulare nicht mehr bedienbar sein.

Der JSON-Editor bildet die vollständige Konfiguration des Formulars als JSON-Struktur ab. Sollten Sie das Formular mittels Formulardesigner erstellt haben, so wird auch diese Struktur im JSON-Editor abgebildet.

Konfiguriert werden können das Layout des Formulars (formLayout) und die Seiten (pages) nebst Formularfeldern.

Der Parameter formLayout enthält die Grund-Konfiguration (Layout) des Formulars. Konfiguriert werden können:

Parameter

Beschreibung

fields

Für konkrete Felder kann hier angegeben werden, wie viele Spalten das Feld einnehmen soll.

Kann verwendet werden, um ein zu großes Feld kleiner darzustellen

fontSize

Definiert die Schriftgröße im Formular

  • sm - small

  • md - medium

  • lg - large

Standard: sm

groupLayout

Optional: Definiert, wie viele Spalten eine Gruppe einnehmen soll (auch responsive)

Für jede Gruppe existiert ein Konfigurationsblock, der von geschweiften Klammern umschlossen ist.

"groupLayout": [
      {
        "groupId": "1745929386952",
        "colSM": "12",
        "colMD": "4",
        "colLG": "4",
        "fieldLayout": [],
        "rowLayout": [
          [
            {
              "formObjectIds": [
                "ticket-new-form-field-organisation",
                "ticket-new-form-field-contact"
              ],
              "colLG": 12
            }
          ]
        ]
      },
      {...}
    ]
  • groupID: ID der Gruppe

Eine Gruppe nimmt initial eine Breite von 12 Spalten ein. Sie können abweichend andere Breiten für unterschiedliche Displaygrößen angeben:

  • colLG: Anzahl der Spalten für große Displays

  • colMD: Anzahl der Spalten für mittlere Displays

  • colSM: Anzahl der Spalten für kleine Displays

  • fieldLayout: (optional) Enthält alle Felder, die der Gruppe zugeordnet sind

    Für jedes Feld existiert ein Konfigurationsblock, der von geschweiften Klammern umschlossen ist.

    Sie können angeben, wieviele Spalten die Felder einnehmen sollen

    • colLG: Anzahl der Spalten für große Displays

    • colMD: Anzahl der Spalten für mittlere Displays

    • colSM: Anzahl der Spalten für kleine Displays

  • rowLayout: (optional) Gibt an, wie viele Spalten eine Zeile haben soll und welche Felder in den Spalten angezeigt werden sollen.

    • [...] - alle Zeilen (äußere)

      Jede Zeile (row) wird darin als weitere [ ] dargestellt

    • {...} - Container für Spalten

    • colLG | colMD |colSM - Anzahl der Spalten je Bildschirmgröße

    • formObjectIds - enthält die zugeordneten Felder

rowLayout

(optional) Gibt an, wie viele Spalten eine Zeile haben soll und welche Gruppen in den Spalten angezeigt werden sollen.

rowLayout ist ein Array von Objekten. Diese Objekte definieren die Seite und deren Layout von Zeilen. In den Zeilen werden die Spalten konfiguriert. In den Spalten wird hinterlegt, wie groß diese sein sollen (12er Grid) und welche Gruppen in den Spalten enthalten sein sollen

Hinweis

Die Gruppen beziehen ihre eigene Größe aus der groupLayout Konfiguration.

Beispiel: 

"rowLayout":[
      {
        "pageId": "1745929366718",
        "rows": []
      },
      {
        "pageId": "1745929438375",
        "rows": [
          [
            {
              "formObjectIds": [
                "1745932098287",
                "1745932154961"
              ],
              "colLG": 4
            },
            {
              "formObjectIds": [
                "1745932151176"
              ],
              "colLG": 4
            },
            {
              "formObjectIds": [
                "1745932109476"
              ],
              "colLG": 4
            }
          ],
          [
            {
              "formObjectIds": [
                "1745932105291",
                "1745932090395"
              ]
            }
          ]
        ]
      },
      {
        "pageId": "1745929352880",
        "rows": []
      }
    ]

Im Parameter pages werden die einzelnen Seiten des Formulars konfiguriert. Für jede Seite existiert ein Konfigurationsblock, der von geschweiften Klammern umschlossen ist.

Konfiguriert werden können:

Parameter

Beschreibung

groups

Definiert die Formulargruppen auf einer Seite. Sie können mehrere Gruppen konfigurieren. Jede Gruppe ist von geschweiften Klammern umschlossen.

formFields

Definiert die Formularfelder in einer Gruppe. Sie können mehrere Formularfelder konfigurieren. Jedes Formularfeld ist von geschweiften Klammern umschlossen. Den Formularfeldern können spezifische Parameter und Werte mitgegeben werden. Nachfolgend eine Auswahl:

  • description: Beschreibungstext zum Formularfeld. Dieser wird am Formularfeld angezeigt.

    Der Beschreibungstext kann bspw. ein Hinweis zu den vom Formularfeld erwarteten Eingaben sein.

  • hint: Hinweistext zum Formularfeld. Dieser kann etwas ausführlicher sein als der Beschreibungstext.

    Ist ein Hinweistext angegeben, so wird neben dem Formularfeld ein Fragezeichen-Icon angezeigt. Nach Klick auf das Icon wird der Hinweistext angezeigt.

  • label: Label, welches dem Formularfeld vorangestellt wird.

  • property: Referenzierendes Objekt (z. B. OrganisationID | DynamicFields | StateID)