Outlook plugin

From Onlinehelp
Jump to navigation Jump to search

The Outlook plugin enables emails to be imported directly in the Umantis solution. This offers you the following advantages:

  • Easier processing of emails for HR departments through direct imports to the Umantis solution.
  • Emails are assigned directly to applicants, provided they exist in Umantis (checked via email address).
  • You can specify three or more Umantis solutions into which emails can be imported.
  • The import is executed through the SOAP interface.

A different plugin is required depending on which version of Outlook you use. Links to the relevant versions and installation instructions are below:

  • If you use Outlook 2010 or newer versions, you can use the following plugin versions:
  • If you use a version of Outlook older than 2010, choose

The Mac version of Outlook is based on different technology, so the Outlook plugin cannot be run on a Mac.

Important notes

Please observe the following important notes on installing and using the Outlook plugin:

  • The Outlook plugin (all versions) provided by Umantis is only intended for use by HR departments.
  • It can be installed independently by the customer and operated with reference to the following documentation.
  • Umantis AG limits itself to verifying various target systems on the most accessible products and configurations used by our customers. Our test environments cover Outlook installations with and without a connection to Exchange. Other client specific environments e.g. Citrix are not tested by us and therefore not supported by our Support. The technical implementation for integration in Outlook is based on Microsoft standards and can therefore be generally implemented in any Windows-based environment.
    Our set-up process installs and configures the plugin for all users present on the machine. Client-specific requirements with regard to loading behavior can be set-up after installation (http://msdn.microsoft.com/en-us/library/bb386106.aspx), but are not supported by our Support team.

Important: The operational capability and compatibility of the plugin should be tested on all relevant and varied environments by the responsible IT department before and after an update.

Outlook 2010 or newer versions

Outlook plugin (from 2015 on)

New in 2017 version

Function

The new plugin works with Microsoft Outlook 2010, 2013, and 2016, and permits the upload of selected emails to one or more Umantis applications. An email can be imported with default settings in a single click ("Fast Track"). Alternatively, a dialog box is available to allow attachments, recipients, and the Umantis application to be edited before uploading.

Important: The new Outlook plugin is designed to allow settings for permissions and Umantis applications to be managed all in one place. The configuration file can be stored at a central location on network storage or as a web resource; saving the configuration locally is still possible, but no longer recommended. If the configuration is publicly available (e.g. through a Web address), then the entries can be encrypted. This ensures that Umantis access data are always secret and secure.

We recommend that only trained specialists (Umantis or IT administrators) be allowed to make changes to the configuration file.
Contact our Customer Service team for more specific information about support packages for the new Outlook plugin.

The plugin comes in English and German languages. The language is automatically adjusted to match the language settings on your system.

New in 2017 version

With the June 2017 version of the Outlook plugin, you can apply an Admin mode and use a fully customizable user agent.

To installation files.

Admin mode
Admin mode lets you apply a reset to restore the Umantis (import) status of emails that could not be uploaded (marked with ) or mails that have already been uploaded.
Ansicht in Outlook: Reset umantis Outlook Mail Status

Admin mode is automatically preselected at installation time. Activation/Deactivation can be performed retroactively via:
File > Options > Add-ins > (select umantis Outlook add-in) > Add-in options > Check box for “Admin mode”

SOAP request — User-defined user agent
User agent string
Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; Touch; rv:11.0) like Gecko
Description of User Agent (UA) sections
Mozilla/5.0 Application-token (IE)
Windows NT 10.0 Platform token to identify system and version (Windows 10)
WOW64 Feature token for the Internet Explorer version (32-bit IE running on 64-bit OS)
Trident/7.0 Trident version token indication Internet Explorer 11 (IE11)
Touch Token for display of touch functions on the client computer
rv:11.0 Browser version as revision token (IE 11)
like Gecko Display of consistency with other browsers

The user agent cannot be configured through the installation wizard or the umantis Outlook plugin settings. The user agent is a technical configuration with the following configuration options.

