Installing Outlook Add-In with ContentStore and Edge Attachment Store

Deprecated

Outlook Add-In with ContentStore and Edge Attachment Store is deprecated.

For comprehensive information about deprecated features, see End-of-Life, Deprecated and Extended Support for Features.

The Outlook Add-In with ContentStore and Edge Attachment Store is a combined package that includes the Add-in for archived emails, ContentStore Email Viewer, and the Edge Attachment Store feature. When you install the Outlook Add-In package, end users can access their archived and content indexed emails and the attachments on new email messages are automatically uploaded to the ObjectStore that you configured for Outlook Add-In. After the upload, the Add-In removes the attached file physically from the email message and inserts links to view or download the file from the ObjectStore.

Before You Begin

Install the Outlook Add-In on the end-user computer that has Microsoft Outlook 2010 or later installed.

If you have Microsoft Outlook 2007 SP2 installed and you want to install the add-In, follow the instructions in the following KB articles:
- A 2007 Office system application does not load an Add-In that is developed by using VSTO
- Description of the 2007 Office system hot fix package
To upload email attachments to an ObjectStore, make sure you have the Outlook Add-In ObjectStore configured in your CommCell group. For more information, see Configuring the Outlook Add-In for Edge Attachment Store.

Also, make sure that the end user is a member of the external user group associated with the Outlook Add-In ObjectStore client.
The following are installed on the end-user computer when the executable file is used to install Outlook Add-In:
- Visual Studio Tools for Office
  - x86 Version
  - x64 Version
- .NET Framework 4.5

Procedure

Download the Outlook Add-In with ContentStore and Attachment Store admin package.

The admin package is used to create the Add-In installation package for end users. The admin package is also available on the Cloud Services website home page.
Install the Outlook Add-In package using one of the following methods:
- Method 1: Run OutlookAddinCSandEdge.exe package
  
  Use this procedure to install Outlook Add-in Edge Attachment store on your client.
- Method 2: Log On Script through Active Directory
  
  Use this procedure to mass deploy Outlook Add-in to end users.
- Method 3: Host the Installation File on an Internal Network
  
  Use this procedure to allow users to download the installation file from a local network.

Method 1: Run OutlookAddinCSandEdge.exe

Use this procedure to install Outlook Add-in Edge Attachment store on your client.

Create the Add-In installation package for end users.
1. After downloading the admin package, go to the download location and double-click OutlookAddinCSandEdgeAdmin.exe.
2. At the command prompt, type the output location where you want to create the Add-In installation package and press Enter.
3. Type the host name of the Web Console used for the ObjectStore and press Enter.
  
  For example, if the Web Console name is drive.company.com, by default, the Web Console URL will be http://drive.company.com. To use secure access, provide https://drive.company.com as the Web Console name.
4. Specify the file size in KB for the email attachment.
  
  For example:
  
  If you specify 5KB in the command line for Minimum File Size in KB, then the emails with the attachment size less than 5KB are not uploaded in the Edge drive and you cannot see the links for the attachments in Outlook .
  
  Emails with attachment size greater than 5KB are uploaded in the Edge drive and you can see links for the attachments in Outlook.
  
  The OutlookAddinCSandEdge.exe package is created in the specified folder location.
Navigate to the location where the package was created, and then double click on the OutlookAddinCSandEdge.exe to install the Outlook Add-in with Contentstore and Edge attachment store package

If you have your Outlook open, then it will be closed during the installation.

Method 2: Log On Script through Active Directory

Use this procedure to mass deploy Outlook Add-in to end users.

Create the Add-In installation package for end users.
1. After downloading the admin package, go to the download location and double-click OutlookAddinCSandEdgeAdmin.exe.
2. At the command prompt, type the output location where you want to create the Add-In installation package and press Enter.
3. Type the host name of the Web Console used for the ObjectStore and press Enter.
4. Specify the file size in KB for the email attachment.
  
  For example, if you specify 5KB in the command line for Minimum File Size in KB, then the emails with the attachment size less than 5KB are not uploaded in the Edge drive and you cannot see the links for the attachments in Outlook .
  
  Emails with attachment size greater than 5KB are uploaded in the Edge drive and you can see links for the attachments in Outlook
  
  The OutlookAddinCSandEdge package is created in the specified output location.
Log on to the Active Directory Server using an account with Domain Administrator privileges.
Navigate to Start > Administrative Tools > Group Policy Management.
Right-click the container to which you want to link the Group Policy Object (GPO) and select Create a GPO in this domain, and Link it here.
Create a new GPO for installing your MSI package.
Enter a descriptive name, and then click OK.
Right-click the new GPO and select Edit.
Navigate to User Configuration > Policies > Windows Settings > Scripts (Logon/Logoff).
In the right-pane, right-click Logon, and then click Properties.
In the Logon Properties dialog box, click Add.
Click Browse to add the path where you have downloaded the .exe.
Click OK.
Instruct all users to restart their computers.

The Outlook Add-In is complete after the computers are restarted.

Method 3: Host the Installation File on an Internal Network

