General¶
The insight-mobile and -web applications can be configured with the Client Configuration. Each application has its own file.
Insight-Web (Table entries with Web).
- In the folder of insight-web must be a file called: config.js
- Example content:
var Config = { "server": "/", "eamType": "maximo" }
Insight-Mobile (Table entries with Mobile).
-
For Browser:
- In the folder of insight-mobile must be a file called: config.js
- Example content:
var Config = { "server": "/", "eamType": "maximo" }
-
For Mobile-App:
-
The app must know which insight server has to be used. On first app start you have to configure the server URL. This server URL can be a valid insight Server or a configuration file. The app automatically checks for different paths on the server. Here are some examples:
- For all examples: Insight is installed on https://your-insightserver.com/insight/...
- Without config.json (all defaults) (Maximo)
- Server URL in app: https://your-insight-server.com/
-
Config at default location: https://your-insight-server.com/insight/mobile/config.json (We advise on this variant.)
- Server URL in app: https://your-insight-server.com/
-
config.json can be empty (Maximo)
{}
-
config.json (OpenJet)
{ "eamType": "open" }
-
Config at other location or filename different: https://your-insightserver.com/other-folder/prod.json
- Server URL in app: https://your-insight-server.com/other-folder/prod.json
- prod.json
(OpenJet)
{ "server": "https://your-insight-server.com/" "eamType": "open" }
-
Config at other location different server: https://your-insightserver.com/other-folder/prod.json
- Server URL in app: https://your-insight-server.com/other-folder/prod.json
- prod.json
(OpenJet)
{ "server": "https://your-insight-server-prod.com/" "eamType": "open" }
-
Config with multiple endpoints: https://your-insight-server.com/insight/mobile/config.json
- Server URL in app: https://your-insight-server.com/insight/mobile/config.json
- In the mobile can be switched between the endpoints.
- config.json
{ "endpoints": { "external":{ "label": "External", "server": "https://external-insightserver.com" }, "internal":{ "label": "Internal", "server": "https://internal-insightserver.com" } } }
-
The Config can be scanned via barcode. QR-Codes are suitable. There are two variants of barcode content:
- Only the server url: https://your-insight-server.com
- Initial, minimal Config (all of the following parameters from table are supported): {"clientConfigUrl":"https://your-insight-server.com"}
-
Parameters:¶
Parameter | Values | Standard | Description | Mobile | Web |
---|---|---|---|---|---|
server | config.js: "/" config.json: "https://example.com" |
config.js: "/" config.json: the host without 'insight/mobile/config.json' |
The server base URL to the Insight-Endpoints. Normally the host of the HTTP-Server. | + | + |
eamType | "maximo", open" | "maximo" | The EAM-Type to connect to. | + | + |
eamUrl | "https://example.com/other/eam" | <server>/insight/eam |
Divergent-"/insight/eam"-Endpoints. Only needed if insight is not behind HTTP-Server. | + | + |
downloadUrl | "https://example.com/other/download" | <server>/insight/download |
Divergent-"/insight/download"-Endpoints. Only needed if insight is not behind HTTP-Server. | + | + |
heartbeatUrl | "https://example.com/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 | + | + |
maximoRestApp | "/maximo" | "/maxrest" | MAXIMO ONLY: If the "/maxrest"-Endpoint of Maximo can't be used. | + | + |
autoSync | true, false | true | Automatically upload and download of data records | + | |
appParams | { "key": "value", "key2": "value2" } | no default | Can be used in replacements: Working with variables/values.md) | + | + |
disableofflinesupport | true, false | false | Offline-data-records can be disabled. For example: insight-mobile in browser but without offline support. | + | |
downloadInterval | any positive number | 15 | Download interval in minutes. How often the data records are downloaded. | + | |
downloadValidateInterval | any positive number | 1 | Download validate interval in minutes. How often the client asks the server for new downloads/deltas. | + | |
downloadOnOnline | true, false | false | Downloads data records when online. Normally used for "mostly-offlinedevices" (Dockingstation) | + | |
websocketNotification | true, false | false | insight-web can be notified for data changes by websocket. | + | |
portalMode | true, false | false | No login screen, the host application must trigger the login. | + | |
notificationWebsocketUrl | "https://example.com:8080/insightindexer/notification" | Not Maximo: <server>:8080/insightindexer/notification Maximo: |
Normally used if the HTTP-Server don't support WebSocket-Proxy. (IBM-HTTP-Server don't support WebSocket-Proxy) | + | |
searchServer | "https://example.com:9222/" | <server>/insight/search |
Divergent-Elasticsearch-Endpoint. Only needed if insight is not behind HTTP-Server | + | + |
disableSettings | true, false | false | Hides the insight-mobile menu item "Settings" | + | |
disableXRay | true, false | false | Hides the insight-mobile menu item "XRay" | + | |
pushnotification | true, false | false | Enables support of PushNotifications to the insight-mobile-app | + | |
offlineTimeout | 180 | no timeout | Logout after interval of inactivity in minutes | + | |
startPage | Examples: "upload" "push" "tree/workorderquickrep" |
no default | Page to be shown after login. | + | |
admin | true, 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. | + | |
heartbeatOnNetwork | true, 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. | + | |
heartbeatInterval | Heartbeat off: 0 or -1 Heartbeat on: any positive number |
5 | Heartbeat interval in seconds | + | |
clientLogging | true, 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 | + | |
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 | + | + |
disableOffline | true, false | false | Hides the insight-mobile menu item "Offline" | + | |
fingerprint | true, false | false | Enables iOS TouchId/FaceId authentication | + | |
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 | + | |
disableBarcode | true, false | false | Hides all barcode icons | + | |
maxDocuments | any positive number | 100 | Max file download count per tree config. | + | |
legacyToolbar | true, false | false | Switch to the multi line behavior of the toolbar in mobile | + | |
showUserInHeader | true, false | false | Shows the logged in user on the top of each page | + | |
heartbeatTimeout | any positive number | 5000 | Heartbeat request timeout in milliseconds | + | + |
searchPattern | "startsWith", "endsWith", "contains" | no default | see here | + | |
listTextOverflow | "ellipsis" | no default | + | ||
selectFromTreeEnabled | true, false | false | Activate manual inputs on all "selectFromTree"-attributes. | + | + |
navbar | {size: 'small'}, {size: 'big'} | {size:'small'} | Changes the size of the navbar | + | |
searchDelay | any positive number | 100 | Delay time in ms after which any search or filter action is triggered | + | + |
newOfflineAtEnd | true, false | false | New offline created records are shown at the end of the root list. | + | |
changedOfflineAtEnd | true, false | false | Offline changed records are shown at the end of the root list. | + | |
footerButtons | true, false | false | Displays the save and cancel button in an always visible footer | + | |
skipMaximoUiLogin | true, false | true | Reenable Maximo-Ui-Login, not needed with LDAP/appServerSecurity=1 authentication | ||
barcodeCameraDisabled | ["TC8000","MYDEVICE"] | no default | Use the barcode scanner hardware for specific device models. | + | |
configTimeout | any positive number | 30000 | Timout to load all tree configurations in milliseconds | + | + |
showOfflineAnnotation | true, false | false | Shows the offline downloaded annotation on each record. | + | |
disableDefault | true, false | false | Suppresses the creation of a Start-Center tab when working with Maximo | - | + |
disableMaximoUi | true, false | false | Completly disable the integration of the Maximo User-Interface, sets disableDefaultTab=true when enabled | + | |
enableNfc | true, false | false | Shows the nfc icon on the search field. | + | |
barcodeIcon | icon class string | no default | Overrides the default barcode icon. | + | |
disableExpertSearch | true, false | true | Removes the Expert-Search option in webclient | + | |
toolbar.maxActions | positive number | 5 | amount of actions in a tree toolbar, search and sort included | + | |
eulaURL | URL or empty to hide | https://insight-control-panel.github.io/documentation/v${MajorVersion}/license/ | Full qualified URL to customers EULA | + | + |
legalNoticeURL | URL or empty to hide | https://rodias.de/impressum/ | Full qualified URL to customers legal notice | + | + |
privacyPolicyURL | URL or empty to hide | https://insight-control-panel.github.io/documentation/v${MajorVersion}/privacy/ | Full qualified URL to customers privacy policy | + | + |
informationURL | URL or empty to hide | https://www.rodias.de/en/insight-control-panel/maintenance-portal/ | Full qualified URL to customers privacy policy | + | + |