SPIRIT WIC EBT Middleware (SWEM) Installation Guide

The following information is to assist in the installation of the SWEM Middleware product.

SWEM Installation Prerequisites

In order to host a SPIRIT WIC EBT Middleware (SWEM) installation, the tools listed below must be installed and configured prior to installing any of the SWEM software. This is a one-time setup and is not require for future SWEM updates.

PowerShell 3.0

PowerShell 3 is installed on Windows Server 2012 by default, but older servers that have not been updated to support PowerShell 3.0 will require likely require updates. To check to see if an update is needed, open PowerShell and execute the $PSVersionTable.PSVersion command. If there is an error, no response, or a response indicating the Major version is 2 or lower, then an update is needed. If the response indicates 3 or higher, then move on to step 2.

These updates are part of the Windows Management Framework 3.0 and can be downloaded from Microsoft at the following address: http://www.microsoft.com/en-us/download/details.aspx?id=34595

Upon clicking the download button, a further prompt will request which downloads are desired. Select both updates that apply to the hardware for the instance (either x86 or x64). Once downloaded run the Windows 6.0-KB2506146 file first. If this patch is not needed it will not be applied. Next run the Windows 6.1-KB2506143 package. Again, if this patch is not needed, it will not be applied.

Once these patches have been installed, PowerShell 3.0 should be installed.

Internet Information Services (IIS) (Optional: for SWEM Admin Console)

Internet Information Services (IIS) is part of Microsoft Windows, and should be installed via Programs and Features in the Windows Control Panel, or the Server Manager.

NOTE: If this is being installed on a server that hosts the SPIRIT software, this feature is likely already enabled.

.NET Framework 4.5.2

SWEM is built on the latest version of the .NET Framework, and this version of the .NET Framework is required for SWEM. It can be downloaded from Microsoft at the following address: http://www.microsoft.com/en-us/download/details.aspx?id=42642 Use this offline installer to install the full .NET Framework 4.5.2 to the SWEM hosting server.

Windows 8 - 10, or Windows Server 2012 - 2016 Considerations

Changes to how certain functionality works in these newer operating systems will not allow the next step to install MSMQ properly. For these operating system versions, it is necessary to install MSMQ from the Programs and Features function in the Windows Control Panel. Once installed, proceed to the next step.

NServiceBus Components

SWEM is built using the NServiceBus architecture. This allows the communication between the components involved in SWEM. This is involves a couple of relatively simple processes.

Particular Service Control

Service control is an important part of the NServiceBus suite, and is required for NServiceBus applications to run. This can be acquired by download from the following address: https://github.com/Particular/ServiceControl/releases/download/1.4.0/Particular.ServiceControl-1.4.0.exe Once downloaded, proceed to install accepting the default installation settings. This completes the prerequisite setup for SWEM. The machine should now be ready to host the SWEM software.

Installing SWEM Components

The SPIRIT WIC EBT Middleware (SWEM) components include two required, and two optional components. The components can live on the same server, or they can be installed with a single component per server. Regardless of the hardware topology, the required components must both be installed on one or more boxes and communicating before the system is functional. Before proceeding with the installation, see the topics referenced below to learn about the required and non-required components and how to use the installer. Understanding the concepts in the topic(s) below will make any decision required during the installation process easier to make.

SWEM Installation Component Descriptions

The following is a breakdown of each of the components of the system, explaining their purpose in the overall component architecture. NOTE: In the content below, denotes the component is included in a Typical Installation*

SWEM MIS Endpoint Host (required) *

The MIS Endpoint host provides the connection to which SPIRIT will attach. During database setup, SPIRIT will have an update to the EBTCONNECTIONINFO field pointing to this client endpoint.

SWEM Processor Host (required) *

The Processor host is a second endpoint which provides the connectivity mechanism between the Endpoint Host and the EBT server. A configuration change on the Endpoint Host points it to the processor host, and the processor host has a configuration element that tells it the address for the EBT Processor with which it communicates.

SWEM Developer Tools

These were designed for Quality Assurance and Development teams to be able to build and send messages outside of the SPIRIT environment. It should NEVER be included as part of a production SPIRIT installation, but can be very useful in test environments.

SWEM Administrative Website *

This component provides access, via a web browser, to access the SWEM logs that are stored in the database. This includes access to the raw messages that are sent to and from SPIRIT, as well as those that are sent to and from the EBT Host Processor.