Option 1 — Automated /unattended installation)

e.g. when usingautomated software deployment)

User agent configuration - Click on “Expand” to see more
User agent configuration
The new MSI installation property “USERAGENT” can be used to configure the user agent in unattended installation scenarios. If this property is not used, the Outlook plugin will use the default user agent described above. The following example presents a user-defined user agent in Chrome:
msiexec.exe /i "umantis.Outlook.Installer.x86.msi" /qb / log "umantisOutlookPlugin.log"
SETTINGSLOCATION="\\srv01\settings\settings.json" USEDNSDISCOVERY="0" USERAGENT="
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/58.0.3029.110 Safari/537.36"
Option 2 — Manual modification of application settings

e.g. formanual deployment)

User agent configuration - Click on “Expand” to see more
User agent configuration
If the umantis Outlook plugin was installed with the installation wizard, then the user agent can be configured directly through the application settings file. This requires administrator permissions:
  1. Open the application settings file
    • C:\Program Files (x86)\UmantisOutlookAddIn\umantis.Outlook.AddIn.dll.config
    • C:\Program Files\UmantisOutlookAddIn\umantis.Outlook.AddIn.dll.config
  2. Find the XML node for “appSettings” and comment out the entry provided:
    • <add key="userAgent" value="{custom-UA}"/>
  3. Specify the value for the “value” XML attribute ({custom-UA}) and save your changes.

The following example shows the entry in the application settings for a user-defined user agent for the Chrome browser:

