[go: up one dir, main page]

0% found this document useful (0 votes)
44 views16 pages

Classifier Mail Add-In Installation Guide

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
44 views16 pages

Classifier Mail Add-In Installation Guide

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 16

Classifier Mail Add-in

3.13.2
Installation Guide
Copyright Terms and Conditions

Copyright © Fortra, LLC and its group of companies. All trademarks and registered trademarks are the property of their respective
owners.
The content in this document is protected by the Copyright Laws of the United States of America and other countries worldwide. The
unauthorized use and/or duplication of this material without express and written permission from Fortra is strictly prohibited. Excerpts
and links may be used, provided that full and clear credit is given to Fortra with appropriate and specific direction to the original
content.
202310181216
Table of Contents
About Fortra's Boldon James Classifier Mail Add-In 4

About this guide 4

Architecture 5

Prerequisites 6

Classifier Mail Add-in Website 6

Classifier Mail Add-in Manifest 7

Website deployment steps 8

Manifest file deployment steps 10

Enable Mail Add-In On Send 10

Add website information to manifest file 10

Installation steps 11

Uninstall steps 12

Uninstall the Website 12

Uninstall the Manifest File 12

Further Information 13

Modifications to Labelling Policies 13

Exchange Web Services 13

Disable the web Mail Add-in on desktop 13

Limitations 14

Contacting Fortra 16

Installation Guide www.fortra.com page: 3


About Fortra's Boldon James Classifier Mail Add-In / About this guide

About Fortra's Boldon James


Classifier Mail Add-In
Fortra's Boldon James Classifier Mail Add-In extends Classifier functionality to users in
Exchange Server and Exchange Online (Microsoft 365) environments.

See Architecture on page 5 for an overview of this product.

About this guide


This document outlines installation and post-installation steps for the Classifier Mail Add-in.

See the Classifier Administration Server User Guide for additional steps, including installing
the license file and creating a Classifer configuration.

Installation Guide www.fortra.com page: 4


Architecture /

Architecture
The Classifier Mail Add-in is comprised of the following:

l A manifest that is applied to the Exchange Server or Exchange Online instance and is
replicated across available servers and is configured inline with the underlying server
infrastructure. The manifest file provides the OWA extensions and user interface.
l An IIS-hosted RESTful web service installed through the installer package. This loads
the Classifier configuration and is responsible for Classifier-specific processing.
NOTE: Multiple servers running the Classifier Mail Add-in website can be used
behind load balancing technology. This is a recommended configuration but is not
required. These multiple servers must be running the same Classifier
configuration and policy.

The following shows the flow of data for the Classifier Mail Add-In for OWA.
NOTE: You must be able to connect to Classifier Mail Add-in website, and the site
must have read access to the Classifier configuration (which is published using
Classifier Administration). For more information on the Classifier Administration,
see the Classifier Administration Server User Guide.

Installation Guide www.fortra.com page: 5


Prerequisites / Classifier Mail Add-in Website

Prerequisites
Classifier Mail Add-in Website
Requirement Description
Operating Windows Server 2016 (64-bit)
System
Windows Server 2019 (64-bit)
Hardware for 4 Core, 2 GHz processor
Classifier Mail
Add-in Server 8 GB RAM

10 GB storage (minimum)
.NET The following prerequisites must be installed on your Windows Server:
Framework
l .NET Framework 4.7.2
Web Server l .NET Framework feature ASP.NET 4.5
(IIS) roles
l Web Server (IIS) role configured with the following additional
features: Static Content, HTTP Errors, Static Compression,
Dynamic Compression, IIS Management Console

Run the following command in PowerShell to install these prerequisites:

Install-WindowsFeature NET-Framework-Core, NET-


Framework-45-Core, NET-Framework-45-ASPNET, Web-
Static-Content, Web-Http-Errors, Web-Stat-
Compression, Web-Dyn-Compression, Web-Mgmt-Console -
restart

Installation Guide www.fortra.com page: 6


Prerequisites / Classifier Mail Add-in Manifest

