formData

(FintechOS Studio 20.1.1 and later)

Object that allows you to interact with the currently opened form.

The formData object has a variety of methods and properties that: provide access to the current record's attributes, refresh the current form, return the name of the form's source entity or the ID of the form's HTML element, etc.

Method/Property	Description
formData.entityName	Returns the name of the form's source entity.
formData.id	Returns the ID of the record currently displayed on the form.
formData.model	Provides read/write access to the values of the form fields of the current record's attributes.
formData.view.model	Provides read/write access to the properties of the form fields of the current record's attributes.
formData.name	Returns the ID of the form's HTML element.
formData.mainHtmlId	Returns the ID of the main user interface's HTML element.
formData.template	Returns the main user interface's HTML code template.
formData.mode	Returns the mode of the current form (insert or edit).
formData.pageNo	Indicates the last step in the form where data was saved.
formData.formScope	Object shared between different JavaScript attributes of an entity form, used for storing variables and functions.
formData.setAdditionalValue	Defines an object that can be accessed in subsequent form steps.
formData.setSaveEndpoint	Overrides the default save mechanism of the form and replaces it with a call to a given endpoint.
formData.getAdditionalValue	Reads an object that was defined in a preceding form step using formData.setAdditionalValue.
formData.getAdditionalValues	Reads all objects that were defined in preceding form steps using formData.setAdditionalValue.
formData.grids	Returns details about the views displayed on the form.
formData.hasChanges	Indicates if the form has unsaved changes.
formData.refreshForm	Refreshes the current form.
formData.refreshBusinessStatus	Refreshes the current record's business status.
formData.on	Registers handlers for the default app logic events of a form driven flow.
formData.registerEvent	Defines a custom event and event handler.
formData.registeredEvents	Lists all custom events.
formData.notify	Triggers a custom event.
formData.userJourney.goNext()	Advances the user journey to the next step.
formData.saveAsync	Saves the currently displayed form or form driven flow.

Availability

Entity	Attributes
Entity form	Before events, after events.
Entity form section	After events.
Entity form section (wizard mode)	Before section save, After section save.
Entity form field	Attribute change event.