<appSettings>
 <add key="userAgent" value="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 
                            (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36"/>
</appSettings>


System requirements

  • Operating system: Windows Vista SP1, Windows 7, Windows 2008, Windows 8, Windows 8.1, Windows 10
  • Installed Windows .NET framework 4.5 or higher
  • Installed Outlook 2010 or higher
  • Internet connection

Microsoft Office 365

Note that the umantis Outlook plugin is installed locally, and is then integrated into Outlook. Online versions of Outlook (web applications) that can be used with a Web browser and Microsoft Office 365 are standalone Web applications that do not currently allow for integration of the umantis Outlook plugin.

Installation requirements

Configuration file

A correctly modified central configuration file is required for the use of the new Outlook plugin (from 2015). You will then find a description based on an example file, and finally a configuration file (JSON) that you can use as a template:

Description of configuration file contents (& template) (click on Expand)
No. Parameter name Description Example
1 Key Settings identifier
  • IsAddInEnabled
  • Service.[ID]
2 Value Settings values for specific applications.
  • "Name": Name of your Umantis application
  • “URL”: The URL for your Umantis solution
  • "Key": The key entered here must match the key in your Umantis solution (in Umantis under:Settings > Basic Configuration > Organizational profile > Authentication key for Email import).
    Please make sure that the key does not contain a backslash ("\") - these are not supported!
  • "{ 'Name': 'AM Default Template', 'URI': 'https://recruitingapp-XXXXX.umantis.com/soap/EmailImport?customer=XXXXX', 'Key': 'MyEmailAuthenticationKey'}"
3 Scope Defines the scope of the target group
  • 0 = global (all users)
  • 1 = Windows group (do not use default groups since group namings are OS language dependent)
  • 2 = Windows users
4 Encrypted Indicates whether the value is encrypted
  • 0 = The value setting is not encrypted
  • 1 = The value setting is encrypted with the parameters from EncryptionParameters
5 EncryptionParameters Provides information about the encryption. A "default" key is delivered with the plugin installation. If you use your own key, it must be entered when installing the plugin and then used in the EncryptionParameters.

For increased security, we recommend that you encrypt each value with a new initialization vector. We are happy to support you in encrypting your login data.

  • {"KeyName": "Default", "IV": "7Vb/y0MdFX5S+7/+u6WEVg=="}
  • {"KeyName": "umantisKey", "IV": "YsibijajBvmRBbquEOorJA=="}
6 ScopeIdentifier Identifier for the selected target group (e.g. group name or user name). Multiple values must be separated by commas.
  • Scope 0: The setting can be left empty since '0' indicates access for everyone
  • Scope 1: [ "domain\\G_Admin", "domain\\G_HR" ]
  • Scope 2: [ "alfred.meier", "andrea.mueller" ]

Independent of whether you work with or without encryption or with restrictions to certain user groups, you can specifically modify and use the configuration file.

Important: The central configuration must be in JSON format. Save the file as (Configuration file.json).

Required fields (compare with “No.” in the above table):

  • If you are not using encryption: No. 1 and 2
  • If you are using encryption: No. 1, 2, 4, 5
  • If you are working with user/group restrictions: No. 1, 2, 3, 6

Template: You can use the following templates and specifically modify the data entered there as mentioned in the above description, delete unneeded fields etc.: ConfigurationFile_Template.zip (Save the ZIP file locally, extract the contents and open the configuration file with Notepad++)

Proxy settings

The MSI installation program does not support “unattended” proxy parameter configurations.

The umantis Outlook plugin takes the default proxy setting directly from the host's Internet options. If the default proxy settings do not reflect your (system) requirements, you can modify or specify the proxy setting directly in the plugin’s configuration file.

File path:

  • 32 bit: C:\Program Files (x86)\UmantisOutlookAddIn\umantis.Outlook.AddIn.dll.config
  • 64 bit: C:\Program Files\UmantisOutlookAddIn\umantis.Outlook.AddIn.dll.config

XML nodes

  • appSettings
  • System.net/defaultProxy

Example scenario:

<appSettings> 
   <add key="proxyaddress" value="http://localhost:8888"/> 
   <add key="username" value="1"/> 
   <add key="password" value="1"/> 
</appSettings> 
<system.net> 
   <defaultProxy useDefaultCredentials="false" > 
     <module type="umantis.Outlook.AddIn.Network.CustomCredentialsProxy, umantis.Outlook.AddIn"/> 
   </defaultProxy> 
 </system.net>

Save location / Path to configuration file

We recommend that you specify the storage location for the configuration file right away when deploying the plugin with the installer (UI or unattended). The configuration can also be done manually later on through the Outlook add-in options.

In Outlook, go to File > Options > Add-Ins > Add-In Options to enter the path to the configuration file (.json). For the save location, you have the following options:

  • Path to a locally saved configuration file
  • Path to a configuration file saved on a network (UNC path)
  • Path to a configuration file saved on a web server ("http" or "https" URL with ".json" extension)
  • DNS Discovery / DNS search: SRV record
No storage location is configured when using DNS Discovery. Through a dedicated SRV record on your DNS server, the Web storage location is automatically read and configured when Outlook starts up.

Independent of the selected save location, the DNS/address information must always be modified accordingly.

DNS Discovery

The umantis Outlook plugin can retrieve a setting’s web-based save location through DNS Service Discovery. This is done by copying an SRV entry to the client domain. The SRV entry must be named _umantis._tcp.<domain>. and contain a (Web) address (URL) for the settings file (e.g.: https://umantis.ch/public/umantisoutlookdevsettings.json). It is important that the DNS entry is named accordingly as required by the plugin.
This variation is preferred because it does not need any client configuration.

The configuration in Windows DNS manager can be e.g. carried out as follows:

Figure: Windows DNS Manager
Check the SRV record

To ensure the SRV record is available, follow the following steps (providing the Outlook plugin is not installed yet):

  1. Open command shell (Windows: Start > Run > cmd type > OK)
  2. Type “nslookup” and confirm with ENTER
  3. Type “set type=all” and confirm with ENTER
  4. Type :_umantis._tcp.{yourDomainName}” and confirm with ENTER
  5. All SRV information, including the public URL, will then be listed.

Encrypting with Encryption Helper

Encryption Helper can help you encrypt data that you have stored in the configuration file. If the configuration file is stored in a public location (public URL), you should definitely use encryption due to the danger of external parties entering the public URL in their plugin. This would allow emails to be uploaded to third-party systems. It is generally recommended to store an encrypted central configuration file (in an internal network — UNC address / Intranet).

Encryption can be completed with the Encryption Helper. You can find the following corresponding installation file:

Encryption Helper instructions
> Open the Encryption Helper instructions (Click on "Expand")

Start the UMANTIS SETTING ENCRYPTION HELPER and follow the steps listed under the diagram.

1: Enter any initial key in the Key Generation Initializer field.

2: Click on generate.

3: The generated key is displayed in the Key field. Copy this key and paste it into the Key field in the SETTING ENCRYPTION section. (You will also copy this key into the umantis Outlook plugin options later, under "Keys")

4: Click on new. An InitializationVector is created.

5: Copy the InitializationVector to the configuration file in the EncryptionParameters section.

6: Copy the data to be encrypted from the Value section of your configuration file (Name, URL and umantis solution key) to the Value to encrypt field in the UMANTIS ENCRYPTION HELPER.

7: Click on encrypt to receive an encrypted version of the data you entered.

8: Enter the (encrypted) data shown in Encrypted value in your configuration file, under Value.


Installation

The plugin is available for 32/64 bit Outlook versions. If you want to know which Outlook you are using:

  • Outlook 2010: Open Outlook and click on File and then Help. Your version is displayed in brackets after the version number.
  • Outlook 2013/2016: Open Outlook and click on File > Office Account > Outlook Info to see which version you are using.

Find the appropriate installation file in the following table:

Publication date Installation files Updates / Notes
March 2020
(Version 4.4.20077.1)
  • TLS 1.2
June 2017
June 2016

Which plugin version should I use?

  • In Outlook, click on: File > Options > Add-Ins > Add-In Options
  • The version number of your umantis Outlook plugin is listed at the lower left.
If this approach does not work, you can also check the version number in the Windows control panel.

Installation instructions

We recommend you install the plugin in agreement with your internal IT department. The operational capability of the plugin is only guaranteed if the configuration file is configured correctly.
Using the MSI file, the plugin can also be rolled out in "unattended" mode. This approach is recommended for bigger rollouts with appropriate system administration tools. The MSI parameters can be used to configure additional settings, e.g. for storing your own keys. For more information, see “New in 2017 version” or contact our support team.

1. Install Microsoft .NET Framework 4.5 if it is not already installed. The framework can be downloaded from https://www.microsoft.com/en-US/download/details.aspx?id=30653.

2. Modify the configuration file accordingly and save it in a suitable location on your system.
Further information on the configuration file is provided in the section above.

3. Close Outlook.

4. Start the setup program for the Outlook plugin.

5. Follow the instructions in the setup wizard:

Figure: Setup wizard

Click Next.
6. On the following screen, enter the path to the configuration file under “Settings location”.
(If DNS search is available in the company’s internal DNS Server, check the box for "DNS Discovery for umantis Service" if approved by your IT department.)

Figure: Add-In settings

If you are running an "unattended" installation, the following information may be helpful for each of the scenarios in the table below:
From the Outlook plugin version of June 2017 see discussion under SOAP request — User-defined user agent

Placeholder Example
{installerFile} umantis.Outlook.Installer.x86-4.2.msi
{installerLogFile} umantis.Outlook.AddIn.Unattended.log
{settingsFile} C:\tmp\umantis.Outlook.AddIn.Config.Default.json
{customKeyName} TestKey
{customKeyValue} gkl6+RybThdTw8Ns+PkVRCZ4LS2sy+B1G5Lsjo+CZAM=
Scenario 1
Options: DNS Discovery without custom keys
Example: msiexec.exe /i "{installerFile}" /qn /log "{installerLogFile}" USEDNSDISCOVERY="1"
Scenario 2
Options: DNS Discovery with custom keys
Example: msiexec.exe /i "{installerFile}" /qn /log "{installerLogFile}" USEDNSDISCOVERY="1" USECUSTOMKEY="1"

CUSTOMKEYNAME="{customKeyName}" CUSTOMKEYVALUE="{customKeyValue}"

Scenario 3
Options: JSON configuration file without custom keys
Example: msiexec.exe /i "{installerFile}" /qn /log "{installerLogFile}" USEDNSDISCOVERY="0" SETTINGSLOCATION="{settingsFile}"
Scenario 4
Options: JSON configuration file with custom keys
Example: msiexec.exe /i "{installerFile}" /qn /log "{installerLogFile}" USEDNSDISCOVERY="0" SETTINGSLOCATION="{settingsFile}" USECUSTOMKEY="1"

CUSTOMKEYNAME="{customKeyName}" CUSTOMKEYVALUE="{customKeyValue}"

When you have configured all the settings, click Next.

7. Select the target folder for the installation:

Figure: Destination folder

Click Next. Them confirm the start of the installation by clicking Install.
The installation process starts and can be followed with the help of the shown status bars.

8. Outlook can be started after the plugin has been successfully installed. You can start (and use) the plugin in Outlook using the icon.

Adding a key in the Outlook plugin

Using the Outlook Add-In Options, the key (generated in Encryption Helper) can be added to the Outlook plugin.

Instructions (click on Expand)
  1. In Outlook, click on: File > Options > Add-Ins > Add-In Options:
    Figure: Add-In Options
    Click on Add key.
  2. This opens a window in which you enter the name of the key (KeyName) and the generated key (Key), just as with the data you entered in the configuration file:
    Figure: Add key
    Click on OK to confirm your entry. The key is then listed in the overview:
    Figure: Key added
  3. Click on Apply and then OK. Restart Outlook.

Authorizing and validating user group names

Everyone has authorized access to the plugin by default. If a person is given specific access, all other persons still have access to the plugin because default authorizations have a higher priority. In such a scenario, everyone’s access has to be removed to subsequently add selective access.

You can find the UserGroupNameValidator installation file below if you deal with the validation of specific user group names.

Use the UserGroupNameValidator as help if you want to restrict use of the plugin to a specific user group (e.g. only the HR department). The restriction should then also be stored in the configuration file.

Usage

There is no explicit encryption of emails.

The plugin sends emails from Outlook to the Umantis solution and assigns them automatically when possible. To do this follow these steps:

  1. Select the emails in Outlook that you want to import to Umantis. If you want to upload multiple emails simultaneously (up to 10), select the emails.
  2. Once the emails have been selected, click on either the icon or on > umantis Outlook Mail Exchange.
  3. This opens the following dialog window:
  4. Select the emails and attachments that you want to import.
  5. On the right, select the application into which you want to import the email(s).
  6. Once you have provided all the necessary information, click Start to begin importing the selected emails and attachments.
    During the import, you will see a status bar that shows the progress; after the import is complete, it may display a status with further notes on the process.
  7. Import completed:

    In the above example, a notification under "Status" indicates that the emails could not be assigned. This occurs when the email address is not recorded in the Umantis solution. In this scenario, you have the option (with "Open in umantis") to manually assign the emails in your Umantis solution.

Assigning imported emails

  • If the email address is recorded in Umantis and assigned to a job application, the emails will be stored in the Communication tab (Application documents > Communicationtab).
  • The attachments are stored in the application documents under "Documents" (also as a PDF compilation).

Reference code

(Prerequisite: You must have configured the settings in the following section: Organizational profile)
The reference code added to outgoing emails allows emails to be attributed to a specific application. Please note that this reference code should not be (manually) deleted from the subject line.


Assignment failed:

  • If the imported emails cannot be assigned, they will be stored under “Communication > Unassigned emails”.
  • If the imported emails can be assigned to a person but not to an application, they will be stored under “Communication > Communication history” and can be viewed for that person in any application under “Other communication with applicant”.
Emails cannot be assigned if:
  • Email address is not recorded in Umantis
-> Effect: The email is stored in the “Communication > Unassigned emails” area
  • Email address is not uniquely assigned (= multiple people have the same email address)
-> Effect: The email is stored in the “Communication > Unassigned emails” area.
  • A person has more than one active application in the system (in this case, the system has no way of knowing which application it should copy the documents to)
-> Effect: The email is not assigned to the applicant (person), but rather to the application. The attachments are not copied to an application. This email can be viewed in any of the applicant’s applications in the “Other communication with applicant” table, and in the general communication history.

Common error messages

  • Archiving in progress (emails are not uploaded)
This icon appears in Outlook next to emails that you are currently uploading. If this icon does not disappear on its own (to be replaced by the umantis icon), enter Admin mode (available starting with the June 2017 plugin version).
  • Dialog box could not be opened
Figure: Error message
This error message occurs when e.g. a key is needed to use the plugin. The key can be added in Add-In-Options. Contact your system administrator or IT department if you get these error messages.
  • "could not upload file '$name' to application, because there is no application or more than one active application for person '$persid_assigned_person'"
This log message appears when an applicant has more than one application in the system. In this case, a unique assignment is impossible, and the emails are simply assigned to the person.

FAQ — Frequently asked questions about the umantis Outlook plugin

  • Does the plugin work with Office 365?
Answer: More information is provided in the section on Microsoft Office 365.
  • Are the data that are transferred through the plugin encrypted?
Answer: Yes, the data are encrypted before being transferred. The key factor here is the umantis SOAP interface, which is SSL-encrypted. The Outlook plugin is a client of this interface and connects to it using the URL in the settings. This URL always uses "https".
  • Will the plugin also work in a Citrix environment?
Answer: The Outlook plugin works also in Citrix environments. In addition, the plugin is optimized for Citrix environments using "Native Image Generator" (ngen). Please note that we do not provide support for Citrix-related problems (see notes in upper section).
  • Can the plugin also be used without a configuration file?
Answer: No. The import settings for URL, ID and password are customer-specific. However, the configuration file can be hosted by Umantis.




Outlook Plugin (2014)

Function

The plugin can be used with Outlook 2010 and newer versions, and permits the upload of selected emails to one to three Umantis applications.

Important: Uninstall the old plugin first before you install the new plugin.
The plugin comes in English and German languages. The language is automatically adjusted to match the language settings on your system.

System requirements

  • Operating system: Windows 2003 R2 with MSXML 6.0, Windows Vista SP1, Windows 7, Windows 2008, Windows 8
  • Installed Windows .NET framework 4.0 or higher
  • Installed Outlook 2010 or higher
  • Internet connection

Installation

The Outlook plugin may encounter problems in certain system environments! If problems occur, install either the old version of the plugin or the newest version

The plugin is available for 32- and 64-bit versions of Outlook. If you want to know which Outlook you are using:

  • Outlook 2010: Open Outlook and click on File and then Help. Your bit version is displayed in brackets after your Outlook version.
  • Outlook 2013: Open Outlook and click on File > Office Account > Outlook Info to see which version you are using.

The following files are required for installation. Choose the appropriate plugin for your version of Outlook (32 or 64 bit):

  1. Install Microsoft .NET Framework 4.0 if it is not already installed. Framework can be downloaded from http://www.microsoft.com/de-ch/download/details.aspx?id=17851. Also install the VSTO 4.0 Runtime (Visual Studio 2010 Tools for Office Runtime 4.0) if required. This can be found at https://www.microsoft.com/en-us/download/details.aspx?id=48217.
  2. Close Outlook.
  3. Start the setup program for the plugin.
  4. Follow the steps in the setup program.
  5. After installation, Outlook should be restarted.

Configuration

1. Start Outlook: The Umantis button now appears in your Outlook’s main menu.
Figure: umantis button as a tab in Outlook


2. Configuration: Open the Options dialog window in the File menu. Click on Add-Ins, select umantis Outlook EmailPlugin and click on Add-Ins Options.
3. You can enter the login details for up to three of the umantis solutions you are using in the Applications section. If you do not need three interfaces, leave the fields blank (see the following image).
Figure: Add-In Options
a) Enter a unique name for the solution in the "Name" field. This name will be provided as a selectable option later. It should be short, concise and unique.

b) Enter your solution’s URL in the "URL" field. After "customer=", you must replace XYZ with your customer identification number. This is identical to the number at the beginning of the URL.

If your Umantis is hosted in the German data center, be sure to add ".de" in the URL as well. However, the ".de" must NOT be repeated after "customer=".
If you are using Umantis as a standalone solution, you must replace "XYZ" with "STANDARD".

c) In the "Key" field, enter the authentication key (password) that you entered in the Organizational profile for the Outlook import

