The iPhone app may be used to manage the Clients from an Apple mobile device, retrieving the status of the devices, checking the asset information and clearing (acknowledging) failed checks.
This section describes the four easy steps to download and configure the free iPhone App:
- Generate an API Key via the Dashboard - Settings, General Settings, Generate
- Enter the address to Email API Token to then Email Token. The email not only contains the API Key but also the required server details. The server location is also referenced here
- Download and install the app from the App Store
- Configure the app entering the API Key and Server address, for example using copy and paste from the API Key email.
Step 1. Generate an API Key
The iPhone App uses the Data Extraction API to retrieve data from the Dashboard.
In order to authenticate against the API, you must generate a unique API Key for your account (if you have not already done so).
Your unique API key can be generated from your Dashboard via:Settings, General, API Key
Once generated, it can then be emailed to any email address (ideally one that is accessible from your iPhone) so that you can copy and paste it into the app.
The API Key can only be generated by Superuser or Agent Key level logins.
Please note each Dashboard only has a single API Key for the account and that if this is regenerated any copies of the app using the old API Key will stop working until the new key is entered.
Step 2. Locate your API Server
The API server to authenticate against will vary depending on the territory the account is registered under. The URL is included in the API Key and can also be found here.
Your API Key is:
Your Server is:
Please note the server URL used for the API connection is not necessarily the same as the URL used to access the Dashboard.
Step 3. Download the app
The app is available free of charge from the App Store, simply download and install the app on the required Apple mobile device.
Step 4. Configure the app
When the app is first launched it will prompt for the API Key (this can be copy and pasted from the API Token email sent in Step 1) and the territory server (located in Step 2).
The app uses the same settings as the Wall Chart which determines the which failing checks will be included in the default Problems view as well as the frequency the data should be automatically refreshed.
Each app operates independently so its configuration may be altered without affecting the Wall Chart or other copies of the app.
Step 5. Manage Monitored devices from the iPhone
The app will now begin retrieving data for all of clients, sites and devices.
Depending on the current connection speed and the number of devices this may obviously take some time. As such if navigating to a device where the data is not yet available it will be fetched at that time, but there may be a slight delay as this loads. Any information retrieved from a device is cached so future navigation should be quicker.
The data for each device is refreshed according to the Autoreload setting (or manually using the refresh button where Autoreload / Enabled is Off) with the date and time of the last update is displayed at the top of each page, although it is necessary to scroll up to view this.
The default view for the app is Problems which, like the Wall Chart, shows all devices currently experiencing problems (in accordance with the configuration Step 4 above). From the Problems view it is possible to browse all of the servers or workstations at each client and Site using the appropriate tabs.
When viewing any server or workstation, all information available in the Dashboard for outages, checks, notes, automated tasks as well as hardware and software asset lists are accessible in the app.
It is also possible to clear failed checks as well as leave a Dashboard Note against the acknowledged check (where configured).
The ability to clear checks is enabled by default, but if this feature is not available in the app please ensure it is not disabled in the Dashboard in Settings, General Settings, Check Clearing.
To leave a Dashboard Technical and Client Facing Note when clearing the check from the app, ensure the option to Prompt for notes when clearing failed checks is enabled in the Notes section available from Settings, General Settings.