Skip to main content
Matrix42 Self-Service Help Center

UEM Console Setup Guide

Applies for UEM Service version 1.0.4 only

Overview

To set up the UEM Console you need both Empirum and Silverback already configured and running on separate servers. The Silverback server by default includes an unconfigured UEM Console. On the Empirum server the UEM Service package needs to be installed and configured. These steps are described in this document.


System Requirements

The software package UEM Service for Empirum can be installed on an Empirum Master Server or Empirum Subdepot Server, version 17.0.1 or higher. IIS is required and will be installed during the setup process, if not already present. If SSL will be used, a certificate needs to be installed on this Windows installation.

To connect UEM Console (included with Silverback) to Empirum, you need to have a server running Silverback 6.0.1 TP1 or higher.


Download installation files

  1. Please download the latest package of UEM Service for Empirum from our Marketplace at Matrix42 UEM Service for Empirum.
  2. Unzip the archive to a temporary directory.

Enable the UEM Service for Empirum

Create Database User

The UEM Service needs a database user to work. To create it:

  1. Open DBUtil.
  2. Click menu Actions > User Management... > Location.
  3. In tab Users, click New.
  4. Enter username (e.g. “UEMSERVICE”) and password, click OK and close the User Management window.
  5. Navigate to the files extracted from the zip file and edit Grant_user.sql.
  6. Replace DBUser with the newly created database user name (e.g. “UEMSERVICE”).
  7. Save the file.
  8. Open DBUtil again.
  9. Click on menu Actions > Execute SQL Scripts… > Location.
  10. Navigate to the SQL script Grant_user.sql, doubleclick it and confirm with OK.

Install the UEM Service

  1. Copy the folder PackageStore to the package store directory on your Empirum Master Server (e.g. D:\Empirum\Configurator\PackageStore).
  2. Import the software package Matrix42 UEM Service for Empirum into your Software Depot via the Empirum Management Console > Configuration > Software Management > Register Depot > Rightclick on Register > Import/Export > Import Package.
  3. Chose the source directory (e.g. \\%EmpirumServer%\Configurator$\PackageStore) and complete the wizard.
  4. Navigate to Management > Administration.
  5. Assign the package Matrix42 UEM Service for Empirum located in the Software Package folder Empirum to a computer with the role Empirum Depot Server or Empirum Master Server (To check the role: right-click on Server > Properties > Tab General > Field Computer Role) and do not activate yet.
  6. Define the variable MX42_UEMSERVICE (right-click on server > Variables) to configure the Web Service installation. In the right window check the variable and doubleclick it.
  7. Select the variable to be edited and click on the Edit button. Remove the checkmark in box Empty value and add the data into each field Value. Click OK.

    UEM_WEBSITE

    Specifies the name of the website (e.g. “UEMSERVICE”. If blank, a website with the name "Matrix42" will be created). If you want to use an already existing website, please specify the exact name of the existing website.

    UEM_SQLUSER

    Specifies the database user to access the Empirum database. Beware of any blanks inside the input box.

    UEM_SQLPASS

    Specifies the password of the authorized SQL user account.

  8. Close the Variables window by clicking OK.
  9. Go back to the Empirum Management Console and activate the server with the assigned UEM Service package.

In case you have specified an existing website, you might skip the next two steps and continue with 'Obtain access token from Silverback'. The default http port of the new website is '9400'. 


Import SSL certificate on Empirum Server

In case you haven't yet installed a certificate on your server, please proceed as follow:

  1. Logon to your UEM Service Server.
  2. Start the IIS Manager application.
  3. Click on your Server which is hosting your UEM Service website.
  4. Select the feature Server Certificates in the Feature View on the right.
  5. Right-click in the empty window and select Import... from the context menu.
  6. Browse the path yo your pfx-certificate file and select it.
  7. Enter the password of your protected pfx-certificate file.
  8. Under Select Certificate Store select Personal from the drop-down.
  9. Click OK and proceed like described in the section above.

Enable SSL/TLS on Empirum Server

  1. Logon to your UEM Service/Empirum Server.
  2. Start the IIS Manager.
  3. Click on the website UEMSERVICE (or the site name you configured).
  4. In the Actions pane click Bindings...
  5. If https already exists click Edit otherwise click Add.
  6. As Type choose https and your SSL certificate you want to use.
  7. Click OK and then Close.
  8. Restart IIS by clicking on Restart or execute the command iisreset in a command shell.

 Please also change the WebService URL under UEM settings in your Silverback system configuration. For the changes to take effect please restart your Silverback IIS.