Requirement Description
IIS Website The IIS website to be used for the Classifier Mail Add-in website must
have the following prerequisites:

l Dedicated 64-bit IIS website configured with an https binding


using an SSL certificate.
l The SSL certificate needs to be trusted by the browsers which
will be used to access Outlook Web App and Office Online.
l The website needs to be accessible from the browsers which will
be used to access Outlook Web App and Office Online.

IMPORTANT: We recommend that the Classifier Mail Add-in website


does not share an IIS website or Application Pool with any other
product, and that a dedicated 64-bit IIS website is created for this
product before installation.

When the product is installed an IIS Application Pool called


"Classifier Mail and Office Add-in Website Application Pool" is
created. This IIS Application Pool uses the identity "Network
Service." This Application Pool identity must have Read
permissions from the location where the Classifier label
configuration is published, and Write permissions to the Event Log
to allow the creation of audit and diagnostic information.

Classifier Mail Add-in Manifest


Requirement Description
Exchange Exchange Server 2016 (Cumulative Update 20 or later)
Server
Exchange Server 2019 (Cumulative Update 6 or later)
Exchange
Online Exchange Online in Microsoft 365
Classifier Mail You must install and configure your Classifier Mail Add-in website
Add-in Website before installing the manifest file. See Website deployment steps on
page 8 for instructions.

IMPORTANT: If you upgrade the website, the corresponding manifest


file must also be upgraded.

Installation Guide www.fortra.com page: 7


Website deployment steps /

Website deployment steps


IMPORTANT: Ensure Classifier Mail Add-in website and manifest versions are aligned.
When upgrading the website, the corresponding manifest file must also be upgraded.

Before you begin, see Prerequisites on page 6.

To install the website:

1. From the Classifier Mail Add-in Website folder, run Setup.exe.


2. Select the dedicated IIS website created for the Classifier Mail Add-in website.

After finishing the website installation, configure the registry keys for the Classifier Label
Configuration. See the Classifier Administration Server User Guide for more information.

Proxy Server Support


The following registry values can be used if a proxy server will be used to access Exchange
Server or Exchange Online (Microsoft 365):

l HKEY_LOCAL_MACHINE\SOFTWARE\Boldon James\OWA Classifier


Service\UseProxyServer
l HKEY_LOCAL_MACHINE\SOFTWARE\Boldon James\OWA Classifier
Service\UseProxyServerAuthentication
l HKEY_LOCAL_MACHINE\SOFTWARE\Boldon James\OWA Classifier
Service\ProxyServerURL

UseProxyServer is a DWord registry value. A value data of 1 enables proxy server support. If
the registry value is not present or has value data other than 1 then proxy server support is
not enabled.

UseProxyServerAuthentication is a DWord registry value. A value data of 1 enables proxy


server authentication. If the registry value is not present or has value data other than 1 then
proxy server authentication is not enabled. The IIS Application Pool "Classifier Mail and
Office Add-in Website Application Pool" identity is used for the proxy server authentication.

ProxyServerURL is a String registry value. The value data is the URL for the proxy server to
use.
Example: https://proxy.server:8080/

Installation Guide www.fortra.com page: 8


Website deployment steps /

These registry values are not created by the installer. By default, the configuration does not
use a proxy server.

Closed Network Support


The following registry value can be used if a closed network will be used to access Exchange
Server and clients have no external internet access:

HKEY_LOCAL_MACHINE\SOFTWARE\Boldon James\OWA Classifier


Service\ClosedNetwork

ClosedNetwork is a DWord registry value. A value data of 1 enables closed network support.
If the registry value is not present or has value data other than 1 then closed network support
is not enabled.

Installation Guide www.fortra.com page: 9


Manifest file deployment steps / Enable Mail Add-In On Send

Manifest file deployment steps


IMPORTANT: Ensure Classifier Mail Add-in website and manifest versions are aligned.
When upgrading the website, the corresponding manifest file must also be upgraded.

Before you begin, see Prerequisites on page 6.

Enable Mail Add-In On Send


