General Client Configuration¶
The mobile and web applications can be configured with the Client Configuration in config.json.
Place the config.json either parallel to the client/config/ (is used with an insight-store and staticContent, among other things).
Recommendation
We recommend maintaining and uploading config.json with insight-cli (insight upload client-config, or as part of insight upload all). It uploads client-config/config.json together with the static content in one step, no manual file placement or zipping required. Uploading config.json manually is still supported, see below.
Default installation (recommended)¶
If no further settings are needed, only the eamType needs to be set, not even the server.
Insight API-URL : https://your-insightserver.com/insight/...
https://your-insightserver.com/insight/
{
"eamType": "maximo"
}
Insight Mobile app server: https://your-insightserver.com
Multiple installations on one server¶
If there are multiple installations on one server, we recommend the following way.
Insight API-URL : https://your-insightserver.com/prod/insight/...
https://your-insightserver.com/prod/insight/(mobile|web)/confg.json
{
"eamType": "maximo"
}
Insight Mobile app server: https://your-insightserver.com/prod
Different installation (not recommended)¶
The server setting must be set on the path before /insight/.
Insight API-URL: https://your-insightserver.com/
https://your-insightserver.com/other-folder/prod.json
{
"eamType": "maximo",
"server": "https://your-insightserver.com/your-insight-path"
}
Insight Mobile app server: https://your-insightserver.com/other-folder/prod.json
General parameters¶
appParams¶
Values: { key: value, key2: value2 } · Default: no default
Can be used in replacements: Working with variables/values
configTimeout¶
Values: any positive number · Default: 30000
Timout to load all tree configurations in milliseconds
downloadUrl¶
Values: <server>/other/download · Default: <server>/insight/download
Divergent-"/insight/download"-Endpoints. Only needed if insight is not behind HTTP-Server.
eamType¶
Values: maximo, open, standalone · Default: maximo
The EAM-Type to connect to. Use standalone for all other than maximo and open.
eamUrl¶
Values: <server>/other/eam · Default: <server>/insight/eam
Divergent-"/insight/eam"-Endpoints. Only needed if insight is not behind HTTP-Server.
eulaURL¶
Values: URL or empty to hide · Default: https://insight-control-panel.github.io/documentation/latest/license/
Full qualified URL to customers EULA
heartbeatTimeout¶
Values: any positive number · Default: 5000
Heartbeat request timeout in milliseconds
heartbeatUrl¶
Values: <server>/heartbeat.txt · Default: <server>/insight/user/data
Divergent-Heartbeat-Endpoint. Only needed if insight is not behind HTTP-Server or you dont want a heartbeat to the EAM-Backend
informationURL¶
Values: URL or empty to hide · Default: https://www.rodias.de/en/insight-control-panel/maintenance-portal/
Full qualified URL to customers privacy policy
legalNoticeURL¶
Values: URL or empty to hide · Default: https://rodias.de/impressum/
Full qualified URL to customers legal notice
maximoRestApp¶
Values: /maximo · Default: /maxrest
MAXIMO ONLY: If the "/maxrest"-Endpoint of Maximo can't be used.
name¶
Values: any string · Default: no default
For Example: server-, system-, or projectname. Will be visible on: information popup; mobile server config header; mobile menu header; mobile login header
privacyPolicyURL¶
Values: URL or empty to hide · Default: https://insight-control-panel.github.io/documentation/v<MajorVersion>/privacy/
Full qualified URL to customers privacy policy
searchDelay¶
Values: any positive number · Default: 100
Delay time in ms after which any search or filter action is triggered
searchServer¶
Values: <server>:9222/ · Default: <server>/insight/search
Divergent-Elasticsearch-Endpoint. Only needed if insight is not behind HTTP-Server
selectFromTreeEnabled¶
Values: true or false · Default: false
Activate manual inputs on all "selectFromTree"-attributes.
server¶
Values: <server>/other-insight-api · Default: the host without insight/(mobile|web)/config.json
It is not recommended to change the default URL. The server base URL to the Insight-Endpoints. Normally the host of the HTTP-Server. Only needs to be set if the standard URL is not used. <server>/insight/(mobile|web)/config.json
skipMaximoUiLogin¶
Values: true or false · Default: true
Reenable Maximo-Ui-Login, not needed with LDAP/appServerSecurity=1 authentication. If switched to false make sure to also set mxe.webclient.allowUrlLogin as 1 in Maximo 7.6.1+. See details here
staticContent¶
Values: object · Default: no default
For static files and customize styling. See staticContent
thirdPartyURL¶
Values: URL or empty to hide · Default: https://insight-control-panel.github.io/documentation/<version>/8_third-party-components/client/client-mobile/
Full qualified URL to customers third party libs
maximoIsoAuth¶
Values: true or false · Default: false
If true, the credentials will be ISO-8859-1 encoded. Default is the encoding with UTF-8
hideSectionBorder¶
Values: true or false · Default: false
If true, all sections are packed into one card and the section borders disappear. Can also be set in a use case on tree level
labelNoWrap¶
Values: true or false · Default: false
If true, all attribute labels are not wrapped and the text is replaced with ellipsis
platform¶
Values: android, ios, electron, browser · Default: no default
Allows you to customize or override root configuration values in config.json for a specific platform, depending on the device or environment. See Platform Specific Configurations
Mobile parameters¶
admin¶
Values: true or false · Default: false
Admins can login if someone else has unsynced, offline changes. The data of the previously logged in user will be deleted. There are also two buttons to reset the app on the login screen.
autoSync¶
Values: true or false · Default: true
Automatically upload and download of data records
barcode¶
Values: { key : value } · Default: default depends on device
Configuration for the barcode scanner. Works on all platforms. All parameter can be define in general in config.json. See barcode config
barcodeCameraDisabled¶
Values: ["TC8000", "MYDEVICE"] · Default: no default
Use the barcode scanner hardware for specific device models.
barcodeIcon¶
Values: Icon class string · Default: no default
Overrides the default barcode icon.
barcodeOptions¶
Values: { key : value } · Default: no default
Configuration for the native app barcode scanner plugin (Android, iOS). All parameters are given to the plugin. See: https://github.com/phonegap/phonegap-pluginbarcodescanner
changedOfflineAtEnd¶
Values: true or false · Default: false
Offline changed records are shown at the end of the root list.
clientLogging¶
Values: true or false · Default: false
Tracks logs in the client. There is a new menu item for the logs.
clientLogSize¶
Values: any positive number · Default: 100
Amount of queued client logs
disableBarcode¶
Values: true or false · Default: false
Hides all barcode icons
disableOffline¶
Values: true or false · Default: false
Hides the insight-mobile menu item "Offline"
disableOfflineSupport¶
Values: true or false · Default: false
Offline-data-records can be disabled. For example: insight-mobile in browser but without offline support.
disableSettings¶
Values: true or false · Default: false
Hides the insight-mobile menu item "Settings"
disableXRay¶
Values: true or false · Default: false
Hides the insight-mobile menu item "XRay"
downloadInterval¶
Values: any positive number · Default: 15
Download interval in minutes. How often the data records are downloaded.
downloadOnOnline¶
Values: true or false · Default: false
Downloads data records when online. Normally used for "mostly-offlinedevices" (Dockingstation)
downloadValidateInterval¶
Values: any positive number · Default: 15
Download validate interval in minutes. How often the client asks the server for new downloads/deltas.
downloadCompletedCheckInterval¶
Values: any positive number · Default: 30
When a download is started, the Insight Client periodically asks the server whether the download is already complete. Interval in seconds
enableNfc¶
Values: true or false · Default: false
Shows the nfc icon on the search field.
fingerprint¶
Values: true or false · Default: false
Enables iOS TouchId/FaceId authentication
footerButtons¶
Values: true or false · Default: false
Displays the save and cancel button in an always visible footer
heartbeatInterval¶
Values: Heartbeat off: 0 or -1, Heartbeat on: any positive number · Default: 5
Heartbeat interval in seconds
heartbeatOnNetwork¶
Values: true or false · Default: 5
Heartbeat is only executed when the client has network. The online and offline events are used by the browser, which do not work so reliably on all platforms and are therefore not used as a standard.
legacyToolbar¶
Values: true or false · Default: false
Switch to the multi line behavior of the toolbar in mobile
listTextOverflow¶
Values: ellipsis · Default: no default
maxDocuments¶
Values: any positive number · Default: 100
Max file download count per tree config.
navbar¶
Values: {size: 'small | big'} · Default: {size:'small'}
Changes the size of the navbar
newOfflineAtEnd¶
Values: true or false · Default: false
New offline created records are shown at the end of the root list.
offlineTimeout¶
Values: any positive number · Default: no timeout
Logout after interval of inactivity in minutes
pushnotification¶
Values: true or false · Default: false
Enables support of PushNotifications to the insight-mobile-app
showOfflineAnnotation¶
Values: true or false · Default: false
Shows the offline downloaded annotation on each record.
showUserInHeader¶
Values: true or false · Default: false
Shows the logged in user on the top of each page
startPage¶
Values: any string · Default: no default
Page to be shown after login. Examples: upload, push, tree/workorderquickrep
recordBulkSize¶
Values: any positive number · Default: no default
Split the bulk record requests into chunks. This setting can avoid timeouts if the data fetches are too slow.
Web parameters¶
disableDefault¶
Values: true or false · Default: false
Suppresses the creation of a Start-Center tab when working with Maximo
disableExpertSearch¶
Values: true or false · Default: true
Removes the Expert-Search option in webclient
disableMaximoUi¶
Values: true or false · Default: false
Completly disable the integration of the Maximo User-Interface, sets disableDefaultTab=true when enabled
notificationWebsocketUrl¶
Values: <server>:8080/insightindexer/notification
Default:
- Not Maximo:
<server>:8080/insightindexer/notification - Maximo:
<server>:8080/insight-indexer/notification
Normally used if the HTTP-Server don't support WebSocket-Proxy. (IBM-HTTP-Server don't support WebSocket-Proxy)
portalMode¶
Values: true or false · Default: false
No login screen, the host application must trigger the login.
searchPattern¶
Values: startsWith, endsWith, contains · Default: no default
see here
toolbar.maxActions¶
Values: positive number · Default: 5
amount of actions in a tree toolbar, search and sort included
websocketNotification¶
Values: true or false · Default: false
insight-web can be notified for data changes by websocket.