...
Package | Distribution File | Required |
|---|---|---|
Universal Agent (system installation) |
| Yes |
Universal Agent (user mode installation) |
| No |
| No | |
| No | |
| No |
...
There are two installation methods available for Universal Agent for Windows packages:
- The first is a traditional Windows Installer-based installation, referred to here as a system installation.
- The second is referred to as a user mode installation, which is a lightweight, fully-functional install that allows multiple Universal Agents to reside on a single system.
Detailed information for each method can be found on the following pages.
| Anchor | ||||
|---|---|---|---|---|
|
The system installation method uses a traditional Windows Installer-based package. This installation method "assumes" that it is the only Universal Agent instance on a system, and has the following distinguishing characteristics:
- The application is listed in Programs and Features, under the Windows Control Panel.
- Application files default to traditional install locations (for example, C:\Program Files).
- Universal Manager and Utility components are installed in the Windows System32 directory.
- Configuration and component definition files reside in in common, well-known locations (for example, C:\ProgramData).
- The installation contains the logic necessary to create a new account for running the Universal Broker service.
- The Universal Broker service name is not configurable. Its display name is
Universal Broker, its registered service name isUBrokerService, and its Application event log message source isubroker. - The install contains logic to support upgrades from any prior release.
- Removal requires a proper Uninstall, via the Windows Control Panel.
- The installation is compatible with enterprise deployment tools (for example, SMS).
- The installation may install system libraries that the Universal Agent requires.
- The installation can automatically configure the Agent to simplify integration with other Stonebranch applications.
...
The user mode install is a lightweight installation method that results in a fully-functional Universal Agent, minus the Windows integration features that the system install offers. However, this install method permits several Universal Agents to reside on a single system, whereas the system install is limited to a single instance.
A user mode install can reside on a system that already has a system install, but an existing system install is not required.
A user mode install has the following distinguishing characteristics:
| Note | ||
|---|---|---|
| ||
A user mode install does not provide any required system libraries. All prerequisites must exist to run the Universal Agent in user mode. If the install cannot find the appropriate Microsoft Visual C++ Runtime and the Microsoft Universal C Runtime, the install will fail with an error. |
Pre-Installation Guidelines
...
Before starting the Universal Agent for Windows system installation, it is recommended that you close all other Windows programs. Active programs may be using system files that the Universal Agent installation may update.
...
| Note | ||
|---|---|---|
| ||
Additionally, some Universal Agent components may rely on vendor-supplied resources whose runtime dependencies are not known to the Agent before execution. One such component is the Universal Connector for SAP (USAP), which relies on libraries provided by SAP. If the runtime dependencies for those libraries are not available on your Agent system, attempts to run USAP will fail. Where such dependencies exist, use information provided by the vendor to determine runtime requirements. For example, to review runtime requirements for the NetWeaver RFC SDK version 750, refer to the information on this page. |
Installation Path
The default installation path for most packages is:
- "
C:\Program Files"
For the remaining 32-bit packages, the default installation path is:
- "
C:\Program Files (x86)"
Installation Summary
Step 1 | Download the distribution file from the Stonebranch Customer Portal. |
|---|---|
Step 2 | Log on to Windows using an Administrative account or an account that can be elevated to Administrative authority. |
Step 3 | Exit all running programs to reduce the likelihood of a reboot. |
Step 4 | Execute the installation file. |
Step 5 | Follow installation instructions: |
| Anchor | ||||
|---|---|---|---|---|
|
The user mode install is a lightweight installation method that results in a fully-functional Universal Agent, minus the Windows integration features that the system install offers. However, this install method permits several Universal Agents to reside on a single system, whereas the system install is limited to a single instance.
A user mode install can reside on a system that already has a system install, but an existing system install is not required.
A user mode install has the following distinguishing characteristics:
- Application files can reside in any location.
- Resources that the Agent requires, such as configuration and component definition files, reside under the install location.
- Universal Manager and Utility components also reside under the install directory, in the
.\Sys32\binfolder. To ensure that Managers and Utilities register with the correct local Broker, theSB_ConfigSetup.bat> script is provided to properly configure the environment. - By default, a user mode install provides a single working directory for Universal Server components,
.\UAHome. A user mode install can still use separate directories for each Server component (as is done for the system install), but doing so requires post-install updates to configuration and component definition files. - A user mode install can configure the Universal Broker service to run as an Administrative user account, but that account must already exist.
- The Universal Broker service name is configurable, and must be unique. The install creates the service and registers its Application event log as the service's display name.
- A user mode install contains no upgrade logic. Consequently, all user mode installs should be installed in "clean" locations.
- The user mode install does not create an entry in Programs and Features. To remove a user mode install, see Removing a Universal Agent User Mode Install.
| Note | ||
|---|---|---|
| ||
A user mode install does not provide any required system libraries. All prerequisites must exist to run the Universal Agent in user mode. If the install cannot find the appropriate Microsoft Visual C++ Runtime and the Microsoft Universal C Runtime, the install will fail with an error. |
Pre-Installation Guidelines
User mode installations do not update shared system files, so it is not necessary to close all other applications first. However, we do suggest that you close the Windows Services application and the Windows Event Viewer, if open. A user mode installation will create the Universal Broker service and register its message catalog as an Application event log message source. File contention/sharing issues may occur if the Services and/or Event Viewer is open during Universal Broker service creation and configuration.
...
| Note | ||
|---|---|---|
| ||
Additionally, some Universal Agent components may rely on vendor-supplied resources whose runtime dependencies are not known to the Agent before execution. One such component is the Universal Connector for SAP (USAP), which relies on libraries provided by SAP. If the runtime dependencies for those libraries are not available on your Agent system, attempts to run USAP will fail. Where such dependencies exist, use information provided by the vendor to determine runtime requirements. For example, to review runtime requirements for the NetWeaver RFC SDK version 750, refer to the information on this page. |
Installation
...
System Installation
The default installation path for most packages is:
- "
C:\Program Files"
For the remaining 32-bit packages, the default installation path is:
- "
C:\Program Files (x86)"
...
Path
The default installation path for user mode installs is %TEMP%\universal. However, you can install to any location.
Installation Summary
...
System Installation
...
Step 1
...
Download the distribution file from the Stonebranch Customer Portal.
...
Step 2
...
Log on to Windows using an Administrative account or an account that can be elevated to Administrative authority.
...
Step 3
...
Exit all running programs to reduce the likelihood of a reboot.
...
Step 4
...
Execute the installation file.
...
Step 5
...
Follow installation instructions:
- Installing a Universal Agent System Install via the Graphical Interface
- Installing a Universal Agent System Install via the Command Line Interface
...
Step 1 | Download the distribution file from the Stonebranch Customer Portal. |
|---|---|
Step 2 | Close the Windows Services application and the Windows Event Viewer. |
Step 3 | Execute the installation file, providing elevated credentials when/if asked to do so. |
Step 4 | Follow the instructions for your desired installation method: |
...