For organizations utilizing Mobile Device Management software such as MobileIron® or AirWatch® TTerm for iPad supports AppConfig configuration deployment. This allows administrators to configure TTerm for iPad options through their MDM interface and push them out to devices under management. This approach is well suited to deploying configurations to very large numbers of devices.
This article configuration support available to Mobile Device Management (MDM) users.
There are several options for managing configuration deployment and sharing within TTerm for iPad. For information on other management and deployment options please refer to this knowledgebase article.
This article refers to features available in versions 1.4.1 and above.
Check your version number by selecting About TTerm from the App menu.
What is AppConfig?
AppConfig is a set of vendor neutral standards for enabling App configuration and management through device management software. TTerm for iPad specifically supports pushing configuration options to devices under management, eliminating the need for ends users to be involved in first time setup or subsequent configuration updates.
TTerm for iPad can be configured via any number of conforming products in the marketplace today, for the purposes of illustrating the process in this article we've used VMWare's AirWatch® MDM software. Procedures will differ depending on the MDM software you are using. Please consult your product documentation for further detail.
Overview
The TTerm for iPad range of apps are capable of emulating up to 80 different terminals and multiple communications protocols. Given the sheer number of configuration options required to accurately emulate the original manufacturer terminals it is not feasible or desirable to enter a large volume of individual configuration details directly into your MDM application.
Instead the process of configuring TTerm for iPad involves an administrator installing a single copy to a device and configuring a 'master template' within the App itself. Once the administrator is happy these settings are exported to a file which is placed on an accessible webserver (either on an intranet or public site).
MDM software is then configured to relay this download URL along with several other relevant configuration options to installed TTerm for iPad apps on end user devices under management.
TTerm for iPad will then download and install the configuration, replacing any existing configuration settings.
To summarize:
- An Administrator configures TTerm for iPad on a single device.
- This 'master template' configuration is exported from the device as an .attexp file.
- This file is place on an accessible webserver.
- AppConfig settings are added to an MDM, specifying the webserver download URL.
- The MDM pushes out configuration settings to end user TTerm for iPad installations, which then download and install the .attexp configuration file.
Configuring the 'Master Template' Configuration
Firstly, install a single copy of TTerm for iPad to a device. You will then need to configure the app with the settings you wish to deploy to a group or groups within your organization.
The settings that can be configured for deployment to other devices are the connection configurations themselves and Access Settings.
For information on Access Settings refer to this article on Restricting User Access in TTerm for iPad.
For an overview on configuring TTerm for iPad to connect to a host read the introductory article Three Simple Steps to Connect in TTerm for iPad.
Once you have configured and tested your connection(s) you'll need to export the settings to a file. To do so, follow these steps:
- On the Settings screen tap Export Settings and Saved Connections. This will export the Access Settings and all the connection items listed on the Connections screen.
- TTerm for iPad will now place a copy of these settings in file called export.attexp on your iPad. Please be aware that any SSH key credentials stored in a saved connection will also be exported.
- To retrieve the file connect your iPad to a computer.
- In Finder select your device and open the Apps tab.
- Scroll down to File Sharing.
- Select TTerm from the list of Apps.
- Browse to your saved connection file and click the Save to... button. The file name is export.attexp. Your configuration file is now saved to your computer.
Deploying the Configuration
If required, rename export.attexp and then place the file on a webserver where it may be downloaded by TTerm for iPad. You may wish to confirm the download URL is accessible through a regular web browser.
You'll now need to enter a couple of details into your MDM so that deployed installations of TTerm for iPad can retrieve the .attexp file.
The screenshots below are specific to VMWare's AirWatch® MDM.
Other MDM software will have a different set of configuration options.
In AirWatch you can find these settings located where you have added TTerm for iPad to your app catalog. Navigate to Apps and Books > TTerm and click the Assign button.
You'll then need to add or edit an Assignment Group. In the Assignment settings scroll down and enable the Application Configuration option.
At this point you'll need to enter several key-value pairs which define the configuration options. An .xml file is provided to predefine the fields and can be downloaded from the link at the end of this article.
Once this file is uploaded to AirWatch your display should be similar to that shown above. The fields are as follows:
- Auto Import URL: https://www.site.com/file.attexp
An accessible URL where the .attexp file (TTerm for iPad configuration file) can be downloaded. Both plain http and https protocols are valid. You may need to configure your webserver MIME type for .attexp files to file/download. - Enable Auto URL Import : true
A Boolean. This needs to be set to true to initiate a download. - Notify User on Update : true
A Boolean. This setting only applies to scenarios where a set of configuration settings are being updated (replaced), not the initial import. If set to true TTerm will notify the user that their configurations have been remotely altered.
To send the configuration to an installed instance of TTerm for iPad among your managed devices select the detail view of TTerm for iPad, click the more button to the right of screen and select the Send Application Configuration option.
Initial Configuration
Once an application configuration is sent TTerm will apply the settings if open or when next run. The process is transparent to the end user.
Updating a Configuration
From time to time you may wish to update your end users configuration. It is important to note that TTerm for iPad will not re-download the same .attexp file twice. You will need to provide a new .attexp file with a unique Enable Auto URL Import to perform a configuration update.
Additionally, TTerm for iPad will not apply the update if there are any currently open host connections. TTerm for iPad will wait until the user has disconnected from a host system before downloading and applying the new configuration settings.
When an update is applied, any existing connection configurations will be deleted. For this reason you may wish to consider setting the Notify User on Update setting to true. This will display a popover message informing the end user that their configurations have been remotely modified.
Troubleshooting and Error Messages
'URL Import Failed.'
This error may appear when attempting to download an .attexp file. Confirm that
you have entered the Auto Import URL details correctly and that the
webserver hosting the file is accessible. Note that URLs must include the http: or https://
prefix.
Additional error text may provide a clue as to the exact nature of the issue.
'A remote configuration updated failed because the import file is invalid.'
The supplied .attexp file is corrupt or otherwise invalid. Try re-exporting from TTerm for iPad.
Where to Get Further Help
If you require assistance with configuration please get in touch with Turbosoft's support team by logging an issue at www.ttwin.com/support_form or directly through the TTerm for iPad App ( About > Contact Support ).
Please note that we cannot provide support for products not produced by Turbosoft Pty Ltd. If you require assistance with a third party product such as MDM software, please contact that developer directly.