1. Support Center
  2. General
  3. Avionté Product Management

Outlook Connector - Setup

Updated
Version Requirements
Avionte version 16.2 and above uses Connector version 15.2.1.0 version of the Outlook Connector which is located in the SFTP file. Choose 32 bit or 64 bit of the 15.2.0.0 version.

The Outlook Connector replaces the Outlook Add-in and Integrated Outlook as the primary way to use Outlook with Avionté. 

 

Adding the Avionté option to the Microsoft Outlook menu enables:

  • Synchronization of Outlook and Avionté calendar appointments as well as scheduled tasks
  • Resume parsing 
  • Message logging
  • Record creation

 In Outlook 2010, the Avionté menu appears in the Add-Ins tab.


 

In Outlook 2013, the Avionté menu appears in the main menu bar and includes a ribbon of menu items.

 
 

Setup Requirements

  • Setup requirements for self-hosted clients differ from Avionté-hosted client setup. This page features setup requirements for both.

  • A 32-bit or 64-bit version of Microsoft Outlook 2010 and newer. The Avionté Outlook Connector can be used with Outlook 2010 and 2013.
  • .NET version 4.5 is required for use.

  • Note: Outlook must not be running when you install the connector or it will not install. Please exit out of Outlook completely, before proceeding further.

 

SFTP Installation Process

Before installation, contact your Account Manager (AM) so they can:

  • provide a username and password for the Avionté SFTP site. 
  • activate an internal Avionté license for the Outlook integration.

In order to more securely transfer and support your document file transfer, Avionte uses SFTP. You may connect using File Explore or any software package that supports SFTP. If you do not currently have an FTP client program, we suggest FileZilla (link below).

https://filezilla-project.org/download.php?type=client

  1. Copy and paste the below URL into the Host address field.
    ftp://ftp.aviontego.com/
  2. Enter the Username, Password, and Port number 990, then click the Quickconnect button (if using Filezilla).

    Filezilla.png

  3. Click Yes or OK to the security prompt.

    The files that appear on the left will be the ones on your computer. Much like the file explorer in Windows, you can navigate around this left panel to wherever you have your data housed. The right panel will be connected to the Avionté SFTP site. When files have successfully made it to your computer, you will see a ‘successful transfer’ message appear on the bottom most panel.

    Filezilla_-_full_screen__1_.png

  4. On the Avionté side, Click Tools.

  5. Click Outlook Connector.

  6. Click the version of Avionté that you are using (e.g. 16.2 and above). 
    Note: Your version of Avionté is noted in the lower-right of the Avionté application screen.

  7. From the Installer options, click on the option that matches your Microsoft Outlook version.
    Note: To check your version of Microsoft Outlook, navigate to File > Click Office Account. Locate the version under "About Outlook" on the main panel.

  8. Click Avionte.OutlookConnector.Installer.AllUsers if the Outlook Connector will be applied to all users using on the PC being used or click Avionte.OutlookConnector.Installer to apply the Outlook Installer to just the currently logged in user. 

  9. Click Avionte.OutlookConnector.Installer.msi.

  10. Click Run and follow the Install Wizard to complete installation. 

 

 

Avionté-Hosted Setup

This Outlook installation process is designed for use by customers hosting in an Avionté environment, rather than a self-hosted environment.

Before installation, contact your Account Manager (AM) so they can activate an internal Avionté license for the Outlook integration. 

  1. The Outlook Connector requires that the Avionté web service is running for your environment. Ensure that the web service is running.
    Note: This is set up and configured by Avionté during the installation or upgrade process for versions 15.1 and newer.

  2. The Outlook Connector must be installed on the individual's computer or your system administrator may run the installer for all users.

  3. In the Core Application, create a web login for each user with the Web Role of OutlookAddinUser.
    1. Navigate to Start Page > Actions > Admin Tools > Category = Employer > Select specific Employer > User Tab

    2. In Admin Tools, select the Employer category and select the desired branch for this user.

    3. Click Add/Edit.

    4. Click Add New to create a new user (complete the User Info fields below) or select a user from the upper grid. The selected user will display in the User Name field below. 

    5. Click the Web Login button. The Web Login User window displays.

    6. Create or edit the web user according to these definitions. 

      Field

      Description
      Login Name The login name for the selected user.
      Password The password for the selected user.
      User Description A description of the selected user, usually listing what groups they belong to.
      Related User The related user for the selected user.
      Web Role Ensure the OutlookAddInUser box is selected to activate the Outlook Connector for this user. Multiple boxes may be selected. 
    7. Click Finish to save and close the completed web login setup for that user.

    Note: The Web Portal Menu User tab is non-functional when accessing the wizard from this location.

  4. Once the user is set up with an Outlook AddinUser (web login role), and the Outlook Connector installer has been run, the Avionté menu will be available in Outlook's ribbon.
    Note: Avionté's core application must be open and running prior to opening Outlook.   If the Avionté menu does not appear, restart Outlook.

  5. To complete the connection in Outlook, click Avionté from ribbon and click login. 

  6. Enter the username and password as created in step three. 
    Note: Place a check mark in the "Save Password" box to store the password for future logins. If this box is checked, the user will not be prompted to enter the password for the Outlook Connector for each new session of Outlook. This is only available for Avionté versions 15.2 and newer that use Outlook Connector version 15.2.0.0.

  7. Enter your three letter company code. If you do not have this code, contact Avionté support.

  8. Click Connect.

  9. A "Login Successful" message will appear. Click Close.

  10. At this point, Outlook should be successfully connected to Avionté.
