Symptoms

The Parallels Operations Automation (POA) Control Panel provides customers with instructions on accessing their Exchange mailboxes using different access types - Outlook, ActiveSync, IMAP4, POP3.

See the screenshot below:

Clicking the appropriate 'View setup info' link, the customer gets instructions on how to connect to their Hosted Exchange mailbox using one of the available protocols.

A Provider would like to modify or add additional information to the mailbox setup info pages for Hosted Exchange mailboxes that are shown in the POA Customer Control Panel.

Resolution

The pages with instructions are part of the standard POA locale files and can be customized for each locale separately. You can find details in the POA Provider's Localization Guide, under the 'Customizing Language Pack Files' section. These particular pages are defined in the Exchange.xml locale file.

Follow the steps below to provide custom mailbox setup instructions in POA CCP:

  • Log into the POA Provider Control Panel
  • Go to System Director > Configuration Manager > Internationalization & Localization
  • Click on the desired locale
  • Switch to the Source Locale Files tab
  • Download the Exchange.xml file
  • Find the keyword for the page you would like to customize. For example, for POP3 setup, the keyword will be 'POP3.INFO.HTML', for IMAP4 - 'IMAP4.INFO.HTML' and so on. If you have trouble finding the appropriate keyword, search the XML file for the text you see in the mailbox setup info page.
  • Copy the entry for the keyword you would like to customize and prepare a new XML file called 'Exchange.xml'. Your custom file should preserve the structure of the original localization file and only contain the entries you would like to customize.

Please Note: It is important to only apply customizations to the entries you want to customize, leaving all other items unchanged. If you leave all items in your customized 'Exchange.xml' file, all improvements and bugfixes which come with future POA versions will be overwritten by your customization.

  • Note the name of the 'section' XML tag in which the entry you would like to customize appears, and create an XML file containing the 'entry' tag enclosed in the appropriate 'data', 'name', 'section' and 'locale' tags (as in the stock Exchange.xml file shipped with POA).
  • Modify the 'phrase' part of the desired keyword as you wish, making sure that all data you add is XML-escaped.
  • Upload customized locate file to POA at System Director > Configuration Manager > Internationalization & Localization > select locale > Customized Locale Files tab, click 'Add'.

For example, to make the Parallels logo appear on top of the setup info for IMAP4 in the US English locale:

Prepare the HTML code to be added:

<img src = "http://sp.parallels.com/typo3conf/ext/parallels_template/i/parrallels-logo.png" />

XML-escape it, so it looks like this:

&lt;img src = &quot;http://sp.parallels.com/typo3conf/ext/parallels_template/i/parrallels-logo.png&quot; /&gt;

Insert the HTML code into the prepared custom Exchange.xml file, which would look like this:

<locale code="en_US">
<section>
<name>Exchange-PanelBundle.properties</name>
<data>
        <entry>
                <keyword>IMAP4.INFO.HTML</keyword>
                <phrase>&lt;html&gt; &lt;head&gt; &lt;link href=&quot;/common/css/plan.css&quot; rel=&quot;stylesheet&quot; type=&quot;text/css&quot;/&gt; &lt;/head&gt; &lt;body&gt; &lt;img src = &quot;http://sp.parallels.com/typo3conf/ext/parallels_template/i/parrallels-logo.png&quot; /&gt; ...(remainder of the phrase omitted to keep the example short)</phrase>
        </entry>
</data>
</section>
</locale>

In the POA Provider Control Panel, go to System Director > Configuration Manager > Internationalization & Localization > select English (United States) (en_US) locale > open 'Customized Locale Files' tab > click 'Add' and upload the custom Exchange.xml file:

Then, open any Exchange subscription being logged into under the US English locale, choose a mailbox and click the 'View setup info' link next to IMAP4. The Parallels logo now appears at the top of the page:

Internal content