By default, the Mail Add-ins On Send functionality is disabled for all users. The Mail Add-ins
On Send functionality must be enabled for all Classifier Mail Add-in users for the Classifier
Mail Add-in to operate correctly.

The Mail Add-ins On Send functionality is enabled by applying an OWA Mailbox Policy which
has the On Send functionality enabled to all Classifier Mail Add-in users. OWA Mailbox
Policies are configured using Exchange Server or Exchange Online PowerShell cmdlets.

Use the Set-OWAMailboxPolicy PowerShell cmdlet to set the OnSendAddinsEnabled


property to $true on all OWA Mailbox Policies which are or will be applied to Classifier Mail
Add-in users.

All Classifier Mail Add-in users must have an OWA Mailbox Policy assigned to them which
has the OnSendAddinsEnabled property set to $true. The Set-CASMailbox PowerShell
cmdlet can be used to apply an OWA Mailbox Policy to users using the OwaMailboxPolicy
property.

NOTE: Itcan take several hours or days for changes to OWA Mailbox Polices to be
applied to users.

Add website information to manifest file


You must edit the supplied ClassifierMail.xml manifest file to include the name of the website.

1. From the Classifier Mail Add-In Manifest folder, open the ClassifierMail.xml file.
2. Replace all "REPLACE_WITH_YOUR_SERVERNAME" references with the
hostname, and optionally the port number, from the authority part of the URL for your
website.

Installation Guide www.fortra.com page: 10


Manifest file deployment steps / Installation steps

For example, if your website has the URL "https://myserver.mydomain.com/" then the
replacement value for "REPLACE_WITH_YOUR_SERVERNAME" would be
"myserver.mydomain.com".

A requirement for a Mail Add-in is that the website it references must use a SSL secured
https connection. To support this:

l The website must be configured to use a https binding.


l The manifest file must use https URLs for the website.

Installation steps
You can install the edited ClassifierMail.xml file manifest file that points to your website on
the Exchange Server or Exchange Online. Reference Microsoft documentation for
installation steps and more information about the different options for deploying add-ins.

After you are done, Classifier appears in your list of add-ins.

Enable Portion Marking


By default, portion marking is disabled within the add-in manifest. To enable this, uncomment
the following section of the manifest file by removing the “<!- -“ and “- ->”:

<!--StartSetPortionMarking-->

(Remove These Lines) <!--

<Control xsi:type="Button" id="msgComposePortionMarkingButton">

…………….

</Control>

(Remove these lines) -->

<!--EndSetPortionMarking-->

Installation Guide www.fortra.com page: 11


Uninstall steps / Uninstall the Website

Uninstall steps
Uninstall the Website
Go to Control Panel > Programs and Features to uninstall the Boldon James Classifier Mail
and Office Add-in Website.

Uninstall the Manifest File


Reference Microsoft documentation for steps on removing the Classifier add-in from your
Exchange Server or Exchange Online environment.

Installation Guide www.fortra.com page: 12


Further Information / Modifications to Labelling Policies

Further Information
Modifications to Labelling Policies
Changes to labelling policy do not take effect until after a restart or recycle of the IIS website
where Classifier Mail Add-in website is installed or the "Classifier Mail and Office Add-in
Website" IIS Application Pool. This is done through Internet Information Services Manager or
on the command line through the Microsoft provided tool.

Per user label configuration policies are not supported. One label configuration policy applies
per machine with the Classifier Mail Add-in website installed.

Exchange Web Services


The Classifier Mail Add-in website uses Exchange Web Services (EWS) to obtain the
information required for the Classifier Mail Add-in to process messages. The Classifier Mail
Add-in website uses a EWS URL obtained from the Mail Add-in. The Classifier Mail Add-in
website requires access to this EWS URL. On Exchange systems, this EWS URL needs to
use a https connection with a fully trusted SSL certificate.

Microsoft has different limits on EWS response sizes for different environments. The
following registry value can be used to exclude the message body from Classifier Mail Add-in
requests that may result in responses that exceed these limits when processing large emails:

