Interface XfcMetadata

Dieses Objekt enthält alle Metadaten des aktuell geöffneten Formulars.

Um über JavaScript Informationen zum Formular, zum aktuell angemeldeten Benutzer und des dazugehörigen Vorgangs sowie vielen weiteren Informationen zu erhalten, steht das globale JavaScript-Objekt window.XFC_METADATA zur Verfügung. Dieses wird beim Aufruf eines Formulars mit den aktuellen Daten automatisch befüllt.

Hierarchy

  • XfcMetadata

Index

Properties

Properties

attachments

attachments: MetadataAttachment[]

Eine Liste mit allen hochgeladenen Dateien, die am Vorgang angehängt sind.

Hierbei stehen nur solche Dateien zur Verfügung, die über ein Upload-Formularfeld im Formular hochgeladen wurden; jedoch nicht Dateien, welche im Postfach angehängt wurden. Diese Liste ist leer, wenn das Formular noch nie abgesendet wurde.

currentClient

currentClient: MetadataClient

Der Mandant, zu dem das aktuelle Formular gehört.

currentLanguage

currentLanguage: string

Kurzname der aktuellen Sprache, z.B. default, en oder de.

currentLanguageTag

currentLanguageTag: string

Die aktuelle Sprache und Variante, z.B. default, en-US oder de-DE.

currentProcess

currentProcess: MetadataProcess

Der aktuelle Vorgang. Ein leeres Objekt, wenn es keinen Vorgang gibt, also das Formular neu geöffnet und noch nicht abgesendet wurde.

currentProject

currentProject: MetadataProject

Information zum aktuellen Formular, wie etwa seine ID oder sein Name.

currentSessionFRID

currentSessionFRID: string

Die ID der aktuellen Formularsitzung (form request session ID), zum Beispiel 88b4069a-b489-454d-9c1c-350ab4a2e83d. Eine neue Formularsitzung wird erzeugt, wenn der Nutzer ein Formular öffnet und ist gültig, bis dieser das Formular absendet oder speicher. Der Nutzer kann mehrer Formularsitzungen gleichzeitig besitzen, etwa wenn verschiedene Formulare geöffnet werden oder wenn ein Formular mehrfach in verschiedenen Tabs geöffnet wird. Die Formularsitzung ist einerseits ein Sicherheitsmerkmal und verhindet zudem auch mehrfaches Absenden, falls ein Nutzer die Absendeschaltfläche zweimal betätigt.

currentSessionID

currentSessionID: string

Die aktuelle J2EE application container Situngs-ID (JSESSIONID), zum Beispiel 5151BE9E69A42FE78D98580E24B3F23B. Wenn ein Nutzer mehrere Tabs mit Formularen im Browser geöffnet hat, haben alle die gleiche Sitzungs-ID. Siehe currentSessionFRID für eine ID, die für jedes geöffnete Formular unterschiedlich ist.

currentUser

currentUser: MetadataCurrentUser

Der derzeitig angemeldete Nuzter. Falls kein Nutzer angemeldet ist, referenziert dieses Objekt auf einen anonymen Nutzer. Etwa ist dann der currentUser.surename auf [Anonymous] gesetzt.

deprecated

Diese Eigenschaft ist veraltet, es sollte stattdessen XFC_METADATA.user verwendet werden.

preferred

user

pluginResults

pluginResults: object

Die Rückgabewerte von Pre-Render-Plugins. Ein Pre-Render-Plugin wird ausgeführt, bevor das Formular erstellt wird. Jedes Plugin kann Werte hinterlegen, die in diesem Objekt zur Verfügung stehen. Etwa kann es sich dabei um die Antwort eines Web-Services handeln.

Dieses Objekt enthält alle Rückgabewerte der Pre-Render-Plugins, wobei der Schlüssel der Name des Plugin ist.

Type declaration

  • [pluginName: string]: any

renderStatus

renderStatus: string

Der Status, der benutzt wurde, um das Formular zu erzeugen (rendern). Wenn ein Formular bereits abgeschickt wurde, wird ein Vorgang angelegt, der auch immer einen Status hat. Es kann vorkommen, dass der Status des Vorgang ein andere ist als der Status, der zum Erzeugen des Formulars benutzt wurde. Beispielsweise ist es im Designer möglich, sich eine Vorschau des Formulars anzeigen zu lassen. Dabei kann auch der Status ausgewählt werden, in dem die Formularvorschau angezeigt wird. Je nach ausgewähltem Status hat diese Eigenschaft einen anderen Wert. Da es sich aber um eine Vorschau handelt, gibt es noch keinen Vorgang, sodass XFC_METADATA.currentProcess.status keinen Wert hat.

requestType

requestType: FormRequestType

Mögliche Werte für die Request-Typen in Formularen. Sie geben an, wie ein Formular aufgerufen wurde. Einige dieser Werte sind nur für die interne Verwendung bestimmt und sollten nicht verwendet werden.

  • provide: Initiales Öffnen eines Formulars. Es gibt noch keinen Vorgang zum Formular.
  • preview: Vorschau des Formulars, also wenn das Formular im Vorschaumodus des Designers geöffnet wird.
  • print: Drucken des Formulars. Das Formular wird durch den Server geöffnet, um etwa ein PDF-Dokument oder ein Bild zu erzeugen.
  • process: Verarbeitung des Formulars. Ist gesetzt, wenn das Formular abgesendet wird.
  • review: Wiederanzeige des Formulars im Posteingang. Es gibt nun einen Vorgang zum Formular.

serverTime

serverTime: Date

Die aktuelle Zeit des Servers. Kann statt new Date() benutzt werden, um ein Datum unabhängig des Browsers oder Betriebssystems zu erhalten.

urlParams

urlParams: object

Ein Objekt mit allen URL-Parametern der aktuellen Seite.

Type declaration

  • [urlParamKey: string]: string

urls

urls: MetadataUrls

Eine Objekt mit allen URLs, die auf FORMCYCLE-spezifische Ressourcen verweisen, wie etwa Datenbankabfragen oder Plugin-Servlets. Es sollten immer diese URLs verwendet werden, und keine URLs fest im Code hinterlegt werden. So wird sichergestellt, dass der Code auch weiterhin funktioniert, wenn sich die URL zum FORMCYCLE-System ändert.

user

user: MetadataUser

Der aktuell angemeldete Nuzter. Falls kein Nutzer angemeldet ist, referenziert dieses Objekt auf einen anonymen Nutzer. Etwa ist dann der user.firstName auf [Anonymous] gesetzt.