Collect Configuration Options

<< Click to Display Table of Contents >>

Navigation:  Collect > Installation and Administration >

Collect Configuration Options

Administrators can configure options for Collect by using settings in the ST_CONFIG table.

 

Time Zone Handling for Pre-population

 

Collect assumes that pre-populated date/times in data forms are in the server's time zone (often using UTC), and will convert date/times to and from the local time zone used in Collect Mobile. To turn off this behavior and not have Collect perform conversion of date/times, administrators can add a setting to the ST_CONFIG table.

 

Note: This option also impacts data forms used in the Web Forms widget.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

EQuIS_Collect

Required


CONFIG_KEY

TimeZoneHandling

Required


OBJECT_TYPE


null


OBJECT_VALUE


null


STRING_VALUE

True

False

Default is True

Choose one

 

When the option is present and False, Collect will not do any time zone conversion of date/times. When the option is True or absent, Collect will handle date/time values as designed (i.e., converting date times to and from local time zone).

 

When the value of this ST_CONFIG setting changes, Collect Mobile needs to be restarted to detect the change and the Web Forms widget needs to have the web browser refreshed (not the widget, but the web browser).

 

 

Disable Basic User Authentication

 

User authentication is with an EQuIS username and password (i.e., basic user authentication), using Microsoft Entra ID, or using OpenID Connect. If an administrator wants all EQuIS users to use only Microsoft Entra ID or OpenID user authentication rather than EQuIS credentials, basic authentication can be disabled. When this setting is applied in the ST_CONFIG table, the Collect Mobile Login Screen will be modified such that the Password field only allows users to enter a PIN (not a standard password) and the Login button text updates to "Login with PIN".

 

Warning: Either Microsoft Entra ID or OpenID for user authentication must be appropriately configured and enabled for all users prior to disabling basic user authentication or users will not be able to login to the Enterprise site.

 

Notes:

If Basic User Authentication is disabled and the user previously had Remember my Credentials set, the user will not automatically login and will be forced to login again through Microsoft Entra ID or OpenID user authentication.

If Basic User Authentication is disabled, users will still be able to login with a PIN, however, once the user is online, they will be logged out and forced to login again through Microsoft Entra ID or OpenID user authentication.

 

Disable basic user authentication by adding a row to the ST_CONFIG table as follows:

ST_CONFIG

VALUE

REMARK

CONFIG_SECTION

EQuIS_Collect

Required

CONFIG_KEY

App_Setting

Required

OBJECT_TYPE

DisableBasicAuthentication

null

OBJECT_VALUE


null

STRING_VALUE

True|False

True = Cannot login via Basic User Authentication

False = Can login via Basic User Authentication

 

 

Mobile Upgrade Version

 

Administrators can require EQuIS Collect Mobile users to upgrade to at least some minimum version from the relevant app store by setting a configuration option in the ST_CONFIG table. This option may be useful when multiple contractors, vendors, or other third parties are pushing data to EQuIS and can ensure that desired Collect features or options are being used.

 

When the following record is added to the ST_CONFIG table, any Collect user with a Mobile app version lower than the record value will be required to upgrade to push data to EQuIS. Users will be alerted to upgrade and cannot connect to the server to pull/push data until they have upgraded, however, they can continue to capture data on the current version.

 

The Mobile version number can be located on the Mobile app login screen.

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

EQuIS_Collect

Required


CONFIG_KEY

MIN_VERSION

Required


OBJECT_TYPE


null


OBJECT_VALUE


null


STRING_VALUE

<string>

Minimum Mobile version number (e.g., 7.21.14106)

Any valid Collect Mobile version number