Note:There are additional configuration options that can be set on a per-user basis:
  • Set the Config Option > User > User_UserSetting > AutoSyncOutlook to True if you wish to have Avionté sync with Outlook automatically at start-up.

  • Set Config Option > User > User_UserSetting > OutlookSyncOptions to indicate which sync option in the user's Sync Outlook window is set by default.

  • Set Config Option > User > User_UserSetting > SyncOutlook to enable synchronization between Outlook and Avionté.
    Note: For more information on what "Sync" means with regard to the outlook connector see the documentation located lower on the page.

 

 

Self-Hosted Customer Setup

This Outlook installation process is designed for use by customers using a self-hosted environment rather than an environment hosted by Avionté.

Before installation, contact your Strategic Account Executive (SAE) so they can activate an internal Avionté license for the Outlook integration.

  1. Check to see if the Outlook Add-In web service is running. If not, proceed with the installation and configure the web service.
     
  2. Run the Outlook Connector installation file for each user. 
    Note: This is shipped with the Avionté installer and should be available on the SFTP. If employees will be using a RDP to access Outlook, the installation file should be run there for each user.
    There are two versions of both the 32-bit and 64-bit installation files. One installs for just the current user, the other installs for all users.
     
  3. In the Core Application, create or edit a web login for each user with the Web Role of OutlookAddinUser. 

    1. Navigate to Start Page > Actions > Admin Tools > Category = Employer > Select specific Employer > User Tab

    2. In Admin Tools, select the Employer category and select the desired branch for this user.

    3. Click Add/Edit.

    4. Click Add New to create a new user (complete the User Info fields below) or select a user from the upper grid. The selected user will display in the User Name field below. 

    5. Click the Web Login button. The Web Login User window displays.

    6. Create or edit the web user according to these definitions. 

      Field Description
      Login Name The login name for the selected user.
      Password The password for the selected user.
      User Description A description of the selected user, usually listing what groups they belong to.
      Related User The related user for the selected user.
      Web Role Ensure the OutlookAddInUser box is selected to activate the Outlook Connector for this user. Multiple boxes may be selected. 
    7. Click Finish to save and close the completed web login setup for that user.

The next time Outlook is started, Avionté will be available for selection from the Outlook ribbon. 

8. Each user will need to log into the connector with their username created in step 3 and their company code.

    • The Outlook Connector should now be fully functional for a self-hosted client.

  

 

Outlook Add-in Web Service Setup (Self-Hosted Customers)

If your site is hosted through Avionté, you do not need to set up the Web Service, as it is already set up with Avionté. If you are a self-hosted client, follow these steps to set up the web service once the zip files have been downloaded from the SFTP site as indicated above: 

Before installation, contact your Account Manager (AM) so they can activate an internal Avionté license for the Outlook integration.

