One moment please...
 
Exact Synergy Enterprise   
 

How-to: Update Exact Lightweight Integration Server (ELIS) using silent mode

Introduction

Exact Lightweight Integration Server (ELIS) is a composite solution to host external solutions and works with different versions of Exact Synergy Enterprise (ESE) and Exact Globe Next (EGN) or Exact Globe+.

Scope

This document describes the silent mode option for upgrading ELIS and the management console component installation. This document also describes the method to silently update the configurations of ELIS (such as products, clients, solutions, and activations). The silent mode option allows the ELIS update process to be scheduled using Windows Task Scheduler or automated using external tools. For more information on ELIS, see Getting started with Exact Lightweight Integration Server (ELIS).

Note: By using the silent mode option, you are implicitly accepting the End-User License Agreement.

Pre-requisites

You must have ELIS already installed using an earlier version of the ELIS MSI (available in the cab folder in the ESE and Exact Globe+ installation folders). For more information on first time installation of ELIS, see How-to: Installing Exact Lightweight Integration Server (ELIS).

A previously installed ELIS may already be configured to work with different clients. Before you update ELIS, you must update these clients to the release and service pack you want. For more information on updating clients for ESE or Exact Globe+, see Exact Synergy Enterprise: Installation manual.

The user needs the below information for updating ELIS:

  • Windows credential (username and password).
    • Access rights to run Microsoft Window Services.
    • Access rights to the Microsoft SQL Server database using the Microsoft Windows authentication.
    • User name must be in the [Domain/Machine name]\[Username] format. For example, Exact.com\Administrator.
    • Access rights to read and write from the location where ELIS is installed.
  • The name of the machine where ELIS is installed and running.

Do the update when there are no pending synchronisations to avoid interruption or version conflict. Once the process is completed, it is recommended to restart the entity and related services of all the products (ELIS, ESE, and Exact Globe+).

To use the silent mode option, you must also have administrator access to execute the Windows command "msiexec". For more information, see msiexec | Microsoft Learn.

Description

Updating ELIS using silent mode

Note: There are two versions of ELIS MSI available in the cab folder in the ESE installation folder. Use Exact Integration Server x86 for a 32-bit operating system and Exact Integration Server x64 for a 64-bit operating system. You have to use the same version of the MSI as your operating system. You can install the 32-bit version of ELIS on the 64-bit operating system but you cannot install the 64-bit version of ELIS on the 32-bit operating system.

To update ELIS using silent mode, launch the MSI with the msiexec command and silent mode parameters.

Below are the command and parameters that are used:

start

This is the Windows prompt command to execute a specified program or command. For more information, see start | Microsoft Learn.

/wait

This is a parameter for the start command to execute the program and wait for it to end. It is recommended to use this parameter so the control will be returned to the command when the process is complete.

/i

This parameter passes the Cmd.exe startup environment to the new Command Prompt window. If /i is not defined, the current environment is used.

/quiet

This parameter specifies the quiet mode for the MSI execution whereby user interaction is not required.

/lv

This parameter turns on the logging for the MSI execution and includes the verbose output in the output log file. Specify the log file name and path where the log file will be stored.

SVCACCUSERNAME

Use this parameter to specify the username of the Windows credentials that will run the ELIS service.

SVCACCPASSWORD

Use this parameter to specify the password of the Windows credentials that will run the ELIS service.

Below is the syntax to update ELIS in silent mode:

start /wait msiexec.exe /i "[ELIS MSI path and filename]" /quiet SVCACCUSERNAME=[ELIS service username] SVCACCPASSWORD=[ELIS service username] /l*v [Log file name and path]

For example, a full command line following the syntax results in:

start /wait msiexec.exe /i "C:\Program Files (x86)\Synergy\cab\Exact Integration Server x64.msi" /quiet SVCACCUSERNAME=exact-software\test53123 SVCACCPASSWORD=myP@ssW0rd#2 /l*v C:\LogFile.txt

To update ELIS in silent mode, do the following on the machine where ELIS is already installed:

  • Launch command prompt using the Run as Administrator mode.

  • Optional: Change the working path to where the ELIS MSI is located. For example, the cab folder in the ESE installation. Otherwise, the command line should have the full path to the ELIS MSI.

  • Execute the command line with the values below:

    • ELIS MSI filename. Select the MSI based on the operation system environment (32-bit or 64-bit). Include the full path if the current working directory does not have the file.

    • SVCACCUSERNAME. The user name must be in the [Domain/Machine name]\[Username] format. For example, Exact.com\Administrator.

    • SVCACCPASSWORD. The password for the user to run the ELIS services.

  • Optional: Log file path and filename. Define this if you are using the /l*v parameter for verbose logging.