(direct link: xy.umantis.com/Administration/Profile, found in the main settings in the company profile).

Figure: Define authentication key for import
4. If your company uses a proxy server connection, the relevant settings should be configured under "Proxy". When Windows authentication is used, the user’s username and password do not have to be entered.

5. Click on OK.

If the Umantis tab is not displayed, you need to activate the add-in: Click on File > Options > Add-ins and select “umantis Outlook email plugin” from the list. Then select the "COM-Add-Ins" option under "manage", and activate the Umantis plugin by ticking the box.




Usage

Note: There is no explicit encryption of emails.

The plugin sends emails from Outlook to the Umantis solution and assigns them automatically when possible. To do this follow these steps:

1. Select the emails in Outlook that you want to import to Umantis. If you want to upload multiple emails simultaneously, select the emails.
2. Click on the "umantis upload" button in the Outlook taskbar.
3. This opens the following dialog window:
Figure: Dialog box for upload

First, in the Application section, select the Umantis solution to which you want to import the emails. The selected emails are then displayed in the dialog window. If there are attachments in the emails, you can select or deselect them individually for import. For emails with more than one recipient, you have to select at least one recipient. To do so, tick the box next to the relevant recipient.

4. Then start the import.
During the import, you will see a status bar showing the progress. After the import, a final dialog window opens providing information on any errors, and provides the option to display the imports directly in the solution so that unassigned emails can be assigned manually (see the following image). The emails can be found under "Unassigned emails" (Employee Management) or "Unassigned emails and letters" (Applicant Management) in cases where the sender is not one of your employees/applicants or the email cannot be clearly assigned for some other reason.
Figure: Completion dialog with error listing



