Editing the Configuration File

This section explains how administrators can lock pre-loaded account settings for the Aspera Add-in.

Note: The format for the Aspera Add-in configuration file has changed as of version 1.2.0. If you modifed the configuration file for Aspera Add-in version 1.1.0, you must create a backup of your configuration file before upgrading to version 1.2.0 or higher. After the upgrade, manually edit the new configuration file to match the settings from your previous configuration file. The version 1.2.0+ configuration file is named AsperaConnectOutlook2007.dll.config (Outlook 2007) or AsperaConnectOutlook.dll.config (Outlook 2010).

The configuration file is located at C:\Users\username\AppData\Local\Programs\Aspera\Add-in for Microsoft Outlook.

Within this file, you can edit the configuration settings below. To prevent a pre-loaded account from being modified by users, set <locked="false"> to <locked="true">. As a best practice, you should lock any settings that are enabled under enableInitialSettings. In addition, ensure that you format values appropriately, as shown below.

INCORRECT

<value>
Acme Music Tracks
</value>

CORRECT

<value>Acme Music Tracks</value>

Note: When you edit the configuration file, you can only lock settings for pre-loaded accounts (not for accounts created afterwards). To lock accounts that have been added at a later time, you must modify the AccountsInfo.xml file, which can be found at C:\Users\username\AppData\Roaming\Aspera\Aspera Outlook Plugin

Sample Configuration File Contents

...
<defaultConfigurationSettings>
    <AsperaCommon.Settings.AccountInfo>

      <!-- Global settings will take effect upon Outlook restart. Locked status is only applicable to preloaded accounts-->
       <setting name="enableMultipleFaspexAccounts">
        <value>
          true
        </value>
      </setting>
      <setting name="updateServerLocation" locked="false">
        <value>
          http://beta-download.asperasoft.com/download/sw/connect/auto/connect_references.json
        </value>
      </setting>
      <setting name="helpLink" locked="false">
        <value>
          http://download.asperasoft.com/download/docs/outlook-addin/user/
              6f68a759-1e48-4b6d-a4a7-560a1291789c/index.html
        </value>
      </setting>
       <setting name="MailTemplateFileLocation" locked="false">
        <value>
          EmailTemplate.txt
        </value>
      </setting>
      
      <!-- Initial settings will take effect upon first launch of Outlook-->
      <setting name="enableInitialSettings">
        <value>
          True
        </value>
      </setting>

      <!-- Per account settings-->
      <setting name="Threshold" locked="false">
        <value>
          8
        </value>
      </setting> 
     <!-- Please ensure that the folder below is created prior to using Aspera Add-In. Aspera Add-In will not create a folder upon receiving content-->
      <setting name="SavePath"  locked="true">
        <value>
          %APPDATA%/
        </value>
      </setting>
      <setting name="UserNameFromSystem" locked="true">
        <value>
          True
        </value>
      </setting>
         <setting name="AskBeforeSave" locked="false">
        <value>
          True
        </value>
      </setting>
      <setting name="Username" locked="false">
        <value>producer1</value>
      </setting>
      <setting name="Password" locked="false">
        <value>mu51c@l</value>
      </setting>
        <setting name="UseEncryptionAtRest" locked="false">
        <value>
          <value>true</value>
        </value>
      </setting>
      <setting name="extensionList" locked="false">
        <value>jpg, png</value> 
        <!-- please list files in the following format <value>jpg, gif, png</value> do not split over multiple lines-->
      </setting>
      <setting name="ServerAddress" locked="false">
        <value>
          https://www.acmemusic.com/aspera/faspex
        </value>
      </setting>
      
     <!-- Description field for preloaded accounts will be always locked and non-editable-->
      <setting name="Description">
        <value>Acme Music Tracks</value>
      </setting>
    </AsperaCommon.Settings.AccountInfo>
  </defaultConfigurationSettings>

    </AsperaCommon.Settings.AccountInfo>
  </defaultConfigurationSettings>
...

Global Settings

The global settings described below take effect when you restart Microsoft Outlook.

Field Description
enableMultipleFaspexAccounts When the value is true, the user may add Faspex accounts through the GUI

When the value is false, the user may not add Faspex accounts via the GUI.

updateServerLocation Points to connect_references.json, storage for platform-specific public resources related to Connect. Includes all docs, installer downloads and release notes.
helpLink Sets the URL for the Aspera Add-in user guide. You may customize this to point to your own help page.
MailTemplateFileLocation Specify the template for the email that alerts package recipients. The current default email template is located in the same directory as the configuration file and looks like the example below:
<div style=\"border:solid 2px #71B32B;Padding:.9em\">
<div style=\"margin-bottom:0.8em;\">
	<b>A faspex package containing the following files 
		has been sent to you:</b><br />
	@AttachmentList<br />
	You should be getting another email shortly containing 
		the attached files/directories.
</div>
</div>
<br />

Initial Settings

If there are no existing accounts (that is, AccountsInfo.xml has not yet been created), setting enableInitialSettings to true generates a pre-loaded account with pre-configured settings when Outlook starts. See Per Account Settings below for a description of each setting.

Field Description
enableInitialSettings Controls whether the pre-configured account will be created with the settings described in the Per Account Settings section below.

Per Account Settings

The values in this section of the .config file serve as default settings at the time accounts are added to the Aspera Add-in. If this section is changed after an account is created, the changes do not affect existing accounts and will only be applied to accounts added in the future.

Note the following:

Field Description
Threshold The minimum file attachment size that can be sent through Faspex. Must be entered as an integer value between 0-100MB. Note that folder attachments will bypass the threshold and always be sent through Faspex. You can lock this field so that the user cannot modify it from the GUI.
SavePath The default location for saved files (supports %APPDATA%). You can lock this field so that the user cannot modify it from the GUI. If you set this field for a pre-loaded account, be sure to create the folder prior to using the Aspera Add-in, as it will not create a folder upon receiving content.
UserNameFromSystem If set to true, and the user's computer is part of domain, then the Aspera Add-in will read the Windows usernameĀ and substitute it for username field. You can lock this field so that the user cannot modify it from the GUI.
AskBeforeSave If set to true, the user will be prompted for the download location. You can lock this field so that the user cannot modify it from the GUI.
Username Set the default Faspex username (that is, the login ID). You can lock this field so that the user cannot modify it from the GUI.
Password Password for the default Faspex user. You can lock this field so that the user cannot modify it from the GUI.
UseEncryptionAtRest When this is set to true, attachments are encrypted with a password on upload for content protection, regardless of the settings on Faspex or Connect. A recipient must then enter that passphrase when downloading and decrypting the protected files. You can lock this field so that the user cannot modify it from the GUI.
extensionList Enter the file extensions (separated by commas) that will, by default, be sent through Faspex. For example, enter zip to send all zip files through Faspex. Note that if you want more than one file-extension type (such as jpg, gif and png) to be sent through Faspex, you must list them in the following format: <value>jpg, gif, png</value> (that is, do not split the list over multiple lines).
ServerAddress Set the web address of your Faspex transfer server (e.g. https://www.example.com/aspera/faspex). You can lock this field so that the user cannot modify it from the GUI.
Description The account description. For pre-loaded accounts, this field is always locked and non-editable. Be sure to set this value (rather than leaving it blank) if you are configuring a pre-loaded account.