Note: If the ELIS version installed is the same as (or newer than) the MSI version, the ELIS update process will be skipped.

Once ELIS is updated successfully, you can check the ELIS services at Control panel > Administrative Tools > Services to ensure the services are installed successfully and running. Look for the services that start with Exact Integration.

Updating ELIS configuration using silent mode

Once ELIS is updated successfully, you can use the ELIS configuration updater (Exact.Integration.Updater.exe) to update the configuration.

To update the ELIS configuration using silent mode, launch the Exact.Integration.Updater.exe executable file with the required parameters. The file is in the bin folder in the ELIS installation path. The command prompt should be executed as Run as administrator.

Below are the parameters:

start

This is a Windows prompt command to execute a specified program or command. For more information, see start | Microsoft Learn.

/wait

This is a parameter for the start command to execute the program and wait for it to end.

UpdatePackages

This parameter specifies the executable to update the ELIS configuration in silent mode.

/server

Use this parameter to specify the machine name where ELIS is installed and running.

/silentupdate:1

This parameter specifies the executable to update the ELIS configuration in silent mode.

Below is the syntax to update the ELIS configuration in silent mode:

start /wait Exact.Integration.Updater.exe UpdatePackages /server:[ELIS machine name] /silentupdate:1

For example, a full command line following the syntax results in:

Exact.Integration.Updater.exe UpdatePackages /server:localhost /silentupdate:1

Once the ELIS configuration is successfully updated, you can check Event Viewer at Control panel > Administrative Tools > Event Viewer > Windows Logs > Application. Search for logs under the source Exact Lightweight Integration Server Updater (silent). You can also use the ELIS console to verify that the configurations have been updated.

Check if the following actions have been completed:

  • Newer product packages downloaded and installed.

  • Clients refreshed.

  • Newer solution packages downloaded.

  • Solution activations updated (if newer solution packages are downloaded).

Note: It is possible the update of the ELIS configuration in silent mode is not 100% successful. As mentioned earlier, you are recommended to check the update after it has been completed. The process may have been interrupted and incomplete. Sometimes user input or resolution is required.

Updating ELIS and configuration (together) using silent mode

You can also update ELIS and ELIS configurations in silent mode in a single process if ELIS MSI is a newer version than the installed ELIS.

To update both ELIS and ELIS configuration in silent mode, use the command and parameters below:

start

This is a Windows prompt command to execute a specified program or command. For more information, see start | Microsoft Learn.

/wait

This is a parameter for the start command to execute the program and wait for it to end.

/i

This parameter passes the Cmd.exe startup environment to the new Command Prompt window. If /i is not specified, the current environment is used.

/quiet

This parameter specifies quiet mode for the MSI execution whereby user interaction is not required.

/lv

This parameter turns on the logging for the MSI execution and includes verbose output in the output log file. Specify the log file name and path where the log file will be stored.

SVCACCUSERNAME

Use this parameter to specify the username of the Windows credentials that will run the ELIS service.

SVCACCPASSWORD

Use this parameter to specify the password of the Windows credentials that will run the ELIS service.

SERVER

Use this parameter to specify the machine name where ELIS is installed and running.

SILENTUPDATE=1

Use this parameter to specify the update of the ELIS configuration in silent mode that will be executed after the ELIS installation is updated.

The syntax below is to update the ELIS configuration in silent mode:

start /wait msiexec.exe /i "[ELIS MSI path and filename]" /quiet SVCACCUSERNAME=[ELIS service username] SVCACCPASSWORD=[ELIS service username] SERVER=[ELIS machine name] SILENTUPDATE=1 /l*v [Log file name and path]

For example, a full command line following the syntax results in:

start /wait msiexec.exe /i "C:\Program Files (x86)\Synergy\cab\Exact Integration Server x64.msi" /quiet SVCACCUSERNAME=exact-software\test53123 SVCACCPASSWORD=myP@ssW0rd#2 SERVER=localhost SILENTUPDATE=1 /l*v C:\LogFile.txt

Note: If the version of ELIS installed is the same as (or newer than) the version of the MSI, both ELIS and the configuration will not be updated.

Once ELIS is updated successfully, you can check the ELIS services to ensure the services are installed successfully and running at Control panel > Administrative Tools > Services. Look for the services that start with Exact Integration.

