Installing a Universal Agent System Install via the Graphical Interface

Owned by Former user (Deleted)
Last updated: Jan 03, 2023 by Stonebranch
6 min read

Installing a Universal Agent for Windows System Install via the Windows Installer Graphical Interface

To install a Universal Agent for Windows System Install via the Windows Installer graphical interface, perform the following steps:

Step 1

Download the desired Universal Agent for Windows System Install product distribution file to your work station:

  • sb-7.3.0.<level>-windows-x64.exe, the 64-bit Universal Agent for Windows System Install distribution file.

Step 2

Execute the distribution file from the command line to begin the installation process, which first determines whether a Windows Installer update is needed (see Windows Installer).
 
The process then extracts and saves a Windows installer package file (.msi) to one of these locations.

Step 3

The installation starts after the files are extracted. It first will verify that your machine meets the minimum system requirements (see Installation Requirements and Summary - Windows). If the requirements are met, a Welcome dialog displays.
 

Step 4

Click the Next button. A list of Universal Agent components included in the installation package then displays. It is from this list that you can select which components to install.
 

 
For a new installation, a drive icon displays next to each component in the list, indicating that the component will be installed.
 

Note

An X icon displays next to the Universal Controller Command Line Interface (CLI) component, indicating that, by default, it will not be installed. If you want to install the CLI, you must click the X icon and select the drive icon.

For an upgrade installation, either of the following icons displays next to an item:

  • A drive icon indicates that the component is either:
    • New to the installation and will be installed.
    • Currently is installed and will be upgraded.
  • An X icon indicates that the component is either:
    • Currently not installed (but previously was available).
    • Previously installed but removed.

A Stonebranch Tip

  • If the installation detects an existing Universal Agent installation, currently installed components may be upgraded. (Currently, there is no way to specify that the state of a currently installed component should remain unchanged.)
  • If a component is selected for installation, and the version of the installed component is less than the version of the component being installed, the installed component will be replaced by the component being installed.
  • If a component is not selected for installation (that is, the X icon is selected), and it currently is installed, the new installation will remove that component.

Step 5

The previous figure indicates that all Universal Agent components will be installed in their respective directories under the C:\Program Files\Universal directory.

  • If you want to select a different location, click the Change... button.
  • If you want to check the amount of disk space required for the installation, and the amount of available disk space on the selected directory, click the Space button.

Step 6

If you do not want to install a component:

  1. Click the drive icon next to that component name.
  2. From the drop-down list that displays, select the X icon to mark the component as one not to be installed.
    For example, the following figure indicates that Universal Connector has been selected to not be installed.
     

     

Step 7

When you have selected the components (and their installation destinations) that you want to install, click the Next> button. The Universal Broker Service Account dialog then displays.
 

 

Step 8

Select an account to use to execute the Universal Broker service:

  • Local System (This is the default for upgrades from releases prior to 4.3.0.1.)
  • An Administrative account capable of executing the Universal Broker service. (This is the default for new installs or upgrades where the Universal Broker currently is executing with an account other than Local System.)

    The user account ID defaults to UBrokerService, although any valid user name (up to 20 characters) can be specified.

    If the account does not already exist, the install will create it with the privileges necessary to execute the Universal Broker service. See Starting Universal Broker for the privileges that an account needs to run the Universal Broker service.

A default password provided for the account can be obtained by contacting Stonebranch support, although any password up to 256 characters can be specified.

  • If the user account does not exist, its password is set to the default value.
  • If the user account does exist, the installation process will validate the specified password. You must enter a valid password for the account to continue with the install.

The Broker service may also be run using a Windows domain account. The primary difference between using a local and domain account is that the domain account must already exist, and the installation will not configure it like it does a new local account. Required account privileges and file system access can be found in Service Security.
 

Note

For upgrades, if the Universal Broker service is already configured to run with a user account, the install dialog shows only the account name and omits the password fields. The Broker service's configuration in the Windows Service Control Manager is retained across upgrades, making it unnecessary to re-enter account information during an upgrade.

 

The install provides the RUNBROKERASUSER, BROKERUID, and BROKERPWD command line options to override the default behavior described above.

  • Specifying RUNBROKERASUSER=0 causes the install to select Local System, regardless of how the Broker is currently configured to execute.
  • Specifying RUNBROKERASUSER=1 causes the install to select the user account option, even if the Broker is currently configured to run as Local System.

When RUNBROKERASUSER=1, the BROKERUID and BROKERPWD command line options are provided to override the default or currently configured user ID and password. The BROKERUID option limits user IDs to 20 characters; the BROKERPWD option limits passwords to 14 characters. (See Windows Installer Command Line Parameters for more information).

Step 9

When you have selected an account, click the Next> button. The OMS Server Options dialog then displays.
 

 

Note

This dialog displays only for new Universal Agent installs and upgrades to Universal Agent from earlier releases.
 
It does not display if you selected, in Step 6, to not install Universal Message Service (OMS), or for upgrades from Universal Agent to a later version.

Step 10

Select whether or not you want the Universal Message Service (OMS) Server to start up when Universal Broker starts up and, optionally, change the OMS Server port connection (the default port, 7878, is pre-selected).

Step 11

Click the Next> button. The Automation Center Configuration dialog displays.
 

Step 12

Enter a list of OMS Servers to specify how the Agent will connect to Universal Controller.
 
If the Start the Automation Center Server Agent automatically when the Universal Broker starts field is enabled (the default), you must specify at least one OMS Server.
 
If you do not want the Agent to start automatically whenever the Universal Broker starts, deselect that field. You then do not have to specify any OMS Servers; this information can be configured after installation.
 
If you want to configure additional options for Universal Automation Center Agent (UAG), click the Advanced button. The Advanced Options dialog displays.
 

 
Configure the UAG options as desired and click the OK button.

Step 13

Click the Next> button to continue the installation process. Depending on the components selected, the installation may prompt for additional values, such as working folders for Server components. Follow the directions provided with each dialog.
 
When the installation is ready to begin, the Ready to Install dialog displays.
 

 
Click the Install button to begin the installation or click the <Back button to return to change information on any of the previous dialogs.
When the installation completes successfully, the Installation Complete dialog displays.
 

 

Step 14

Click the Finish button to exit Windows Installation.

Windows Installer Package File Locations

The Windows Installer Package file (.msi) is extracted to the following location:

Universal Agent for Windows package (64-bit)

C:\Windows\Installer\<fname>.msi

In this path:

<fname> is a file name generated by Windows Installer and uniquely identifies the .msi file cached to C:\Windows\Installer.

 For example: 44d82d08.msi.

Note

To easily locate the .msi file cached for the Universal Agent installation in Windows Explorer, view the contents of the C:\Windows\Installer folder in Details mode and add the "Subject" column to the display.