Predefined session variables

Introduction

Each application template has a set of predefined session variables. These variables are visible during the form design stage. The form designer cannot edit or delete these variables. The purpose of these variables is to carry basic information collected while the end user fills out the form. This data is automatically populated by the application displaying the form and saved in the repository.

List of system variables

Below the system variables and their purpose are listed:

• _abandonTime - form abandonment time

• _channel - the channel through which the user fills out the form (web, mobile)

• _channel_Description - channel description (desktop: web, mobile: mobile, native app: APP_Mobile)

• _currentPageId - currently displayed page number

• _currentPageMid - mid of the displayed page

• _cvc - parameter displaying the form in a different view, allows placing fields additionally next to the form

• _domain - domain of the running form (host name only, e.g. form.consdata.com)

• _finishTime - time the user submitted the form

• _finishTimeAfterPayment - time the user submitted the form after payment

• _formId - form name

• _formInstanceNumber - form number

• _ip - user's IP address

• _operatingSystem - name of the operating system (according to the documentation https://github.com/lancedikson/bowser/blob/1.7.3/README.md - for GWT a simplified OS detection mechanism is used)

• _paymentResult - variable that indicates whether the payment was successful (used for payment handling functionality provided by external services)

• _startTime - time the user started filling out the form

• _userAgent - name of the client application

• _visitedPages - sequence of visited pages

• ___userEmail___ - value of the email address field of the user specified in the contact section on the form properties page

• _externalFormContextId - external identifier of the form context (case identifier)

• _businessFormIdentifier - identifier displayed on the form view, by default the form number

• _SESSIONKEY - session identifier

• _browserName - name of the web browser

• _cmisObjectId - stores the identifier that allows retrieving the form

• _internalAuthenticationMethod - authentication method used in the given activity

• _internalAuthenticationPhoneNumber - phone number to which the SMS was sent / Phone number with the authentication application (OTP-SMS, OTP-PRINTED, MOBILE-APPLICATION)

• _seller - identifier of the seller directing to the form in the mobile application