To check the ELIS configuration update process, you can check Event Viewer at Control panel > Administrative Tools > Event Viewer > Windows Logs > Application under the source Exact Lightweight Integration Server Updater (silent). You can also use the ELIS console to verify that the configurations are up to date.

Updating ELIS configuration using federated identity and silent mode

If the ELIS server is configured to use federated identity authentication, you must start silent mode in two separate processes.

Firstly, follow the instructions in Updating ELIS using silent mode.

Secondly, to proceed with silently updating the ELIS configurations, use the ELIS configuration updater (Exact.Integration.Updater.exe). The file is in the bin folder of the ELIS installation path. Execute the command prompt as Run as administrator.

Below are the parameters:

start

This is a Windows prompt command to execute a specified program or command. For more information, see start | Microsoft Learn.

/wait

This is a parameter for the start command to execute the program and wait for it to end.

UpdatePackages

This parameter specifies the executable to update the ELIS configuration in silent mode.

/server

Use this parameter to specify the machine name where ELIS is installed and running.

/silentupdate:1

This parameter specifies the executable to update the ELIS configuration in silent mode.

/fidOption:1

This parameter specifies that ELIS (specified by /server) has been configured to use federated identity authentication from Microsoft Entra (formerly Azure AD).

/user

Use this parameter to provide the Entra username.

/pass

Use this parameter to provide the Entra password.

/authority

Use this parameter to provide the authority value from the federated identity configuration. The value may be in the form of a URI; it is recommended to enclose the value in quotation marks (for example, /authority:"https://login.windows.net/3f30a7c5-bfd8-40d3-b795-b49ea22ccad2/").

/resource

Use this parameter to provide the resource value from the federated identity configuration. The value may be in the form of a URI; it is recommended to enclose the value in quotation marks (e.g. /resource:"https://companya.onmicrosoft.com/synergywaad/").

/clientID

Use this parameter to provide the client ID value from the federated identity configuration.

Below is the syntax to update the ELIS configuration in silent mode under federated identity authentication:

start /wait Exact.Integration.Updater.exe UpdatePackages /server:[ELIS machine name] /silentupdate:1 /fidOption:1 /user:[username] /pass: [password] /authority:"[authority]" /resource:"[resource]" /clientID:[client ID]

For example, a full command line following the syntax results in:

start /wait Exact.Integration.Updater.exe UpdatePackages /server:MYC1DSYN6951 /silentupdate:1 /fidOption:1 /user:admin@companya.onmicrosoft.com /pass:MyP@ssW0rd /authority:"https://login.windows.net/3f30a7c5-bfd8-40d3-b795-b49ea22ccad2/" /resource:"https://companya.onmicrosoft.com/synergywaad/" /clientID: 0a66ffc8-2a1a-40ae-b082-b83c07b9ad97

Once the ELIS configurations are updated successfully, you can check the ELIS services to ensure the services are installed successfully and running at Control panel > Administrative Tools > Services. Look for the services that start with Exact Integration.

To check the ELIS configuration update process, you can check Event Viewer at Control panel > Administrative Tools > Event Viewer > Windows Logs > Application. Look for logs under the source Exact Lightweight Integration Server Updater (silent). You can also use the ELIS console to verify that the configurations are up to date.

Additional information

Use the /l*v parameter for verbose logging

A part of the update process for ELIS uses the MSI installation that is facilitated through the Windows service msiexec.exe. This process is limited to the features and parameters that is supported by Microsoft. For example, errors that occur during this part of the installation can only be logged using verbose logging (/l*v parameter) and will need to be resolved before re-installing.

Ensure password credentials are up to date

All passwords should be valid and up to date when starting the update process. Because the ELIS update process uses a few different types of credentials, for example, the Windows user password for ELIS services such as SVCPASSWORD or the client product password such as Exact Purchase to Pay endpoints. Any expired or wrong passwords can prevent the update process from being completed successfully.

Known issue: It is not possible to perform silent update for clients which require user interaction

Some endpoints require user interaction to enter the username and password every time it is refreshed. For example, connecting to Exact Payroll Plus clients will display a login prompt. For these clients, it is not possible to perform the silent process. Instead, a message is logged in the Event Viewer.

Not supported: Migration from EGN to Exact Globe+

From the ELIS console, it is possible to upgrade EGN clients to Exact Globe+ clients. However, this is not part of the standard update process and it is not supported in silent mode. The migration update must be done manually.

     
 Main Category: Attachments & notes  Document Type: Online help main
 Category:  Security  level: All - 0
 Sub category:  Document ID: 31.848.250
 Assortment:  Date: 18-03-2024
 Release:  Attachment:
 Disclaimer