Emails that cannot be assigned

Make sure that the "Unassigned emails and letters" section is being displayed — see Configure views.
Emails cannot be assigned if the employee/applicant does not exist in the system. In this scenario, the emails are stored in the "Unassigned emails and letters" section.

Note
Emails that are uploaded with the Outlook plugin are stored under "Other communication with applicant". These emails can then be assigned to a specific application and will then appear in the "Communication with applicant for this application" section.


Other dialog windows in the plugin

  • If there are connection problems during the upload, an error message is displayed, and you can cancel the import process if desired.
  • If you start the upload with an incomplete configuration, a warning is displayed, and the selection dialog is not opened.
  • If you start the upload without having selected any emails, a warning is displayed, and the selection dialog is not opened.
  • If you select emails that are not from your inbox, outbox or Sent folder, the plugin cannot assign them properly. You will therefore be asked to confirm whether these emails are received emails.
  • If an email has more than 20 attachments, only the first 20 are imported. In such a scenario, a warning is displayed before the selection dialog is opened.


Common error messages

  • SOAP exception: If this message is displayed, then the proxy settings have not been entered correctly, or proxy server information has been entered even though it is not required.
  • SOAP Exception Authentication failed: The authentication key entered in the Outlook plugin does not match the key in your Umantis solution.