HKEY_LOCAL_MACHINE\SOFTWARE\Boldon James\OWA Classifier


Service\ExcludeBodyInEWSRequests.

ExcludeBodyInEWSRequests is a DWord registry value. A value data of 1 excludes the


message body in EWS requests. If the registry value is not present or has value data other
than 1, the message body will be retrieved from EWS requests.

If you use this registry key, configuration labels cannot be parsed from the message body. If
Label Propagation is required on replies and forwards, there must be a suitable property on
the message or a label location outside the body.

Disable the web Mail Add-in on desktop


When running the Boldon James Email and Office Classifier COM add-in on desktop, you
may want to disable the web Mail Add-in to prevent confusion. Reference these Microsoft
instructions: Make your Office Add-in compatible with an existing COM add-in.

Installation Guide www.fortra.com page: 13


Further Information / Limitations

The following Id's will be required:

l Mail Add-in Id: 979B9530-E85F-4199-B083-4AB91236010B


l COM Add-in ProgId: BoldonJames.SAFEoffice.Addin.Connect

Limitations
The following limitations apply:

l Classifier Mail Add-in is not available in Basic Mode in Outlook Web App. Outlook
Web App Basic Mode does not support Mail Add-ins.
l Classifier Mail Add-in does not support offline mode in Outlook Web App.
l Classifier Mail Add-in only supports messages. Other item types, including meetings
and appointments, are not supported.
l Attached MSG and EML message files types cannot be classified using Classifier Mail
Add-in.
l Classifier Mail Add-in does not support Shared mailboxes.
l Classifier Mail Add-in does not support Group mailboxes.
l All clients accessing the Classifier Mail Add-in require an Internet connection to
access the Microsoft "appsforoffice" Content Delivery Network.
l "Check for label change" rules are only supported when forwarding or replying to
message items.
l "Check for additional recipients on reply or forward" not supported.
l "Check clearance for recipients" rules only support SMTP domain clearances.
l "Check for expired selectors" rules are not supported.
l "Add these addresses" rules are not supported.
l "Apply S/MIME security to the message" rules are not supported.
l "Apply a delivery report request" rules are not supported.
l "Apply a read receipt request" rules are not supported.
l "Apply this importance value" rules are not supported.
l "Apply this sensitivity value" rules are not supported.
l "Apply this expiry value" rules are not supported.
l Classifier visual markings are applied when messages are sent. If the message send
is stopped by subsequent processing or user actions after the Classifier Mail Add-in
has updated the visual markings, then the visual markings are not removed from the
message.

Installation Guide www.fortra.com page: 14


Further Information / Limitations

l Mail Add-ins cannot expand distribution lists. This has been raised to Microsoft as
issue 937 for OfficeDev office-js. It is recommended that the Classifier Application
Setting "Always use distribution list clearances" is set to Enabled for Outlook Web
Access while this Microsoft issue has not been fixed.
l Mail Add-ins running within the Office 365 environment cannot prepend portion
marking to selected ranges and will overwrite selection. See issue 1178 for OfficeDev.
l Inserting a portion marking when the message body is not in focus may cause
previously selected text to be overwritten.
l Selector value tooltips are not supported for "Single selection list" or "Date offset list"
selectors when configured to display as list.
l Selectors configured to display values as a list do not support displaying colours or
images.
l Marking format setting 'Use Plain text style' is not supported.

Installation Guide www.fortra.com page: 15


Contacting Fortra /

Contacting Fortra
Please contact Fortra for questions or to receive information about Classifier Mail Add-in.
You can contact us to receive technical bulletins, updates, program fixes, and other
information via electronic mail, Internet, or fax.

For additional resources, or to contact Technical Support, visit boldonjames.com/technical-


support, or contact Boldon James at support.boldonjames@fortra.com.

For support issues, please provide the following:

l Check this guide's table of contents and index for information that addresses your
concern.
l Gather and organize as much information as possible about the problem including
job/error logs, screen shots or anything else to document the issue.

Installation Guide www.fortra.com page: 16

You might also like