General Client Configuration¶

The insight-mobile and -web applications can be configured with the Client Configuration. Example content:

config.json

{
    "name": "My Insight"
}

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/(mobile|web)/config.json

{
    "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/your-insight-path/insight/...

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

EAM types¶

Maximo¶

config.json

{
    "eamType": "maximo"
}

Open¶

config.json

{
    "eamType": "open"
}

Database, HxGN/Hexagon and SAP¶

config.json

{
    "eamType": "standalone"
}

General parameters¶

Parameter	Values	Default	Description
appParams	{ key: value, key2: value2 }	no default	Can be used in replacements: Working with variables/values
configTimeout	any positive number	30000	Timout to load all tree configurations in milliseconds
downloadUrl	`<server>/other/download`	`<server>/insight/download`	Divergent-"/insight/download"-Endpoints. Only needed if insight is not behind HTTP-Server.
eamType	`maximo`, `open`	`maximo`	The EAM-Type to connect to.
eamUrl	`<server>/other/eam`	`<server>/insight/eam`	Divergent-"/insight/eam"-Endpoints. Only needed if insight is not behind HTTP-Server.
eulaURL	URL or empty to hide	https://insight-control-panel.github.io/documentation/latest/license/	Full qualified URL to customers EULA
heartbeatTimeout	any positive number	5000	Heartbeat request timeout in milliseconds
heartbeatUrl	`<server>/heartbeat.txt`	`<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	URL or empty to hide	https://www.rodias.de/en/insight-control-panel/maintenance-portal/	Full qualified URL to customers privacy policy
legalNoticeURL	URL or empty to hide	https://rodias.de/impressum/	Full qualified URL to customers legal notice
maximoRestApp	`/maximo`	`/maxrest`	MAXIMO ONLY: If the "/maxrest"-Endpoint of Maximo can't be used.
name	any string	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	URL or empty to hide	https://insight-control-panel.github.io/documentation/v${MajorVersion}/privacy/	Full qualified URL to customers privacy policy
searchDelay	any positive number	100	Delay time in ms after which any search or filter action is triggered
searchServer	:9222/	`<server>/insight/search`	Divergent-Elasticsearch-Endpoint. Only needed if insight is not behind HTTP-Server
selectFromTreeEnabled	true or false	false	Activate manual inputs on all "selectFromTree"-attributes.
server	/other-insight-api	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	true or false	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

Mobile parameters¶

Parameter	Values	Default	Description
admin	true or false	false	Admins can login if someone else has unsynced, offline changes. There are also two buttons to reset the app on the login screen.
autoSync	true or false	true	Automatically upload and download of data records
barcode	{ key : value }	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	`[TC8000, MYDEVICE]`	no default	Use the barcode scanner hardware for specific device models.
barcodeIcon	Icon class string	no default	Overrides the default barcode icon.
barcodeOptions	{ key : value }	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	true or false	false	Offline changed records are shown at the end of the root list.
clientLogging	true or false	false	Tracks logs in the client. There is a new menu item for the logs.
clientLogSize	any positive number	100	Amount of queued client logs
disableBarcode	true or false	false	Hides all barcode icons
disableOffline	true or false	false	Hides the insight-mobile menu item "Offline"
disableOfflineSupport	true or false	false	Offline-data-records can be disabled. For example: insight-mobile in browser but without offline support.
disableSettings	true or false	false	Hides the insight-mobile menu item "Settings"
disableXRay	true or false	false	Hides the insight-mobile menu item "XRay"
downloadInterval	any positive number	15	Download interval in minutes. How often the data records are downloaded.
downloadOnOnline	true or false	false	Downloads data records when online. Normally used for "mostly-offlinedevices" (Dockingstation)
downloadValidateInterval	any positive number	1	Download validate interval in minutes. How often the client asks the server for new downloads/deltas.
enableNfc	true or false	false	Shows the nfc icon on the search field.
fingerprint	true or false	false	Enables iOS TouchId/FaceId authentication
footerButtons	true or false	false	Displays the save and cancel button in an always visible footer
heartbeatInterval	Heartbeat off: 0 or -1 Heartbeat on: any positive number	5	Heartbeat interval in seconds
heartbeatOnNetwork	true or false	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	true or false	false	Switch to the multi line behavior of the toolbar in mobile
listTextOverflow	ellipsis	no default
maxDocuments	any positive number	100	Max file download count per tree config.
navbar	`{size: 'small \\| big'}`	`{size:'small'}`	Changes the size of the navbar
newOfflineAtEnd	true or false	false	New offline created records are shown at the end of the root list.
offlineTimeout	any positive number	no timeout	Logout after interval of inactivity in minutes
pushnotification	true or false	false	Enables support of PushNotifications to the insight-mobile-app
showOfflineAnnotation	true or false	false	Shows the offline downloaded annotation on each record.
showUserInHeader	true or false	false	Shows the logged in user on the top of each page
startPage	any string	no default	Page to be shown after login. Examples: `upload`, `push`, `tree/workorderquickrep`

Web parameters¶

Parameter	Values	Default	Description
disableDefault	true or false	false	Suppresses the creation of a Start-Center tab when working with Maximo
disableExpertSearch	true or false	true	Removes the Expert-Search option in webclient
disableMaximoUi	true or false	false	Completly disable the integration of the Maximo User-Interface, sets disableDefaultTab=true when enabled
notificationWebsocketUrl	`<server>:8080/insightindexer/notification`	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	true or false	false	No login screen, the host application must trigger the login.
searchPattern	`startsWith`, `endsWith`, `contains`	no default	see here
toolbar.maxActions	positive number	5	amount of actions in a tree toolbar, search and sort included
websocketNotification	true or false	false	insight-web can be notified for data changes by websocket.