Install EMS for Outlook

ClosedDownload the installation files

  1. Sign in to Accruent Access.

  2. Click My Products.

  3. Under EMS, click Downloads.

  4. In the Software Downloads area, click the link for your software version.

  1. Download EMS For Outlook (EMSForOutlook.msi) (required for both first time installations and upgrades).

ClosedInstall the Exchange Integration Web Service

This service (typically installed where your EMS Web App resides) manages the integration between EMS Software and Exchange, including checking room availability, booking the meeting in EMS, and managing changes.

The Exchange Integration web service needs to be properly configured. For complete instructions, see the Integration to Microsoft® Exchange guide.

ClosedInstall the EMS Platform Services

  1. Sign in to Accruent Access.

  2. Click My Products.

  3. Under EMS, click Downloads.

  4. In the Software Downloads area, click the link for your software version.

  1. Download the EMSPlatformServices.msi file. 

  2. Run this file on your web server. 

    You will need to enter the SQL server and EMS database. Make a note of the database name. The typical install path is C:\Program Files\EMS Software\Ems.Platform.Api.

  3. When all prompts have been completed, click Install. The API is installed on your web server. 

  4. You will also need a Virtual Directory Name (typical default is EMSPlatformServices). Make a note of the new site you have created. This URL will need to be entered during the installation process
    (e.g., http://[ServerName]/EMSPlatform/ [replace with the name of your web server]).

ClosedInstall EMS for Outlook on Users' Computers

This add-in should be installed on your users’ desktops. You will be prompted to supply the Platform Services URL during the installation process. By default, the EMSForOutlook.msi installs all of the files required by the EMS for Outlook Add-in in the following locations:

  • 32-bit machines – C:\Program Files\EMS for Outlook

  • 64-bit machines – C:\Program Files (x86)\EMS for Outlook A 64-bit machine installation will require an elevated permission level.

    This location can be changed during the installation, but it is recommended that you keep the default.

ClosedConfigure EMS

EMS must be configured correctly to activate EMS for Outlook for each Outlook user.

To configure EMS correctly, the following requirements have to be fulfilled:

  1. The Outlook user must have an active EMS Everyday User account.

  2. The EMS Everyday User account must be assigned to at least one Everyday User Process Template with the Outlook option enabled.

  3. The EMS Everyday User account must be associated to an active EMS Group record.

  4. The Exchange Integration Web Service URL should be entered in the Desktop Client parameters.

ClosedInstall EMS for Outlook REST API

ClosedSystem Requirements

Component Version
Operating System IIS 8 Minimum
ASP.NET Core

.NET Core 2.2

Minimum SDK 2.2.401 (includes .NET Core and ASP.NET Core runtime 2.2.6)
Application Pool
  • .NET CLR Version = No Managed Code
  • Enable 32-bit Applications = True
It is required that the HTTPS binding and a valid SSL certificate is enabled in IIS. If you aren't using HTTPS, the following environment variable must be removed from the web.config: <environmentVariable name="ASPNETCORE_HTTPS_PORT" value="44377" />

ClosedInstall the REST API

  1. Sign on to Accruent Access.
  2. Click My Products.

  3. Under EMS, click Downloads.

    The Downloads page opens in a new tab.

  4. In the Software Downloads pane, click the link for your software version.

    A new page opens listing the downloads available based on your license.

  5. Download the EMSforOutlookRestApi.msi file.

  6. Run this file as an administrator on your web server.

    If you don’t see this option, open a command prompt as an administrator and execute from there.

  7. Verify the installation folder.
  8. When prompted, enter the EMS Platform Services URL.
  9. Complete installation.

  10. Create the log file folder C:\srv\outlookapi\logs\Ems.Outlook.Rest.Api and grant modify/write access to the process that will run the API (typically the IIS_IUSRS group).

    If you want to use a different folder, see instructions below to update the appsettings.json file.

  11. Navigate to https://yourdomain.com/EmsOutlookRestApi/index.html.

  12. Verify the installation.

    You should see a Swagger page with information about the APIs. It is expected that, navigating to the root of the virtual directory will result in a 404.

  13. Navigate to System Administration > Settings > Parameters > Everyday User Application.

  14. Add the REST API URL(https://yourdomain.com/EmsOutlookRestApi/) with a fully qualified domain name as a new system parameter.

    Enter "The URL for the EMS for Outlook optimization API" under Description for this parameter.

ClosedApplication Settings

The appsettings.json file in the root folder of the API has the following settings:

"EmsPlatformConfig": { "PlatformUrl": "https://www.yourdomain.com/platform/"

},

"LogsLifetimeDays": 5,

"LogFolderPath": "c:\\srv\\outlookapi\\logs\\Ems.Outlook.Rest.Api"

"LogLevel":{"Default":"Warning"}

  • PlatformUrl – URL where it will communicate with Platform Services; you enter this URL during installation

  • LogsLifetimeDays – duration for which a backlog of logs is maintained

  • LogFolderPath – the path to the folder where logs should be stored

    The “\” characters are indicated by “\\”. If they don’t, the app will fail on startup. In the example above, this path would look like this in file explorer: c:\srv\outlookapi\logs\Ems.Outlook.Rest.Api. The folder must be manually created and given write/modify access for the process running the API (typically the IIS_IUSRS group). A different folder can be specified if needed. Do not use the existing ‘c:\temp’ directory as the OS will clean this up automatically.

  • LogLevel – the default value is "Warning", but it can be changed to "Debug" temporarily to troubleshoot. Do not leave the value as "Debug" long-term as this can greatly increase file size and disc usage on your application server.

 

 

(missing or bad snippet)