Versions older than Outlook 2010

Note: We cannot guarantee that the plugin will function correctly, especially for outdated Outlook versions that are no longer supported by the manufacturer. Please be sure that you have also read and understood the notes above.


Function

The plugin is installed for Outlook 2000, 2003, 2007 or Outlook 2010 (32-bit) and permits the uploading of selected emails to one to three Umantis applications.

System requirements

  • Operating system: Windows Server 2003, Windows Server 2008, Windows Vista, Windows 7, Windows XP (Note: Umantis no longer supports XP!)
  • Installed Windows .NET Framework 3.5 or 4.0
  • Installed Outlook 2000, 2003, 2007 or Outlook 2010 (32 bit)
  • Internet connection

Installation

The plugin is available as a Windows Installer Package: Outlook_Plugin (pre-2010).

Important: Uninstall the old plugin first before you install the new plugin.

1. Install Microsoft .NET Framework 3.5 or 4.0, if it is not already installed. The framework can be downloaded from http://www.microsoft.com/downloads/.
2. Close Outlook.
3. Start the set-up program.
4. Follow the steps in the setup program.

Configuration

1. Start Outlook
2. Configuration:
a) up to Office 2007, open the Options dialog window from the Extras/Options menu.
b) Office 2010, open the Options dialog window from the File menu. Click on Add-Ins and then on Add-Ins Options.
3. Switch to the Umantis register card.
Figure: Configuration settings
4. You can enter the login data for up to three of the Umantis solutions you are using in the Applications section 1 to 3. If you are using fewer solutions, just leave the fields empty.
a) Enter a unique name for the solution in the Name field. This name will be provided as a selectable option later. It should be short, concise and unique.
b) Enter your solution’s URL in the URL field. Replace XYZ with your customer identification after "customer=". If you are using Umantis as a standalone solution, you must replace "XYZ" with "STANDARD".
c) In the Key field, enter the authentication key you entered in the Organizational profile (ask your administrator).
5. Click on OK.

