Preferences Configuration


The BMC Helix FSM mobile client preferences can be controlled Directly on the client device or in the Preferences File (_preferences.xml) located in each Deployment Folder on the BMC Helix FSM Gateway Server. Any preferences set in the Preferences File will be automatically set on the client device after login. The Preferences File can be located in the BMC Helix FSM\Deployment\DEPLOYMENT_FOLDER_NAME directory (C:\Program Files (x86)\BMC Helix FSM\Deployment\DEPLOYMENT_FOLDER_NAME if the BMC Helix FSM solution was installed in it's default location). Your default _preferences.xml file will look like this with the DBServer value attribute populated with the Helix Server Address set during the installation:

1773323924273-176.png

Set Up Preferences File

The general format of an entry in the _permissions.xml file is as follows:

<pref section="Section Name" name="Preference Name" value="Preference Value"b locked="0 or 1"/>

Using the below chart, you can configure a variety of preference settings, and lock the preference so it cannot be changed.

Any Preference Name in bold is iOS only. All others work on iOS and Android.

Section NamePreference NamePreference ValueDescription
N/AMultiUser0 or 1Allows a user to logout of Mobile Reach on their client device. 
N/ANoMultiNetworks0 or 1
  • ON (0) - Allows multiple Network connections to be defined; Additional Network Tabs will display on the Preferences Screen, if applicable
  • OFF (1)- All Mobile Apps (.cxml) will use the settings defined on the Network tab.
N/ASecure0 or 1Forces all Apps that run against the Gateway to operate in secure mode. This mode causes a lock screen to appear after a timeout when an App is idle. The user must enter their password to unlock the screen. 
N/ASecureCache0 or 1Forces all Apps that run against the Gateway to operate in secure cache mode. This mode forces the App to use Private encryption. The username and password are not part of the encryption key, so the cached database cannot be used by different users. A new user must delete the database with clear cache and recreate the database. 
N/A NetworkWaitintegerAdd a delay to the initial login period. This delay can be useful if a VPN has a long connection time. 
N/A CrashEmailvalid email addressChange email crash files send to. Default is our support email
N/A LogEmailvalid email address Change email log files send to. Default is our support email
N/A LicenseNoAutoRefresh0 or 1Turns off the auto-refresh functionality. 
N/A LicenseShowWarning0 or 1 Causes the device to display a message warning that a floating license is about to expire if an operation that triggers a license check is performed within a configured period. 
N/A LicenseWarningTimeinteger Used with LicenseShowWarning to change the period when a message warning that the license is about to expire displays on the client device. 
N/A LogoutDetails0 or 1 Displays all licenses that were released during logout. 
N/A LogoutSaveCredentials0 or 1Keeps the username and password stored on the device during logout. If set, floating licenses are released during logout, but the login window and App Manager can be bypassed. 
N/A Reauthenticateinteger Require all users to re-authenticate their passwords after a configured number of days 
N/ALocationRequired0 or 1Forces all deployed Mobile Apps (.cxml) to have Location Services activated in the Settings on the Client-Device or the End-User will be kicked out of the Mobile App
0 - Not Required
,strong>1 - Prevents the app from running if the current location is unknown
N/ALocationRequiredAge3600 seconds (1 hour - Default)How recent the location value must be, in seconds, to operate the Mobile App (.cxml)
Frequency of location updates varies per device, Devices with GPS typically get updates more often than devices only on WiFi
Value may need to be adjusted per client-device
General Autocorrect 0 or 1 Turns the Device Auto-Correct Text Functionality ON or OFF for all mobile apps (.cxml)
General  Cleanup 0 or 1 
  • ON - Automatically clears cache when a new version of a mobile app (.cxml) is downloaded to the Client Device via App Manager
  • OFF - Does not clear cache when a new version of the mobile app (.cxml) is downloaded to the Client Device via App Manager
General  CommLog  0 or 1 Turns logging ON or OFF; Used to Send Log Reports via Email 
General  HideClearCacheIcon  0 or 1 
  • The user cannot Clear Cache for All Mobile Apps, only Individual Apps
  • OFF - Shows the Clear Cache Icon
General  LauncherType  Table, Coverflow, or Grid  Determines the Display Format of the Mobile Reach Home Screen
General  Rotation  Any, Portrait, or LandscapeDetermines the Mobile Device Screen Rotation capabilities on the Mobile Reach Client 
General  UseScriptNetwork  0 or 1 Enables Multiple Networks. 
NetworkDBServer  stringSource System Server Name or URL; Add Port Number if applicable (i.e. server.domainname.com: Port#) 
NetworkMRTServer  string Gateway Server Name or IP Address; Defaults to the Gateway Entered on the Login Screen or within the Preferences File (_preferences.xml) 
NetworkTimeout  integer How long (in seconds) the MR Client will wait before timing out when communicating to the Source System 
NetworkUsername string End-User Username 
NetworkPasswordstringEnd-User Password 
AutoUpdate AutoBGOnly  0 or 1Causes auto data sync to occur only if the Apps are in the background. 
AutoUpdate  AutoFetch 0 or 1 Enables auto data sync using the device background fetch functionality. 
AutoUpdate  AutoNoForeground  0 or 1 Prevents auto data sync from occurring for the active App. 
AutoUpdate  AutoPush  0 or 1 Causes auto data sync to occur when a push message is received. 
AutoUpdate  AutoTimer  0 or 1 Enables the foreground timer. 
AutoUpdate  AutoTimerIntervalintegerAutoTimerInterval 
AutoUpdate  AutoLocation0 or 1Update on location change
AutoUpdate  AutoLocationTime1 Minute, 5 Minutes, 10 Minutes, 15 Minutes, 30 Minutes, 60 MinutesMinimum time for update on location change
AutoUpdate AutoLocationDistance100 feet, 500 feet, 1/4 mile, 1/2 mile, 1 mile, 2 miles, 5 milesMinimum distance for update on location change
CameraModeAlways Available, Never Available, App Controlled Determines when the device camera can be used for scanning. 
Linea Enable 0 or 1 Enables the scanner. 
Linea  AlwaysOn 0 or 1 Keeps the scanner in an On state. 
Linea  Sound 0 or 1 Causes the scanner to play a sound when a scan is performed. 
SocketMobile Enable 0 or 1 Enables the scanner. 
PointMobileEnable0 or 1Enables the scanner.
EMDK Enable 0 or 1 Enables the scanner. 
Scanndy Enable 0 or 1 Enables the scanner. 
Scanndy Language UTF-8Converts scanned values to the UTF-8 language. 
Scanndy NullToSpace 0 or 1 Converts scanned null values to spaces. 
Scanndy Timeout integer The amount of time, in seconds, that the RFID scanner will attempt to read a value. 
Scanndy UseReadLen integer Enables all read values to be scanned. 
ScanndyUseSComp 0 or 1 Enables the communication protocol for the Panmobil SmartScanndy scanner. 
Tsl Enable 0 or 1 Enables the scanner. 
Tsl MaxSize integerThe maximum number of bytes in the user data that can be read. 

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Helix Field Service Management 26.2