Set up the empower® Web App

Required Permissions: IT Admin 

This article describes the setup of the empower® Web App and the empower® Web Sync as well as important prerequisites.

Note

To be able to use the empower® Web Components in the Office Online applications, you need to roll out the manifest files after this initial setup.

For further information regarding the setup of the web components in Office Online, see Set up the empower® Web Components for Office Online.

Prerequisites

To be able to set up the empower® Web App and Web Components, the empower® Backend 9.2 or newer must already be installed.

For versions lower than version 9.7, the empower® Backend Installer does not install the empower® Web Components.

Therefore, a manual installation is required. This installation is described in this article.

The installation of the empower® Backend of a version >= 9.7 includes the web components.

If you do not yet have a backend installation and will perform an initial installation of the empower® Backend of a version >= 9.7, you do not need to follow the instructions in this article.

Important

If you have already installed the empower® Backend of a version >= 9.7 without enabling the web components upon the initial installation, the empower® Web Sync must be installed manually in addition to the empower® Backend.

If you want to use the empower® Web Sync and have already installed the backend of a version >= 9.7, contact your Onboarding Specialist or Customer Success Manager.

If you want to use the empower® Web Sync and have already installed the backend of a version <= 9.5, follow the instructions in this article.

Note

For further information regarding the installation of the empower® Backend from version 9.7 onwards, see Install the empower® Backend (Version >= 9.7).

Install the Web Sync

To install the empower® Web Sync, which is the base for the use of the empower® Web App and Web Components, empower® Support provides you with a separate installation package containing the following files:

  • WebLibrary_Installer.exe 

    This is the installation file for the empower® Web Sync.

  • installer-config.json 

    This is a configuration file which contains information about the required changes to the backend configuration.

  • IdentityServiceConfig_Updater.exe (optional)

    This file is only required if you want to use empower® Mails Online.

Important

If you are hosting empower® in the empower® Cloud, empower® Support takes care of the required changes and the installation.

In this case, you do not need to follow the instructions in this section.

To install the empower® Web Sync, follow the following steps:

  1. Store the files WebLibrary_Installer.exe and installer-config.json in the current installation directory of the backend.

    If you want to use empower® Mails Online, additionally include the file IdentityServiceConfig_Updater.exe.

    The respective path should be similar to the following:

    C:\Program Files (x86)\empower\backend\ServiceHost\Services 

  2. If the installation directory of the backend is not located under the default location, adjust this information in the file installer-config.json.

    The following value is preset by default:

    {
"programDataLocation":"C:\\ProgramData\\empower\\backend\\empower"
}

  3. If you want to use empower® Mails Online (the web component for Outlook), adjust the file installer-config.json accordingly.

    If you do not want to use empower® Mails Online, no further adjustments to the file are required.

    1. To enable single sign-on, enter the values for ApplicationId and ApplicationIdUri in the .json file:

      {
  ...
  "Sso" : {
    "ApplicationId": "[APPLICATION ID]",
    "ApplicationIdUri": "[APPLICATION ID URI]",
  }
  ...
}

      The values can be found in the app registration that you have adjusted for the use with empower® Mails Online.

      For further information, see Adjust App Registration for empower® Mails Online.

    2. To configure the authentication method correctly, enter the values for AzureTenantId and AllowedAudiences in the .json file:

      {
  ... 
  "ForeignIdToken": {
    "AzureTenantId": "[TENANT ID]",
    "AllowedAudiences": [ "[CLIENT ID]" ]
  } 
  ...
}

      For the placeholders [TENANT ID] and [CLIENT ID], enter the Tenant ID and Client ID from the app registration that you have created for empower®.

  4. To execute the installer, double-click on the file WebLibrary_Installer.exe.

    After the installation, the installer, the configuration file and a new folder called WebLibrary_Installer remain in the installation directory.

  5. If you want to use empower® Mails Online and have configured the file installer-config.json accordingly, execute the file IdentityServiceConfig_Updater.exe.

    If you do not want to use empower® Mails Online, you can skip this step.

  6. Remove the remaining files WebLibrary_Installer.exe, installer-config.json and the new folder WebLibrary_Installer/.
image.webp

In the default configuration, the empower® Web App can now be accessed at the following link:

https://[BASE URL]/empower/websync/app 

Note

Replace the placeholder for the base URL with your company's base URL.

Note

To be able to use the empower® Web Components in the Office Online applications, you need to roll out the manifest files after this initial setup.

For further information regarding the setup of the web components in Office Online, see Set up the empower® Web Components for Office Online.

Enable Features in the empower® Admin Center

If you want to use the features Recycle Bin and empower® Links, the web integration features must be enabled in the empower® Admin Center.

If you do not want to use the recycle bin or empower® Links, you do not need to make any changes in the empower® Admin Center.

To enable the features, follow the following steps:

  1. Open the empower® Admin Center.

  2. Navigate to the section Customizing.

  3. Choose the section Features.

  4. Make sure the feature Content Management > Library Browser > WebLibrary Integration is enabled.

  5. Click on the button Save on the bottom of the page.

Note

For further information regarding the empower® Admin Center, refer to our empower® Admin Center manual.

For further information regarding the recycle bin and empower® Links, refer to our manuals.

Update the Web Sync

An update of the web components works similar to a new installation.

The installer recognizes if an instance of the empower® Web Sync already exists, takes it offline and replaces the corresponding files.

You can therefore follow the instructions for installing the empower® Web Sync.

If you have empower® Mails Online in use, make sure to execute the file IdentityServiceConfig_Updater.exe each time the empower® Backend is updated.

Important

As the empower® Web App and Web Components are published together with the empower® Release, always update the backend first and then update the web sync.

Otherwise, the installation of the backend will overwrite the settings.

Was this article helpful?

/

Comments

0 comments

Article is closed for comments.