If the Umantis tab is not displayed, you need to activate the add-in: File — Options — Add-Ins; then click on “Go To” by the Manage field. Check the box for “umantis upload” and save.

Caution: The plugin carries out a basic authentication and not an integrated Windows authentication.

Usage

Note: There is no explicit encryption of emails.

The plugin sends emails from Outlook to the Umantis solution and assigns them automatically when possible. To do this follow these steps:

1. Select the emails in Outlook that you want to import to Umantis.
2. Click on the Umantis upload button in the Outlook taskbar. Outlook 2003 and Outlook 2007: Alternatively, you can open the context menu on the selected emails with the right mouse button and select the Umantis upload option that way.
3. This opens a dialog window (see image).
Figure: Upload selected emails

First, in the Application section, select the Umantis solution to which you want to import the emails. All selected emails are shown in this section. Tick the box in front of every email that should be imported to Umantis. For emails that have more than one recipient, you have to select at least one recipient. To do so, tick the box next to the relevant recipient.

4. Start the import by clicking Import
During the import, you will see a status bar showing the progress. After the import, a completion dialog opens, informing you any errors and offering the option to open the product page so that you can assign any unassigned emails manually (see the following image).
Figure: Dialog window for import


Other dialog windows in the plugin

  • If there are connection problems during the upload, an error message is displayed, and you can cancel the import process if desired.
  • If you start the upload with an incomplete configuration, a warning is displayed and the selection dialog is not displayed.
  • If you start the upload without having selected any emails, a warning is displayed and the selection dialog does not appear.
  • If you select emails that are not from folders labeled Inbox, Outbox or Sent, the plugin cannot decide whether the emails are sent or received emails. In this case, you will be asked to confirm whether the selected emails are received emails.











Which umantis Outlook plugin is currently installed?

To find out which version of the plugin you currently have installed, follow these steps:

  • In Windows, click on: Control panel > Programs > Programs and Features > Uninstall or change programs..
  • In the overview table of all installed programs, the umantis Outlook plugin is listed as well. You can see the version number of the currently installed plugin in the "Version" column.


Related topics