Obtain access token from Silverback

  1. Logon to the Silverback admin console (e.g. http(s)://yoursilverbackserver/admin).
  2. Go to Admin menu > User Management.
  3. Create a New System User (e.g. UEMSERVICE) or select an existing one. The role needs to be Administrator.
  4. Click Save.
  5. Edit the user again. Under Create API Token select scope Global Write, enter a description like Empirum Access and click Create.

 Token creation takes several minutes!

  1. Copy the new token the clipboard to be able to paste it in the next step.

Configure UEM Service

  1. Open the Windows file explorer and navigate to \Empirum\Empirum DBUtil\Windows\Backend Task Hosting Service.
  2. Edit the config file Matrix42.Empirum.PLF.Services.ActivationQueue.UemSynchronization.dll.config. These are the configuration parameters that you need to adapt to your environment:

UemApiUri

Defines the endpoint address of the UEM-API of the Silverback system. Replace http(s)://PleaseInsertYourApiEndpointUrlHere with your UEM-API URL (e.g. http(s)://yoursilverbackserver.com/uem/api/v1/empsync).

UemApiToken

Defines the authentication token for the UEM-API of the Silverback system.

Paste in your Silverback access token from the clipboard and use “Bearer“ as a prefix for the token

(e.g. UemApiToken value="Bearer eyJ0eXAiOKV1QisxLDIsM119_8ZxQmKCFAQf4VY").

SyncBatchSize
Defines the amount of DB entries that will be processed within each interval (default is: 100).
IntervalInMilliseconds
Defines the interval in which the DB entries will be processed (default is: 3000).
TimeoutInSeconds
Defines after which period of time the service runs in a timeout (default is: 86400).

  1. Save the file.
  2. Open DBUtil and Reinstall the Empirum Activation Service.
  3. In DBUtil, open the Actions menu and click on Execute SQL Scripts… > Location and open the folder \Empirum\Empirum DBUtil\Scripts\SQLServer\Custom.
  4. Double-click the SQL script ActivateUEMDeviceSync.sql and confirm the message.

Create STS client for accessing UEM Service for Empirum

  1. Open the URL http(s)://yourempirumserver.com/Matrix42-UEM-STS/Authorize/Login in a browser, where yourserver.com is the server where you have installed the UEM Service.
  2. Sign in using the Empirum database credentials.
  3. Create new client by clicking on the plus button.
  4. Enter a name for this new Client ID (e.g. Empirum).
  5. For RedirectURL enter http(s)://yourempirumserver.com/Matrix42-UEM-STS/Authorize/Token .
  6. Click on Create to save the STS-Client.

Configure the UEM Console for managing Empirum devices

  1. Log in to Silverback with the Settings Administrator and go to UEM settings to enter the Empirum settings:

WebService URL

http(s)://yourempirumserver.com/matrix42-uem-service/api/v1

Client ID

Use the ClientID as created in previous step (e.g. “Empirum”).

Client Secret

Copy and paste it from previous step.

Authorization URL

http(s)://yourempirumserver.com/Matrix42-UEM-STS/Authorize/Token

  1. Click Save.
  2. Restart Silverback (go to IIS Manager, click on the Silverback website and “Restart” in the actions menu on the right).

Configure the UEM Console with the Solutionbuilder

  1. Login to Silverback with a regular admin account.
  2. Open Admin menu > System Settings.
  3. Add front end API Client ID (solutionbuilder)

Redirect URL: http(s)://yoursilverbackserver.com/solutionbuilder/ or http(s)://localhost/solutionbuilder

  1. Add CORS URL for API

Client ID: solutionbuilder

Redirect URL: http(s)://yoursilverbackserver.com/solutionbuilder/ or http(s)://localhost/solutionbuilder


Open the UEM Console

After the installation of the UEM Service open the UEM console with the link where yoursilverbackserver is the actual name or IP address of your Silverback Server: http(s)://yoursilverbackserver.com/solutionbuilder

  • Was this article helpful?