FAQ


How to customize the OTA Alert Message

— —

How to customize the OTA Alert Message Article ID: 17281
Date: 21 January 2005
Updated: 14 July 2005

Title: How to customize the OTA Alert Message

Fact: Following is information on how to customize the OTA Alert Message. This information is also located in the GoodLink Administrators Guide Chapter 6 "Managing the Handhelds" section "Customizing the OTA Setup Email Message".

You can edit the template for the OTA email message that is sent to users. This message informs them that wireless GoodLink software updates are available, together with the PIN they will use when downloading the software and the URL of the download site.

The OTA email template is an XML file that is installed by GMS in the following location:

C:\Program Files\Good Technology\GoodLink Management Server\etc\confs\otap_useremail_template.xml

This filepath is stored in a string value 'AirSetupEmailTemplateFile' on the GoodLink Management Server
machine under the following registry key:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\GoodLinkManagement\parameters

If this registry key is not present, GMS defaults to:

C:\Program Files\Good Technology\GoodLink Management Server\etc\confs\otap_useremail_template.xml

The following shows the skeleton of the otap_useremail_template.xml file:

<?xml version="1.0" encoding="utf-8"?>
<template>

<templateattributes type="text">
</templateattributes>
<subject>

Welcome to GoodLink

</subject>
<body><![CDATA[

Your handheld has been activated for GoodLink. With GoodLink, you can wirelessly stay up to date with all of Microsoft Outlook - email, contacts, calendar, tasks, and notes!

Login Information
--------------------------
Email Address: ##PR_GOOD_MAIL_SMTP##
PIN: ##PR_GOOD_OTA_PROV_PWD##

……………..

1) Use the browser on your handheld to download Air Setup from

##GoodLinkStubUrlRoot##.

]]></body>

</template>

The text between <subject> and </subject> is the email subject. The text between <body><![CDATA[ and ]]></body> forms the email body. All the information in these sections is text and does not have any formatting. The property enclosed in double ## is substituted by GoodLink Management Server when the email message is ready to be sent out.

The following properties are currently supported:

##PR_GOOD_MAIL_SMTP## - User's SMTP email address
##PR_GOOD_OTA_PROV_PWD## - Users PIN formatted in a readable form
##GoodLinkStubUrlRoot## - The website URL from which OTA Setup files can be downloaded. This defaults to https://get.good.com

These properties can appear any number of times anywhere in the subject or email body.

Steps to customize the Email template

Follow these steps on the GoodLink Management Server machine:

1. Create a directory outside C:\Program Files\Good Technology (for example, C:\GoodLinkCustom). Do this because during a GoodLink Management Server upgrade/uninstall, your customization file will be overwritten by the GoodLink Management Server installer.

2. Copy the C:\Program Files\Good Technology\GoodLink Management Server\etc\confs\otap_useremail_template.xml file to C:\GoodLinkCustom.

3. Use a text editor such as Notepad and load C:\GoodLinkCustom\ otap_useremail_template.xml.

4. Customize the text between the XML tags <subject> and </subject>, and between <body><![CDATA[ and ]]></body>

5. Save the file in Notepad and exit Notepad.

6. Verify the XML syntax by loading the file into Internet Explorer (File->Open->Browse and open the C:\GoodLinkCustom\otap_useremail_template.xml file.) If there are any syntax errors, correct them. Otherwise exit from Internet Explorer.

7. Run REGEDIT and go to the following reg key:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\GoodLinkManagement\parameters

If the 'AirSetupEmailTemplateFile' key is present, update its value to C:\GoodLinkCustom\otap_useremail_template.xml. If this registry key is not present, create a string key and assign the value.

8. Restart the 'GoodLink Management Server' Service.

9. Create a dummy OTA user and check the email to verify everything is OK.

Note: If you uninstall GoodLink Management Server and reinstall it, perform steps 7-9. If you upgrade GoodLink Management Server, no action is required.