Module Formcycle

Index

Modules

Interfaces

Type aliases

Type aliases

FormRequestType

FormRequestType: "provide" | "preview" | "process" | "print" | "review" | "publish" | "workflow" | "image" | "form" | "reviewplain" | "copy" | "forward" | "alias" | "aliascopy" | "verify"

Possible request types for forms that indicate how the form was opened. To access the request type of the currently opened form, use XFC_METADATA.requestType zugegriffen. Some of these options are only for internal use and should not be used.

  • provide: When the form was opened for the first time and not submitted yet. No form records exists yet for the form.
  • preview: Preview of a form, ie. when you open the form in the preview mode of the designer.
  • print: When the form was opened by the server to generate a printed document, such as a PDF document or an image.
  • process: Processing a form. This is set when the form is submitted.
  • review: When the form is opened in the inbox. A form record now exists for the form.

FormUrlType

FormUrlType: "attachment" | "context" | "dataquery_db" | "dataquery_ldap" | "datasource_csv" | "datasource_db" | "datasource_json" | "datasource_xml" | "keepalive" | "plugin" | "previewAction" | "submitAction"

Possible values for the different types of URLs of formcycle. The following are currently available:

  • attachment: Base URL for accessing attachments uploaded via upload elements.
  • context: The current context path of the web application, eg. /formcycle.
  • dataquery_db: Base URL for accessing database queries as configured in the formcycle backend.
  • dataquery_ldap: Base URL for accessing LDAP queries as configured in the formcycle backend.
  • datasource_csv: Base URL for accessing CSV data sources as configured in the formcycle backend.
  • datasource_db: (deprecated) Use dataquery_db instead.
  • datasource_json: Base URL for accessing JSON data sources as configured in the formcycle backend.
  • datasource_xml: Base URL for accessing XML data sources as configured in the formcycle backend.
  • keepalive: URL for keeping the current session alive. Similar to a ping.
  • plugin: URL for executing servlet plugins.
  • previewAction: URL for requesting a preview of a form. A preview cannot be submitted.
  • submitAction: URL to which the form data is submitted.

FormVruleType

FormVruleType: "posinteger" | "plzDE" | "posmoney" | "integer" | "url" | "posmoneyOptionalComma" | "number" | "money" | "ipv4" | "phone" | "onlyLetterNumber" | "time" | "onlyLetterSp" | "email" | "dateDE" | "text" | "regexp"

Default or predefined data types for input fields. The following are currently available:

  • dateDE: Allows only German-style dates (DD.MM.YYYY), e.g. 22.05.1990.
  • email: Allows only valid (international) email addresses, e.g. james@john.org or θσερ@εχαμπλε.ψομ.
  • integer: Allows only integers, that is numbers without a decimal point, e.g. 3, 0, or -21.
  • ipv4: Allows only IP4 addresses, e.g. 127.0.0.1 or 10.42.42.13.
  • money: Requires the input to be a valid amount of money, i.e. a number with exactly two decimal digits, e.g. 2,00, -3,95, 0,00 or 897345,38.
  • number: Allows only numbers, including numbers with a decimal point, e.g. 0.03, -99.2, or 42.
  • onlyLetterNumber: Allows only letters, numbers, and spaces.
  • onlyLetterSp: Allows only letters and spaces.
  • phone: Allows only valid phone numbers, e.g. 0234995483 or +49 351 4459654.
  • plzDE: Allows only postal code from Germany, i.e. exactly 5 digits, e.g. 02349. Does not check whether such a code is actually registered within Germany.
  • posinteger: Allows only positive integers, e.g. 0, 3, oder 123.
  • posmoney : Requires the input to be a valid amount of money, not including negative numbers, e.g. 0,00 or 2,34.
  • posmoneyOptionalComma: Requires the input to be a valid positive amount of money, with the decimal digits being optional, e.g. 0,00, 0, 3,4, or 3.
  • regexp: Allows the user who creates the form to enter a custom (JavaScript flavor) regular expression for validation.
  • text: Applies no restriction and allows every input.
  • time: Requires the input to be a valid time, in the format hh:mm, e.g. 22:05 or 03:42.
  • url: Allows only URLs, including the protocol, e.g. http://example.com or https://www.james.org.

Json

Json: null | boolean | number | string | JsonArray | JsonObject

Represents all data types that are valid JSON.

JsonArray

JsonArray: Json[]

Represents all arrays that are valid JSON arrays..

JsonObject

JsonObject: object

Represents all objects that are valid JSON objects.

Type declaration

  • [key: string]: Json

LegacyFileStore

LegacyFileStore: Partial<Record<string, LegacyFileStoreItem>>

Legacy model for the file store with all binary files from upload elements. The key is the ID of the form element, e.g. xi-tf-1.

deprecated

Legacy, will be replaced with a better model.

LegacyFormField

LegacyFormField: Partial<Record<string, string | number | false | true | number[] | LegacyFormFieldSaveData>>

Legacy model with saved data of form field and the meta data of the form field.

The key can be one of the following

  • The consecutive repetition index, starting at 0, prefixed with an underscore, e.g. _0 or _1. Then the value is the corresponding value of the form field, which could be a string, an array, an object etc., depending on the type of form element.
  • One of the properties from LegacyFormFieldMeta.
deprecated

Legacy, will be replaced with a better model.

LegacyFormFieldSaveData

LegacyFormFieldSaveData: SingleOrArrayLike<undefined | string | number | Record<string, unknown>>

Possible types for the saved data of a form field

deprecated

Legacy, will be replaced with a better model.

LegacyFormSaveData

LegacyFormSaveData: Partial<Record<string, object | LegacyFormField | string[]>>

Legacy model that represents the data entered into a form, including values from repeated form fields as well as images.

The key can be any of the following:

  • The name of a repeated form field with the prefix _dyn_size, e.g. tf1_dyn_size. Then the value is an array with the repetition IDs, e.g. ["0", "1", "2"].
  • The ID of the form field, e.g. xi-tf-1. The the value is an object with the meta data and values for each form field.
  • One of the properties from {@link ILegacyFormSaveDataBase}.
deprecated

Legacy, will be replaced with a better model.

SingleOrArrayLike

SingleOrArrayLike: T | ArrayLike<T>

Represents a single value or an array of such values.