When the end user computers have no Internet connection, you can host the installation file from a location on your local network. You must download the Outlook Add-In installer and create a new installer package that use local paths to install Outlook Add-In, Visual Studio Tools for Office, and .NET Framework.

Using a third-party tool, such as 7-Zip, extract the contents of the OutlookAddinCSandEdgeAdmin.exe into a new folder.

The extracted folder contains the following files:

CvInstaller.exe: the installation file for the Outlook Add-In

CvInstaller.ini: a preconfigured template file that is populated with default software available locations.

BuildEdgeAttachmentStoreAddin.bat: A batch file used to create the final Add-In package.
From the command prompt, type the following command to download the installer package to a local location.
```
 
CvInstaller.exe /DOWNLOAD <DownloadPath>
```
Replace <DownloadPath> with the full path to the download.

The following files appear at the specified download path:
- OutlookAddinClient_x64_11_06152016.msi
- All prerequisites
Right-click CvInstaller.ini, and then click Edit.
Follow the appropriate directions below to customize the CvInstaller.ini file according to your needs:
- For .NET framework: change the existing path to a local path where .NET framework installation file is located.
  
  For example: x64="\\localhost\download\dotnetfx40_full_x86_x64.exe"
- For Visual Studio Tools for Office: change the existing path to a local path where .VSTO installation file is located.
  
  For example: x64="\\localhost\download\vstor40_x64.exe"
- For Edge Attachment Store Add-In: change the existing path to the local path where the OutlookAddinClient.msi file is located.
  
  For example: x64="\\localhost\software\EdgeDriveAddIn\Win64\\\localhost\software\OutlookAddinPreReq\Win64\OutlookAddinClient_x64_11_06152016.msi"
- For Custom JRE: Change the existing path to the local path where the Custom JRE file is located.
  
  For example: x64="\\localhost\software\EdgeDriveAddIn\Win64\CvJREx64.exe"
  
  Note
  
  Make sure that only these variables are modified in the CvInstaller.ini file to customize the installation.
Save the CvInstaller.ini file.
Double click BuildEdgeAttachmentStoreAddin.bat.
At the command prompt, type the output location where you want to create the Add-In installation package and press Enter.
Type the host name of the Web Console used for the ObjectStore, and then press Enter.

For example, if the Web Console name is drive.company.com, by default, the Web Console URL will be http://drive.company.com. To use secure access, provide https://drive.company.com as the Web Console name.
Specify the file size in KB for the email attachment.

For example, if you specify 5KB in the command line for Minimum File Size in KB, then the emails with the attachment size less than 5KB are not uploaded in the Edge drive and you cannot see the links for the attachments in Outlook .

Emails with attachment size greater than 5KB are uploaded in the Edge drive and you can see links for the attachments in Outlook

The OutlookAddinCSandEdge package is created in the specified output location.
Save the executable to a location on your internal network.
Double click the CvInstaller.exe to install the Outlook Add-in with ContentStore and Edge Attachment Store package.

Result

The Add-In is installed on the end-user computer. Also, a configuration file CVEdgeDriveAddin.Config.xml is created during the installation and copied to the same location where the package is installed.

This XML file is uploaded to the user profile folder when the Add-In is used. For example, C:\Users\username\AppData\Local\CVEdgeDriveAddIn\.

You can modify the following parameters in the xml file for the user:

dMinAttachFileSizeKB - defines the minimum file size for attachments to be uploaded to the ObjectStore. Attachments with file size equal or greater than the specified value are automatically uploaded to the ObjectStore. Default value is 0.
dUploadChunkSizeKB - defines the chunk size of the files to be uploaded. Default value is 1 MB.
sWebConsoleName - specifies the Web Console to be used for the upload. By default, the Web Console URL uses HTTP. If you want to use secure access, add HTTPS to the Web Console URL in the input.

For example, if the Web Console name is drive.company.com, by default, the Web Console URL will be http://drive.company.com. To use secure access, provide https://drive.company.com as the Web Console name.
DoNotUpload - when set to True, the Add-In does not upload any email attachments to the ObjectStore. Default value is False.
FromSameDomain - when set to True, the add-in will upload the attachments only when all the email recipients are from the same domain as the sender. Default value is False.
DomainToBlock - specifies the domain or recipient user for which the Add-In blocks the upload. Email attachments are not uploaded if any of the recipients are specified or if any of the recipients are from a specified domain. You can repeat this parameter in the xml file to block multiple domains or users.

What to Do Next

After installing the package, open Microsoft Outlook application and verify that the Add-In is active. End users can now view their archived emails, content indexed emails and also send emails with the attachments as links. For instructions, see Attaching Files in Outlook Using Edge Attachment Store.

If messages were archived using the Exchange Mailbox Agent, end users can see previews of messages whether or not the messages were content indexed.

Note

When an updated version of the Outlook Add-In is available in the Cloud Services web site, you can recreate the end-user package using the updated version and deploy the Add-In on all end-user computers.

To uninstall the Add-In, remove the Add-In from Microsoft Outlook, and then uninstall from the Control Panel.