Advanced Users: It may be necessary to install an updated version of Outlook for self-hosted customers. A request to add an updated version of Outlook to a client's FTP server should be submitted to IT as needed.
  1. Extract the folder <version number>_OutlookAddinWebService.zip to the server where you want to install the web service for Outlook Add-in.

  2. Copy the OutlookAddinService folder to the <local disk>/inetpub/wwwroot folder.

  3. Open the copied folder then edit the web.config file in an editor, such as Notepad:

    • Within the file, find the line of code that includes the key "Main.ConnectionString.SQL Server (SqlClient)".

      Note: This step should be verified and performed, if necessary, for each Outlook AddIn service in use at your site. This line of code will look like this:

      • <add key="Main.ConnectionString.SQL Server (SqlClient)" value="initial catalog=abcdb;user id=userabc;password=1Abc#Fd;data source=xyz02;persist security info=False;packet size=4096" />

      • Set initial catalog to the name of the database.

      • Set data source to the database server on which the database resides.

      • Set the user ID and password values to match a user that has the DB_owner role for that database.

    • The key ResumeParserTempFolder must be given a valid folder path on the web server (for example, <add key="ResumeParserTempFolder" value="C:\Temp\ResumeParserTempFolder\" />) This controls where resumes will be temporarily stored while they are parsed.

  4. Open the IIS Manager by entering inetmgr in the Windows Run prompt. The Internet Information Services (IIS) Manager window appears. The OutlookAdd-inService can be found under the Default Web Site in the Connections list to the left.

  5. Right-click OutlookAddinService under the Connections panel and choose Convert Application. The Add Application window appears.

  6. Set the Alias name for this service to OutlookAddinService.

  7. Verify that the Application pool setting is the same as currently being used for the web portal. This must be an application pool using 4.0 .NET framework, and it must have the advanced setting Load User Profile set to True (click Select to change if needed).

  8. Set the Physical path to the root folder where the OutLookAddinService is installed.

  9. Click the Test Settings button to verify the service has been set up correctly. If not, please review the steps above.

  10. Click OK to finish the setup.
Note: The following will also need to be added to the web api web.config file.

<appSettings> <add key="AvionteOutlookAddInWebService" 
value="http(s):// hostname.com/Avionte/Outlook/OutlookAddInService.asmx" />


Note: The connection (HTTP or HTTPS) is determined by the current configuration of your environment. Contact your Avionté support team for more information.

  • Hostname: The name of the web server associated with the install.

  • OutlookAddinService: The alias given to the WebService during the installation.

 

 

Admin Tool Properties

  1. Set the AutoSyncOutlook config option to True to have Avionté sync with Outlook automatically at start-up.

  2. Set OutlookSyncOptions to indicate which sync option in the user's Sync Outlook window is set by default.

  3. Set SyncOutlook to enable synchronization between Outlook and Avionté.

 

Outlook Removal and Re-Installation

In the event a release upgrade requires an update of the Avionté Outlook Connector, (i.e. the 15.2 release,) the Avionté Outlook Connector will need to be updated.

Normally, the Outlook Connector does not need to be uninstalled as re-installing the application automatically overwrites the existing application. However, in the event an uninstall is needed, those steps are included below.

 

Uninstall

  1. Navigate to the Windows uninstall area according to the PCs current operating system.

    • Windows 8 Users

      Right-click on the Windows icon in the lower-left of the screen and select Programs and Features from the top of the menu.




Windows 7 Users

    • Click the Start button in the lower-left of the screen.
    • Click Control Panel.
    • Click Programs.
    • Click Programs and Features.
  2. Click Avionté Outlook Connector to highlight the program.



  3. Click Uninstall.

  4. A confirmation window will display. Click Yes to confirm you want to uninstall Avionté Outlook Connector.

    Even though the Avionté Outlook Connector uninstalls, the setup API and Avionté user settings and config choices should still be intact.

 

Re-Install

  1. Navigate to the Outlook Connector Installation program in your system's folders. This program is originally provided to customers via an FTP file transfer and is saved to a folder chosen by each customer.



  2. Double-click on the appropriate version of the Outlook Connector installer.

    • Customers using a 32-bit version of Outlook should install the 32-bit version of the Outlook Connector Installer; 64-bit versions of Outlook should use the 64-bit installer.
    • If installing to a single user, the Avionte.OutlookConnector.Installer should be used; If installing to multiple users, the Avionte.OutlookConnector.Installer.AllUsers installer should be used.

  3. The Avionté Outlook Connector Setup wizard will open. Click Next.

  4. Click Install. The connector will install to the user's Outlook application. 

  5. Click Finish.

  6. Restart Outlook. The Avionté selection should display in the Outlook menu selections. 



    If the Avionté selection fails to display in the menu selections or the Outlook Connector doesn't function as expected, visit the Outlook Connector Troubleshooting section or the Outlook Connector FAQs article.

 

 

3rd party link Disclaimer: These links are being provided as a convenience and for informational purposes only; they do not constitute an endorsement or an approval by [The author] of any of the products, services or opinions of the corporation or organization or individual. [The author] bears no responsibility for the accuracy, legality or content of the external site or for that of subsequent links. Contact the external site for answers to questions regarding its content.

 

Articles in this section

Was this article helpful?
0 out of 0 found this helpful
Share

Comments

0 comments

Please sign in to leave a comment.