AMS Machine Works v2.0 System Guide
AMS Machine Works v2.0 System Guide
Rev 3
July 2025
No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any
language in any form by any means without the written permission of Emerson.
Disclaimer
This manual is provided for informational purposes. EMERSON MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS
MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. Emerson shall not be liable for errors, omissions, or inconsistencies that may be contained herein or for incidental or
consequential damages in connection with the furnishing, performance, or use of this material. Information in this document is
subject to change without notice and does not represent a commitment on the part of Emerson. The information in this manual is
not all-inclusive and cannot cover all unique situations.
Patents
The product(s) described in this manual are covered under existing and pending patents.
2
System Guide Contents
July 2025
Contents
Chapter 1 Introduction.................................................................................................................. 7
1.1 Symbols............................................................................................................................................7
1 Introduction
Software Description
AMS Machine Works is the next generation machinery condition monitoring and analysis
software from Emerson. AMS Machine Works combines state-of-the-art technology,
predictive maintenance techniques, and comprehensive vibration analysis tools to provide
clear and accurate monitoring of the condition of the machinery in your facility.
AMS Machine Works helps to improve safety and increase profitability by providing a
modern software solution capable of predicting faults before they happen and saving you
from the costs associated with unplanned downtime.
1.1 Symbols
Note
This symbol marks passages that contain important information.
CAUTION
This symbol marks operations that can lead to malfunctions or faulty measurements, but
will not damage the device.
2 System Planning
AMS Machine Works is comprised of four main types of components:
1. AMS Machine Works Components — These are the central components of the
system. See: AMS Machine Works Application Layer
2. Agent Components — Agent components provide a connection between
measurement devices and the central system components. See: Agent Layer
3. Database Components — There are two database components used with AMS
Machine Works. See: Database Components
4. Other Components — These components are installed as dependencies of the other
elements of the AMS Machine Works architecture.
See: AMS Machine Works Architecture
These components can be installed on the same server, or different servers, depending on
the deployment scenario, network requirements, and setup. See: Deployment Scenarios
Before you install any of the system components, you must plan your installation using:
the system requirements, recommended system deployment scenarios, and the
guidelines provided in this chapter. Follow the Planning Steps to plan your system
properly.
Procedure
1. Determine the data sources that you want to bring into AMS Machine Works and
check if they are compatible. See: Device Compatibility.
Depending on the type of data source, install the appropriate Agent to bring the
right data source into AMS Machine Works. See: Agent Layer .
2. Confirm the system will not exceed scalability limitations. See: System Scalability.
3. Determine your network setup and gather connection information and
authorizations.
Note
Your network setup affects the deployment of the AMS Machine Works
components. See: Deployment Scenarios. The installations have prompts for
information about the location of other services. Before you run the installation
wizard on each server, you need to have all the information about:
a. Network locations where the services will be installed.
b. Log in names and the associated passwords.
c. Connection strings.
b) Before interfacing AMS Asset Monitor devices with AMS Machine Works,
access the AMS Asset Monitor Web Interface and ensure that the device has
been fully configured.
1. An AMS Machine Works interface must be set and enabled.
2. An AMS Machine Works user must be created.
c) Before interfacing AMS 6500 ATG devices with AMS Machine Works, ensure
that the devices are configured for data collection with AMS Machine Studio.
1. An AMS 6500 ATG unit license must be installed for each CP or CC
card.
2. Modbus port must be set and enabled.
3. Collection tasks must be set on the AMS 6500 ATG unit.
d) Before interfacing with AMS 2140 Machinery Health Analyzer units, ensure
that the devices are configured to work with AMS Machine Works.
1. Your AMS 2140 Machinery Health Analyzer should have version
1.3.13.0 firmware, or later.
10. Determine if you need to read data from AMS Machine Works using an OPC UA
Server client.
Note
One part of the AMS Machine Works Core, the MongoDB measurement database, can be
installed on an External computer or virtual machine.
A. AMS Machine Works Application Layer — This layer contains web applications for data presentation,
configuration, maintenance, security, and data integration. See: AMS Machine Works Application Layer
B. AMS Machine Works Core — This layer processes the vibration data for health, alerts, aggregation, and
calculating derived measurements. Manages machine trains, monitors alerts, and assesses the health of
assets. See: AMS Machine Works Core
A. AMS Machine Works Service Layer
A. Windows Services
B. Other Components
B. Data Transport and Storage Layer
A. Database Components
B. RabbitMQ
Vibration Analyzer, also known as VibApp is a thick-client web application you can use to
VibApp. perform detailed analysis on vibration data stored in the
measurement database. It can be installed on the AMS
Machine Works Server or separately installed on any client
computer that will be used for detailed analysis of vibration
data.
Online Help The Online Help component provides information about the
operation of AMS Machine Works.
Your Account The Your Account module allows you to view basic
information about your account, choose a profile picture,
and to reset your password
1. AMS Machine Works Service Layer — This layer has specialized services and
modules for interacting with the AMS Machine Works Application Layer.
2. Data Transport and Storage Layer —
a. Data Transport — AMS Machine Works uses RabbitMQ to provide a robust
asynchronous communication between services.
b. Data Storage — AMS Machine Works uses two databases:
1. PostgreSQL — for storing configuration data.
2. MongoDB — for storing measurement data.
Note
The MongoDB can be located on an External computer or virtual
machine. See: Database Components
3. Integration and Abstraction Layer — This layer provides a stable interface between
the Agents and the various data transport and storage technologies.
Note
When components are installed on separate servers, the EmersonCSI base website
references the DefaultAppPool application pool.
Table 2-2: AMS Machine Works IIS Application Pools and Applications
Application Pool Applications
AMS_MW_DesignStudio /CTBAB
/design-studio
AMS_MW_EmersonCSI Root Application
AMS_MW_HistorianNext /HistorianNext
AMS_MW_IdSrv /CIDS
AMS_MW_MachineryHealth /CTVAB
/machinery-health
AMS_MW_NetworkDevice /network-device
/OAB
AMS_MW_OMG /OMG
AMS_MW_PAG /PAG
AMS_MW_PIG /PIG
AMS_MW_PortablesApp /PortablesApp
AMS_MW_Status /CSB
/Status
Table 2-2: AMS Machine Works IIS Application Pools and Applications (continued)
Application Pool Applications
AMS_MW_UserManager /CUMAB
/user-manager
AMS_MW_VibApp /VibApp
Note
AMS_MW_IdSrv is used to send email messages for functions such as Reset Password.
To use your own SMTP server please consult with Product Support.
Windows Services
The following Windows Services are installed on a computer for each AMS Machine Works
component.
Table 2-3: AMS Machine Works Components and Associated Windows Services
AMS Machine Works Component Windows Service Name
AMS Machine Works Asset Monitor Agent Emerson MW Asset Monitor Agent
AMS Machine Works ATG Agent Emerson MW ATG Agent
AMS Machine Works Wireless Agent Emerson MW Wireless Agent
AMS Machine Works Portables Edge Agent Emerson MW Portables Edge Agent
AMS Machine Works Emerson MW Core Data Shovel Service
Emerson MW Core License Manager
Emerson MW Core Train Service
Emerson MW Data Integration Module OPC Server
Emerson MW Online Device Service
Emerson MW Portables Agent Configuration Service
Emerson MW Portables Authorization Service
Emerson MW Portables Device Configuration Service
Emerson MW Portables Library Service
Emerson MW Portables Module Integration Service
Emerson MW Portables Route Configuration Service
Emerson MW Route Factory
Emerson MW Portables Transaction Orchestrator
Database Components
With AMS Machine Works v2.0, two types of databases are deployed:
1. A PostgreSQL 17 database for storing configuration information about the AMS
Machine Works application.
2. A MongoDB 8.0.4 2008R2Plus SSL (64 bit) database for storing measurement data.
There are three MongoDB database deployment options:
a. Single Server Deployment — The MongoDB database is on the same machine
as the AMS Machine Works software. The AMS Machine Works installer
handles the MongoDB database configuration. See: MongoDB Single Server
Deployment — Internal
b. External Server Deployment — The MongoDB database is on an external
server within the same network as the AMS Machine Works server machine.
See: MongoDB External Server Deployment
c. Cloud Server Deployment — The MongoDB database, in this case MongoDB
Atlas, is on an external server accessed through the internet. See: MongoDB
Atlas Cloud Server Deployment
You should choose an External MongoDB Server Installation when some or all of the
following conditions are met:
• Your previous installation of AMS Machine Works required either an External MongoDB
Server or an External SQL Server.
• Your network administration policies require physical or logical separation of servers.
• Your data retention policies require data storage greater than can easily be supported
on the computer acting as your AMS Machine Works server.
• When the 'XL' size of a single server no longer meets your needs. Processor and
Memory Specifications
This database contains all the AMS Machine Works configuration data in a database
named mwcore.
The software installation process deploys four MongoDB databases. The location can be
specified during installation. The default folder is:
C:\EMERSONMW\Data
Note EmersonMWOnline
Depending on your
EmersonMWPortables
configuration, your MongoDB
database can be on an external
server. See: External MongoDB
Server Installation
1 This version is provided to maintain compatibility with Windows Server 2016 systems.
For more information on different recovery models see: Backup and Restore Procedures
Other Components
An AMS Machine Works installation includes other components which are dependencies
of the system:
1. Microsoft .NET framework
a. Microsoft .NET 8.0.18 - Windows Server Hosting
b. Microsoft .NET Runtime -8.0.18 (x64)
c. Microsoft .NET Runtime -8.0.18 (x86)
d. Microsoft ASP.NET Core 8.0.18 - Shared Framework (x64)
e. Microsoft ASP.NET Core 8.0.18 - Shared Framework (x86)
f. Microsoft Windows Desktop Runtime - 8.0.18 (x64) - (When the AMS 2140
Agent is installed.)
AMS Asset Monitor Agent The AMS Asset Monitor Agent is a Windows service that
brings data into AMS Machine Works from AMS Asset
Monitor units via the Web Socket protocol.
AMS 6500 ATG Agent The AMS 6500 ATG Agent is a Windows service that brings
data into AMS Machine Works from sensors connected to
AMS 6500 ATG systems. Communications between AMS
6500 ATG units and AMS Machine Works uses two ports:
1. Modbus TCP/IP Port
AMS 2140 Agent The AMS 2140 Agent is a Windows service that brings data
into AMS Machine Works from portable AMS 2140
Machinery Health Analyzer units. Communications between
AMS 2140 units and AMS Machine Works can use either:
1. CSI USB Driver
2. Web Socket
1 If installed on a separate server, the certificate must be exported and installed on the AMS
Machine Works server.
The most common deployment scenarios are shown in network diagrams. See: Typical
Deployment Scenarios
Some scenarios are not possible or unsupported. See: Unsupported Deployment Scenarios
Note
If your organization requires a different deployment scenario that is not shown, please
contact your Emerson representative.
Figure 2-2: Single Server with Client Access from Plant LAN
Figure 2-3: Single Server with Client Access from Business WAN
When the MongoDB is created the following actions are completed by the installer:
• A MongoDB 8.0.4 2008R2Plus SSL (64 bit) database is created and configured by
default.
• A MongoDB 6.0.20 2008R2Plus SSL (64 bit) database is created and configured for
Windows Server 2016 Standard or Datacenter installations.
• The MongoDB database is configured to use port 27018.
• A MongoDB database administrator user is created.
• A MongoDB database user is created for AMS Machine Works services to use for
communicating with the MongoDB database server.
Note
Depending on the database configuration, the connection string entered during the
software installation process will have different parameters.
Network 2 x 1 GB NIC (use 2 NICs to isolate Level 3 traffic from Level 2 traffic)
(recommended)
1 x 1 GB NIC (supported)
1 External MongoDB Server requirements will scale upwards from these values as the processing requirements and storage capacity grows.
Additional specifications
CAUTION
Computers with system components installed must have:
• their system clocks synchronized.
• their date/time in the same format.
Communication can be blocked if there are system clock discrepancies. (Many third-party
tools are available to synchronize system clocks.) System clocks do not need to be
synchronized for PCs with browser-only access.
1 If your installation uses MongoDB 6.0.20 2008R2Plus SSL (64 bit) to maintain compatibility with
Windows Server 2016 systems, the filepath will be: C:\Program Files\MongoDB
\Server\6.0\bin\*
Server Specifications
Concurrent users 15
Devices1
400 AMS Asset Monitors maximum per system and per AMS Asset
AMS Asset Monitor
Monitor Agent
OPC UA
2. 22 Channels
3 Based on testing with 400 devices connected to a Dual Antenna 1410S Emerson Wireless
Gateway in the following configuration:
1. Antenna One: AMS Wireless Vibration Monitor — 155 units, AMS 9420 — 45 units
2. Antenna Two: AMS Wireless Vibration Monitor — 189 units, AMS 9420 — 11 units
Collection Schedules as tested:
1. AMS Wireless Vibration Monitor: Scalars 144 times/day, Spectra 4 times/day, Thumbnails 4
times/day, Waveforms 1/day.
2. AMS 9420: Scalars 3 times/day, Energy Bands 3 times/day, Burst Variables 144 times/day,
Waveforms & Spectra 1 time/day.
1 Minimum
2 Recommended
Table 2-8: Processor specifications for system profiles with an AMS Asset Monitor
Agent Server
System AMS Machine Works Server AMS Asset Monitor Agent Server
Profile
Processor Cores RAM Processors Core RAM
(minimum) (minimum)
Small (S) 2.4 GHz 6 16 GB 2.4 GHz 4 16 GB
Medium 3.2 GHz 8 32 GB 2.4 GHz 4 16 GB
(M)
Large (L) 3.2 GHz 8 32 GB 2.4 GHz 4 16 GB
Table 2-9: Processor specifications for system profiles with an AMS 6500 ATG Agent
Server
System AMS Machine Works Server AMS 6500 ATG Agent Server
Profile
Processor Cores RAM Processors Cores RAM
(minimum) (minimum)
Small (S) 2.4 GHz 6 16 GB 2.4 GHz 4 16 GB
Medium 2.4 GHz 6 32 GB 2.4 GHz 4 16 GB
(M)
Large (L) 3.2 GHz 8 32 GB 2.4 GHz 41 16 GB
62
Extra Large 3.2 GHz 8 32 GB 2.4 GHz 413 16 GB
(XL) 64 GB2 62
1 Minimum
2 Recommended
3 Minimum
Note
The tables in this section assume a distributed deployment, which has 2 servers, one for
AMS Machine Works, and one for an External MongoDB server. See: MongoDB Database
Deployments
Note
• One AMS Asset Monitor Agent Server can support up to 400 AMS Asset Monitors.
• One AMS Asset Monitor has a maximum of 12 vibration CHARMs.
• One vibration CHARM constitutes one vibration tag, including installed spare CHARMs.
• The maximum number of AMS Asset Monitors supported in AMS Machine Works is
400.
Table 2-11: Number of AMS Wireless Vibration Monitors and Vibration Tag Consumption by System
Profile (continued)
System Profile AMS Wireless Vibration Vibration Tag Emerson Wireless
Monitors Consumption Gateway Agent Servers
Extra Large (XL) 2401-5000 7203-15000 11
1 More Emerson Wireless Gateway Agent Servers might be required to meet network topology requirements such as
devices being located in separate locations with their own local networks.
Note
• One AMS Wireless Vibration Monitor uses three vibration tags, one per axis.
• The maximum number of AMS Wireless Vibration Monitors supported in AMS Machine
Works is 5000.
Table 2-12: Emerson Wireless Gateway Agent Servers required per amount of AMS 9420 Units
System Profile AMS 9420s Vibration tags (maximum) Emerson Wireless
Gateway Agent Servers
Small (S) 0-600 1200 1
Note
• One Emerson Wireless Gateway Agent server can accommodate connections to up to
600 AMS 9420 units.
• One AMS 9420 constitutes a maximum of two vibration tags, one per sensor.
• The maximum number of AMS 9420s supported in AMS Machine Works is 600.
2. 22 Channels
2 Assuming:
1. 11 Universal Measurement Cards
2. 22 Channels
3 More AMS 6500 ATG Agent Servers might be required to meet network topology requirements such as devices being
located in separate locations with their own local networks.
AMS 2140
AMS Machine Works does not have a technical limit for the number of AMS 2140 Agent
servers, but our recommend maximum is 10. The number of AMS 2140 Agents is set by
the network topology requirements.
Table 2-19: Long term storage capacity requirements for AMS Asset Monitor
System Profile AMS Asset Monitor Data Storage
1-3 Years 3-5 Years 5-10 Years
Small (S) <81 1.0 TB 2.5 TB 5.0 TB
Medium (M) 81-160 2.5 TB 4.0 TB 7.5 TB
Large (L) 161-300 4.0 TB 6.4 TB 12.0 TB
Extra Large (XL) 301-400 5.0 TB 8.0 TB 15.0 TB
Table 2-20: Long term storage capacity requirements for AMS 6500 ATG
System Profile AMS 6500 ATG1 Data Storage
1-3 Years 3-5 Years 5-10 Years
Small (S) 1-5 0.5 - 1.5 TB 1.5 - 2.5 TB 2.5 - 5.0 TB
Medium (M) 6-20 2.0 - 6.0 TB 6.0 - 10 TB 10 - 20 TB
Table 2-20: Long term storage capacity requirements for AMS 6500 ATG (continued)
System Profile AMS 6500 ATG1 Data Storage
1-3 Years 3-5 Years 5-10 Years
Large (L) 21-50 2.5 - 7.5 TB 7.5 - 12.5 TB 12.5 - 25 TB
Extra Large (XL) 51-100 5.0 - 15.0 TB 15.0 - 25 TB 25.0 - 50.0 TB
Table 2-21: Long term storage capacity requirements for AMS 2140
System Profile AMS 2140 Data Storage
1-3 Years 3-5 Years 5-10 Years
Small (S) 1.0 TB 2.5 TB 5.0 TB
Medium (M) 2.5 TB 4.0 TB 7.5 TB
Large (L) 4.0 TB 6.4 TB 12.0 TB
Extra Large (XL) 5.0 TB 8.0 TB 15.0 TB
1 Using the fastest rate should only be used with a single AMS Asset Monitor at a time.
1 Applies to all the applicable measurements across all channels per device. For example, for
spectra, it will be all available spectra (X, Y, Z) per channel.
2 Use only with a maximum of 200 devices, and never more than 10 devices from the same
gateway.
3 The rate is set when the device is discovered, but the values listed here are the factory defaults for
this type of device. These can be modified with the AMS Device Manager.
4 With AMS Machine Works, setting an update rate for scalars of over an hour is only possible by
using the AMS Device Manager to modify the device directly. (Slowest: 22 hours)
5 Not recommended. Depending on your network reliability and speed, there may be some gaps in
data collection. Only use this setting temporarily, and only when absolutely required.
1 Applies to all the applicable measurements across all channels per device.
2 Use only with a maximum of 60 devices, and never more than 10 devices from the same
gateway.
3 Not recommended. Depending on your network reliability and speed, there may be some gaps in
data collection. Only use this setting temporarily, and only when absolutely required.
4 Scalars are published at rate which is stored in the device. This rate can be set by the AMS
Machine Works software.
5 In most cases Scalar collection contains the same parameters as Burst Variables collection and
can be kept disabled. However, some older firmware versions of an AMS 9420 may not publish
all scalar parameters. In that case, the remaining parameters can be collected using Scalar
collection with an appropriate schedule.
2.4.3 Compatibility
AMS Machine Works supports interactions between a wide range of devices, agents,
Emerson software and hardware, and 3rd party software.
Device Compatibility
This version of AMS Machine Works supports the following types of devices with specific
versions of firmware.
AMS AMS Optics AMS AMS Device DeltaV Ovation Plantweb Insight
Machine Machinery Manager
Works Manager
Application
Component
s
AMS ✔ X X X ✔ N/A
Machine Both can not Only on
Works Server be installed Approved
on the same Architecture.
server.
Emerson ✔ X X ✔ N/A N/A
Wireless Both can not Can be
Gateway be installed installed on a
Agent on the same DeltaV
server. Application
Station.
AMS Asset ✔ X X X N/A N/A
Monitor Both can not
Agent be installed
on the same
server.
AMS 6500 ✔ X X X N/A N/A
ATG Agent Both can not
be installed
on the same
server.
AMS ✔ X X X N/A N/A
Portables Both can not
Agent be installed
on the same
server.
3 Installation Procedures
AMS Machine Works is a modular system which can be installed on a single server, or
distributed across various network topologies. See: Typical Deployment Scenarios
For more information on unsupported scenarios refer to Unsupported Deployment
Scenarios. If a scenario you are looking for is not listed in that section, work with your
Emerson representative to review your preferred deployment scenario and determine if it
is possible.
Note
There is a migration path from AMS Machine Works v1.8 to AMS Machine Works v2.0. See:
Update from v1.8 to v2.0
3. Post-Installation Steps — These are the steps that you must follow to properly start,
register, and initially configure your AMS Machine Works server.
Prerequisites
Design and plan your system. See: Planning Steps.
Procedure
1. (Optional) If you are using an External MongoDB Server, ensure that you have
administrator privileges on that machine.
a) Perform your External MongoDB Server Installation BEFORE installing the
AMS Machine Works Server.
b) Import the public key certificate from the External MongoDB Server, and
install it.
2. (Optional) If you are using External Agent Servers, ensure that you have
administrator privileges on all the machines.
Note
Perform your Agent Server Installation AFTER installing the AMS Machine Works
Server.
Procedure
1. Server names:
The server names for the AMS Machine Works Server and any associated AMS
Machine Works Agent Server(s) must meet the following criteria:
• It must be at least 1 character, but not more than 14.
• It cannot contain any of the following characters:
— backslash \
— slash mark /
— colon :
— asterisk *
— question mark ?
— quotation mark "
— less than sign <
— greater than sign >
— vertical bar |
— underscores _
— comma ,
— tilde ∼
— semicolon ;
— exclamation mark !
— at sign @
— number sign #
— dollar sign $
— percent %
— caret ^
— ampersand &
— apostrophe '
— period .
— parentheses ( )
— braces { }
— white space ( blank )
2. Check the Properties for all the drives you intend to install any element of AMS
Machine Works on. These drives cannot have the Compress this drive to save
space option checked.
CAUTION
AMS Machine Works does not support installations on compressed drives.
CAUTION
If you have multiple servers, make sure all the times and time-zones match.
.
4. Administrator Account:
Make sure that the user account being used for installation is an Administrator on
every server associated with this AMS Machine Works installation.
a. AMS Machine Works Server
b. MongoDB Server — (Optional) Only necessary if you are using an External
MongoDB Server.
c. AMS Machine Works Agent Server(s) — (Optional) Only necessary if you are
using External Agent Server(s).
To check the user, select Computer Management → Local Users and Groups →
Groups → Administrators.
Verify that the user performing this installation is a member of this group.
Note
Alternatively, the user can be added to a Domain Group which is part of the
Administrators Group. If you are unsure, check with your Network Administrator.
5. Group Policies:
a) Open the Local Group Policy Editor and select: Local Computer Policy →
Computer Configuration → Windows Settings → Security Settings →
Local Policies → User Rights Assignment
b) Ensure that the user has the following rights:
1. Backup files and directories
2. Debug programs
3. Manage auditing and security log
6. Hardware Details:
a) Open System Information → System Summary:
b) Check Processor, and confirm that the number of Processors and Cores
meets the minimum requirements for your installation size.
Note
If you have multiple processors the cores will be added together.
c) Check Installed Physical Memory (RAM), and confirm that the amount
meets the minimum requirements for your installation size.
7. Choose a Default Web Browser. Select System Settings → Default apps → Web
browser
• Google Chrome
• Microsoft Edge
CAUTION
Only Google Chrome and Microsoft Edge are supported. Use of other browsers
may have unknown effects.
updates, Emmerson recommends that you first check for updates and apply them before
installing AMS Machine Works.
Prerequisites
Determine if your IT department allows automatic updates to be temporarily disabled.
Procedure
1. Make a list of the update services you plan to stop.
2. Use the update services prior to stopping them.
3. Verify that your system is stable.
4. Stop every update service that you can.
Make a Stopped Update Services List of the update services that you were able to
pause. You will use this list after the installation is complete in the post-installation
step Restart Automatic Updates.
Postrequisites
Proceed to Locate the Installer.
Procedure
1. Log into the server you want to install AMS Machine Works on with an
Administrator account.
2. Find your installation package from local media or online:
• Locate the installer on some local device.
• Locate the correct version in your Guardian account at: https://
guardian.emerson.com/
CAUTION
You must keep the installer package that you used to install AMS Machine Works,
because you must use this exact version of the installer to Uninstall or Modify your
installation.
3. Before extracting, right-click on the file and select Properties. Check the Unblock
checkbox, and click Apply.
4. Extract the AMS Machine Works installation files to a top level folder.
CAUTION
Long file path names can result in errors during installation. (Max length: 256
characters)
Need help?
A Blocked file will usually result in an error.
To recover from this error, delete the extracted folder, Unblock the file, and re-
extract the installation files as shown in the previous step.
Procedure
1. (Optional) If your system will use an External MongoDB Server you must perform
this installation first. External MongoDB Server Installation
2. Launch Installer
3. Software License Agreement
4. Choose AMS Machine Works Server Installation
5. Enter a Server Name
6. Choose Internal vs. External MongoDB Server
7. Provide Passwords or Connection String
8. Choose the Installation Drive
9. Select which Agents to Install
10. Confirm Installation
11. Complete the Reboot Cycle
Prerequisites
Complete all the Pre-Installation Steps.
CAUTION
Run setup.exe from a folder close to the root of your file system. Long path names can
result in the installer failing.
CAUTION
It is strongly recommended that you pause Windows Automatic Updates during the
installation process. Failure to do so may lead to inconsistent results. See: Stop Automatic
Updates
Procedure
1. Right-click on setup.exe, and click Run as administrator.
a) If the User Access Control window appears, click Yes to allow setup.exe to
install.
b) AMS Machine Works uses port 80 and port 443 by default. If these ports are
in use you must configure different ports. See: Network Port Availability
Figure 3-8: Warnings: AMS Machine Works Web Services Ports in Use
Procedure
1. Read the Software License Agreement.
2. (Optional) Click Print to print a copy of the Software License Agreement for your
records.
3. Click the checkbox next to I accept the terms of the license agreement.
Postrequisites
Depending on which scenario you are using, the next step to this is either:
1. (Scenario One) When performing an AMS Machine Works Server installation:
Choose AMS Machine Works Server Installation
2. (Scenario Two) When performing an Agent Server installation: Choose Agent Server
Installation
Prerequisites
You must complete the previous step: Software License Agreement
Procedure
1. Select AMS Machine Works Server for a new installation, then click Next to
continue.
Prerequisites
You must complete the previous step: Choose AMS Machine Works Server Installation
Procedure
1. (Default: Automatically filled with your computer's name.) Enter a name for your
AMS Machine Works Server.
2. Click Next to continue to the next step: Choose Internal vs. External MongoDB
Server
Prerequisites
Attention
When you choose an External MongoDB installation, the External MongoDB Server
Installation must be complete before proceeding to the next step.
Procedure
1. (Internal Scenario) (Default) Select Internal to proceed with the default
configuration and install the MongoDB on the same server as AMS Machine Works.
3. Click Next to proceed to the next step, Provide Passwords or Connection String.
Postrequisites
Attention
When you choose an External MongoDB installation, the External MongoDB Server
Installation must be complete before proceeding to the next step.
Prerequisites
You must complete the previous step, Choose Internal vs. External MongoDB Server,
before proceeding.
Procedure
1. (Internal MongoDB Scenario) Enter the passwords you need for the two Internal
MongoDB accounts, admin, and mwservice.
CAUTION
All MongoDB passwords:
a. Must meet the Local Security Policy of the server.
b. Should not contain the following special characters: %, /, :, @, <blank space>
a) Enter a MongoDB password for the admin user twice, and then click Next to
continue.
b) Enter a MongoDB password for the mwservice user twice, and then click
Next to continue.
2. (External MongoDB Scenario) Enter the External MongoDB connection string. See:
External MongoDB Server Installation
a) Enter the External MongoDB connection string.
Note
The recommended connection string to the External MongoDB is through
the mwservice user configured during the External MongoDB Server
Installation process. This user only has read and write privileges configured.
In general, the connection string follows the form:
mongodb://<user>:<password>@<servername>:<port>/?
authSource=admin&tls=true
Our recommendation is:
mongodb://mwservice:<password>@<servername>:27018/?
authSource=admin&tls=true
Where:
1. <password> is the password set for the mwservice user during the
External MongoDB Server Installation.
2. <servername> is the name of the External MongoDB server.
Attention
Connection strings that specify a certificate file will not work with AMS
Machine Works. The certificate files must be installed manually. See:
External MongoDB Server Installation
Note
The connection can fail for a variety of reasons, for example:
• Server name wrong.
• Server powered down.
• No network connection.
• Wrong user name and password combination.
4. Enter the passwords you need for the two PostgreSQL database accounts postgres,
and mwservice.
CAUTION
All PostgreSQL passwords:
a. Must meet the Local Security Policy of the server.
b. Cannot contain the following special characters:
• ' <single quotation mark>
• " <double quotation mark>
b) For the user account, mwservice, enter a PostgreSQL password twice, and
then click Next to continue.
Postrequisites
Proceed to the next step, Choose the Installation Drive.
Note
For more information about the recommended disk space see: Storage Capacity
Requirements by System Profile.
Prerequisites
The step previous to this is:
Procedure
1. Select which drive to install on.
2. Click Next to continue to the next step: Select which Agents to Install
Prerequisites
The previous step is: Choose the Installation Drive
Procedure
1. Select every type of Agent which you will need to access the devices on your
network.
Note
You must install each specific type of Agent to be able to access those device types.
Note
If an option is grey, that Agent is already present on that machine.
Note
If you are performing an external Agent Server installation, you must select at least
one type of Agent to install.
Note
If you select a Portables Agent you must Install CSI USB Drivers.
2. When you are installing a Portables Agent you must specify which port to
communicate on. (Default port: 10077)
a) (Optional) If you require USB to connect to your AMS 2140 Machinery Health
Analyzer to AMS Machine Works, you must have the CSI USB Driver
installed. You must perform the following post-installation step: Install CSI
USB Drivers
Procedure
The configuration is complete, click Install to start the installation process.
Postrequisites
Once the installation process begins your machine may need to reboot several times. See:
Complete the Reboot Cycle
Prerequisites
You must complete the previous step, Confirm Installation, before the installation reboot
cycle begins.
Procedure
1. The installer has been fully configured, and is ready to begin the installation process
and reboot cycle. Click Reboot to proceed.
Figure 3-28: AMS Machine Works 2.0 — Setup Configured / First Reboot
2. The installer goes through the tasks you have configured for your installation. The
number of reboots that are required depends on your Windows configuration. Click
Reboot to proceed.
3. When the installation is complete you will be prompted to reboot one last time.
Click Reboot to proceed.
Figure 3-30: AMS Machine Works 2.0 — Installation Complete / Final Reboot
Postrequisites
The installation is now complete. Please continue to Post-Installation Steps.
Prerequisites
1. An AMS Machine Works Server must be installed and operating on your network
before you can perform an Agent Server installation.
2. Export the certificate from the AMS Machine Works Server to the Agent Server. See:
Add AMS Machine Works Certificates
Procedure
1. Launch Installer
2. Software License Agreement
3. Choose Agent Server Installation
4. Connect to a Server
5. Choose the Installation Drive
6. Select which Agents to Install
7. Confirm Installation
8. Complete the Reboot Cycle
Prerequisites
Complete all the Pre-Installation Steps.
CAUTION
Run setup.exe from a folder close to the root of your file system. Long path names can
result in the installer failing.
CAUTION
It is strongly recommended that you pause Windows Automatic Updates during the
installation process. Failure to do so may lead to inconsistent results. See: Stop Automatic
Updates
Procedure
1. Right-click on setup.exe, and click Run as administrator.
a) If the User Access Control window appears, click Yes to allow setup.exe to
install.
b) AMS Machine Works uses port 80 and port 443 by default. If these ports are
in use you must configure different ports. See: Network Port Availability
Figure 3-32: Warnings: AMS Machine Works Web Services Ports in Use
Procedure
1. Read the Software License Agreement.
2. (Optional) Click Print to print a copy of the Software License Agreement for your
records.
3. Click the checkbox next to I accept the terms of the license agreement.
Postrequisites
Depending on which scenario you are using, the next step to this is either:
1. (Scenario One) When performing an AMS Machine Works Server installation:
Choose AMS Machine Works Server Installation
2. (Scenario Two) When performing an Agent Server installation: Choose Agent Server
Installation
Note
If you are adding another Agent to an existing installation, select Agent Server.
Prerequisites
You must complete the previous step: Software License Agreement
Procedure
1. Select Agent Server for a new installation.
Figure 3-35: InstallShield Wizard - Select the Agent Server installation option.
Prerequisites
You must complete the previous step: Choose Agent Server Installation
Procedure
1. Enter the Server Name and Port number of the AMS Machine Works Server you
want to connect to.
Figure 3-36: InstallShield Wizard - Enter the AMS Machine Works Server Name
Note
The default Port is 443. If this port is unavailable consult the Network Port
Availability section.
2. Click Next to continue to the next step: Set Data Retention Policy and Create
Backups
Note
For more information about the recommended disk space see: Storage Capacity
Requirements by System Profile.
Prerequisites
The step previous to this is:
Procedure
1. Select which drive to install on.
2. Click Next to continue to the next step: Select which Agents to Install
Prerequisites
The previous step is: Choose the Installation Drive
Procedure
1. Select every type of Agent which you will need to access the devices on your
network.
Note
You must install each specific type of Agent to be able to access those device types.
Note
If an option is grey, that Agent is already present on that machine.
Note
If you are performing an external Agent Server installation, you must select at least
one type of Agent to install.
Note
If you select a Portables Agent you must Install CSI USB Drivers.
2. When you are installing a Portables Agent you must specify which port to
communicate on. (Default port: 10077)
a) (Optional) If you require USB to connect to your AMS 2140 Machinery Health
Analyzer to AMS Machine Works, you must have the CSI USB Driver
installed. You must perform the following post-installation step: Install CSI
USB Drivers
Procedure
The configuration is complete, click Install to start the installation process.
Postrequisites
Once the installation process begins your machine may need to reboot several times. See:
Complete the Reboot Cycle
Prerequisites
You must complete the previous step, Confirm Installation, before the installation reboot
cycle begins.
Procedure
1. The installer has been fully configured, and is ready to begin the installation process
and reboot cycle. Click Reboot to proceed.
Figure 3-42: AMS Machine Works 2.0 — Setup Configured / First Reboot
2. The installer goes through the tasks you have configured for your installation. The
number of reboots that are required depends on your Windows configuration. Click
Reboot to proceed.
3. When the installation is complete you will be prompted to reboot one last time.
Click Reboot to proceed.
Figure 3-44: AMS Machine Works 2.0 — Installation Complete / Final Reboot
Postrequisites
The installation is now complete. Please continue to Post-Installation Steps.
Prerequisites
1. Ensure that the machine meets the minimum specification for an External
MongoDB Server.
2. Ensure that the machine does not have a previous installation of MongoDB.
3. Get the MongoDB installer from one of the following locations:
a. (Recommended) MongoDB 8.0.4
1. AMS Machine Works v2.0 installer package — ..\dep\_Support
\MongoDB\mongodb-windows-x86_64-8.0.4-signed.msi
Procedure
1. Run the MongoDB installer, and then click Next.
2. Accept the terms in the License Agreement, and then click Next.
3. Choose the Setup Type for your MongoDB, and then click Next.
Note
The Complete option is recommended. For Custom options contact your System
Administrator.
Note
Recommendation:
a. Accept the default options to install MongoD as a service named MongoDB.
b. Run the MongoDB service as a Network Service user.
c. Install the Data Directory and the Log Directory on a drive other than C: , and
establish a backup schedule for this drive.
For other configuration options contact your System Administrator.
Note
Installing MongoDB Compass is recommended for preparing, configuring, and
managing the database.
Note
If the automatic installation of MongoDB Compass fails, for example because of
corporate security policies, then you must install it manually. The installer is located
at: ..\dep\_Support\MongoDB\mongodb-compass-1.45.2-win32-
x64.exe .
If you want to perform additional installations of MongoDB Compass, for example
on the AMS Machine Works server, you can manually perform this installation in
multiple places.
6. Click Next.
Note
You can use the Back and Next keys to review your choices and then return to this
screen.
Note
If you did not install MongoDB Compass as was recommended in one of the
previous steps:
• Either, contact your System Administrator about how to proceed.
• Or, download and install MongoDB Compass now.
12. Click on >_ Open MongoDB shell at the top of the window to expand the MongoDB
command line interface.
13. Switch to the Admin database by entering the command: use admin.
14. Enter and modify the text below to create an admin user for managing the
MongoDB.
db.createUser(
{
user: "admin",
pwd: "Password123",
roles: [
{ role: 'readWriteAnyDatabase', db: 'admin' },
{ role: 'userAdminAnyDatabase', db: 'admin' },
{ role: 'dbAdminAnyDatabase', db: 'admin' },
{ role: 'root', db: 'admin' }
]
}
)
Note
Text entered into the MongoDB shell is case sensitive.
Note
The example password, "Password123", should be replaced with a password which
meets your organization's security policies.
CAUTION
To ensure compatibility, MongoDB passwords should not contain the following
special characters:
%, /, :, @, <blank space>
15. Enter and modify the text below to create a database user for the AMS Machine
Works services, the mwservice user.
Note
This user requires readWrite privileges for the following databases:
• EmersonMWcoreData
• EmersonMWCore
• EmersonMWOnline
• EmersonMWPortables
• EmersonMWLicense
db.createUser(
{
user: "mwservice",
pwd: "Password123",
roles: [
{ role: "readWrite", db: "EmersonMWcoreData" },
{ role: "readWrite", db: "EmersonMWCore" },
{ role: "readWrite", db: "EmersonMWOnline" },
{ role: "readWrite", db: "EmersonMWPortables" },
{ role: "readWrite", db: "EmersonMWLicense" }
]
}
)
Note
Text entered into the MongoDB shell is case sensitive.
Note
The example password, "Password123", should be replaced with a password which
meets your organization's security policies.
CAUTION
To ensure compatibility, MongoDB passwords should not contain the following
special characters:
%, /, :, @, <blank space>
Figure 3-58: Create a Database User for AMS Machine Works Services
b. The default location of the file for MongoDB 6.0.20: C:\Program Files
\MongoDB\Server\6.0\bin
# mongod.conf
# network interfaces
net:
port: 27017
bindIp: 127.0.0.1
#processManagement:
#security:
#operationProfiling:
#replication:
#sharding:
## Enterprise-Only Options:
#auditLog:
# mongod.conf
# network interfaces
net:
port: 27017
bindIp: 127.0.0.1
#processManagement:
#security:
#operationProfiling:
#replication:
#sharding:
## Enterprise-Only Options:
#auditLog:
#snmp:
17. Modify the # network interfaces and #security sections of the mongod.cfg
file.
# network interfaces
net:
port: 27018
bindIp: 0.0.0.0
tls:
mode: preferTLS
certificateKeyFile: C:\Program Files\MongoDB\Server
\8.0\bin\<Your_MongoDB_Server_Cert>.pem
CAFile: C:\Program Files\MongoDB\Server\8.0\bin
\<Your_CA_Server_Cert>.pem
allowConnectionsWithoutCertificates: true
#security section
security:
authorization: enabled
Note
• <Your_MongoDB_Server_Cert>.pem file must be provided by a Certification
Authority.
• <Your_CA_Server_Cert>.pem file must be provided by a Certification Authority.
• Remember to remove the comment symbol,
, in front of
security:
Note
The MongoDB Atlas cloud solution also requires a user that has the proper
permissions for the Emerson databases. The MongoDB Atlas cloud solution has a
graphical interface for configuring these options. These options should be
configured to the same values as shown above. Please seek the assistance of your
System Administrator, and refer to your MongoDB Atlas cloud documentation for
how to perform these steps.
Where:
a. <password> is the password set for the mwservice user.
b. <servername> is the name of the External MongoDB server.
Attention
Connection strings that specify a .pem file will not work with AMS Machine
Works. The .pem files must be installed manually.
18. Obtain a certificate from your trusted Certificate Authority and copy it to the
following locations:
a) C:\Program Files\MongoDB\Server\8.0\bin
\<Your_MongoDB_Server_Cert>.pem
b) C:\Program Files\MongoDB\Server\8.0\bin\<Your_CA_Server_Cert>.pem
Attention
MongoDB no longer supports a configuration that enables TLS without explicitly
specifying a chain of trust.
Note
If your installation uses another path for the certificates, this change must be used
in your mongod.cfg file.
Procedure
1. For AMS Machine Works to function properly certain Windows services must be
running. See: Check Services
2. For AMS Machine Works to function properly the ports which are used for
communication cannot be in use by other applications. See: Deconflict Ports
3. To ensure the stability of the installation process you previously must have paused
the automatic update services on your server. You must now Restart Automatic
Updates.
4. To enable the use of the domain user accounts on your server to access AMS
Machine Works installation you must Enable Domain User Login
5. Add AMS Machine Works Certificates
6. When you launch AMS Machine Works for the first time, log in with the default
password and then set a custom password. See: First Launch of AMS Machine Works
7. (Optional) You should set a backup policy and a data retention policy See: Set Data
Retention Policy and Create Backups
8. (Optional) If you need to use an OPC UA client, ensure that you have an OPC license
in the User Manager module of AMS Machine Works. See: OPC UA Server
9. AMS Machine Works is integrated with a sophisticated analysis tool, the Vibration
Analyzer, or VibApp. You should install this application to get insights into your
data. See: Install the Vibration Analyzer - VibApp
10. (Optional) If your AMS Machine works system needs to communicate with AMS
2140 Machinery Health Analyzer handheld units via a USB connection, you must
install the CSI USB Driver on the system(s) you will use to connect to AMS Machine
Works. See: Install CSI USB Drivers
11. Monitor the performance of your system to ensure that you do not enter a critical
overload or have data loss. See: Monitor DSS Processing Capacity
You are now ready to start using AMS Machine Works.
Note
The following services have a delayed start setting:
• Emerson MW Asset Monitor Agent
• Emerson MW Wireless Agent
• Emerson MW ATG Agent
2. Agent Services will only be running after they have been registered in
the Network Device Module, for most agents, or in the Portable
Device Module for the Emerson MW Portable Edge Agent.
o. MongoDB Services:
1. MongoDB Server (MongoDB)
p. PostgreSQL Services:
1. postgresql-x64-17-PostgreSQL Server 17
q. RabbitMQ services:
1. RabbitMQ
Prerequisites
Note the numbers of some available ports.
Procedure
1. (Optional) If Port 8888 is in use by another application, that application must be
reconfigured to use another port.
2. Launch the Internet Information Services (IIS) Manager.
3. In the Connections pane expand Your_Server_Name.
4. In the Connections pane expand the Sites under Your_Server_Name.
5. In the Connections pane, right click EmersonCSI → Edit Bindings....
6. (Optional) If port 80 is in use:
a) In the Site Bindings window, select port 80 and click Edit .
b) In the Edit Site Binding window, enter another port number, and then click
OK.
Prerequisites
Locate the Stopped Update Services List you made in the Stop Automatic Updates task.
Procedure
1. Restart the services in your Stopped Update Services List.
The automatic update services that you paused should now be running again.
2. Verify that the services are running.
Prerequisites
1. Log on to the computer with the same Administrator account that you used to
install AMS Machine Works.
2. Open Windows → Internet Properties → Security Tab → Trusted Sites
Procedure
1. Click Custom Level.
5. Click Yes.
6. In the Internet Properties dialog, click Apply.
7. To close the Internet Properties dialog, click OK.
You should now be able to log in to AMS Machine Works with Domain User
accounts.
Prerequisites
1. You will need Administrator access on all the affected machines.
2. In Windows open: Manage computer certificates.
Procedure
1. To open the Certificate Export Wizard choose: Trusted Root Certification
Authorities → Certificates → AMS Machine Works 2.0
<YOUR_COMPUTER_NAME> → All Tasks → Export...
2. In the Certificate Export Wizard, choose: Next → No, do not export the private
key → DER encoded binary X.509 (.CER) → Next.
3. Click Browse and then choose a location and enter a File name for the certificate.
4. Choose: Save
5. Choose: Next
6. Review the certificate's settings.
• If the settings are not correct, click Cancel.
• If the settings are correct, click Finish.
7. Install AMS Machine Works server certificate where necessary. See: AMS Machine
Works Security
A certificate is necessary on every External Agent Server.
Note
This includes PCs used to connect with AMS 2140 Health Analyzer units. See the
User Guide for more details.
Prerequisites
• Use Google Chrome for optimal performance. AMS Machine Works web applications
use web technologies that are no longer supported in Internet Explorer 11. See:
Troubleshooting
• Security certificates must be installed. See: AMS Machine Works Security
• If you are launching AMS Machine Works for the first time after an update, you must
clear all browser caches before reconnecting to AMS Machine Works. See: Update from
v1.8 to v2.0
Procedure
1. Open a web browser. (Recommended: Google Chrome or Microsoft Edge)
2. In the web browser address field, enter the URL for the User Manager: For example,
https://[server]/user-manager
Where [server] is the computer name of the AMS Machine Works server.2
3. If this is the first time you have launched AMS Machine Works from a client
computer, install the certificate.
2 If a port number is required, also include the port number, for example, https://[server]:443/user-manager.
Install the AMS Machine Works certificate so you can perform actions such as
adding asset sources. See: AMS Machine Works Security
4. Open the User Manager in the web browser then enter the initial credentials:
Username : admin
Password : Emerson#1
6. Next, you must register your AMS Machine Works license. Refer to the User Guide
Online Help for instructions.
Note
You can manually control data retention, or schedule data retention for your MongoDB
databases with the Data Retention Policy Tool.
Prerequisites
Contact your System Administrator to determine your organization's data retention
policy.
Procedure
1. Implement your organization's data retention policy.
2. Maintain regular backups of your data.
Prerequisites
• Turn off automatic Windows updates during installation or upgrade. Pausing updates
will reduce the number of restarts during the installation process. In Windows
Settings, select Advanced, and choose to pause updates and select a date to resume
updates.
Procedure
1. Open a browser, type https://[server]:[port number]/VibApp.
Where [server] is the computer name of the server where AMS Machine Works is
installed and [port number], if required, is the port number assigned.
Note
Enter the server name set during installation of AMS Machine Works.
Note
The Vibration Analyzer installer is also available as a .exe file at: (Installer
Folder)/Products/AMS Machine Works Vibration Analysis Service
When prompted, enter the name of the AMS Machine Works server, and then click
Next.
Note
Use the same server name as the AMS Machine Works configuration, and when
installing or upgrading components. For example, when you choose the Use Server
Name option in the Server and Port Binding Configuration screen during the
installation, you must enter the name of the AMS Machine Works server.
Failure to use the same configuration as the AMS Machine Works server when
installing or upgrading components may cause the installation to fail and you will
need to uninstall and reinstall the software to configure the same server setting.
5. Click Next.
6. Click Install.
7. Click Finish when done.
Prerequisites
Locate the AMS Machine Works installation package.
Procedure
1. Browse to the folder: C:\..\Installer_2.0.0.XXX\dep\_Support
\CSIUSBDriver\
Note
a. C:\..\ — The drive letter and the folder path are where you decompressed
the installer package.
b. 2.0.0.XXX — XXX is the specific build number of your version of AMS
Machine Works v2.0.
CAUTION
When any one of these KPIs has less than 10% of capacity remaining:
• The system is in critical overload.
• There is a risk of data loss.
Prerequisites
1. AMS Machine Works must be installed and running.
2. You must be logged into the machine where AMS Machine Works is installed.
Procedure
1. Open the DSS Processing Capacity KPIs in your browser: http://
localhost:5006/status/dashboard.html
Note
The URL must begin with http, https is not supported.
Note
You must use the same version of the installer to uninstall AMS Machine Works as you
used for installation.
Note
Uninstallation by the Windows Add or remove programs control panel will work if the
proper version of the installer is unavailable.
Prerequisites
1. AMS Machine Works v2.0 must be installed on your computer system.
2. You must use the same version of the installer to uninstall AMS Machine Works as
you used for installation.
Procedure
1. Run setup.exe as an Administrator.
2. Choose Remove → Next to remove every AMS Machine Works component.
Note
The number of reboot cycles varies depending on the elements that you have
installed.
Need help?
Error occurred: Uninstallation failed. Exit code: 1638.
Reboot and retry
This error can be caused by using a different installer to run the uninstallation
process.
Check that you are using the same installer program that you installed AMS
Machine Works with.
The data directory has not been removed. A popup is shown giving the
location of the data directory.
e) Click OK to proceed, and click OK in the next window to complete the
uninstallation.
PostgreSQL 17 is uninstalled, and your AMS Machine Works configuration
data is located at: C:\Program Files\PostgreSQL\17\data
f) Either delete or backup the data at: C:\Program Files\PostgreSQL
\17\data
8. Uninstall MongoDB:
Note
The version of MongoDB that is installed depends on your operating system. See:
Database Components
11. Check the Task Manager for the following processes, erlsrv and erl.
a) If they are running, stop erlsrv and erl.
12. (Optional) Any files that were not removed by the uninstall functions in Apps &
Features control panel should be removed.
• (Automatic Option) Use the Uninstall Cleaner Utility. See: Uninstall Cleaner
Utility
• (Manual Option) Continue the instructions below, and delete these files
manually.
Note
Administrator is the name of the default administrator, if you used another
administrator account to perform the installation, then the filepath will use that
name.
For example: C:\Users\Other_Administrator\AppData\Roaming
\RabbitMQ
16. Run the Windows Registry Editor, and delete the following registry entries.
a) Use the Registry Editor to delete the first Ericsson folder:
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Ericsson
c) (Optional) Use the Registry Editor to delete the RabbitMQ folder if it exists:
Computer\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services
\RabbitMQ
Prerequisites
1. You can modify:
a. An AMS Machine Works server installation. See: AMS Machine Works Server
Installation
b. An Agent server installation. See: Agent Server Installation
2. You must use the same version of the installer to modify AMS Machine Works as
you used for installation.
Procedure
1. Run setup.exe as an Administrator.
2. Choose Modify → Next to settings to modify or agents to add to your AMS Machine
Works installation.
3. Set the Computer Name and Port for the AMS Machine Works server.
b) The computer port number can be from 1 to 65535. (Default port: 443)
Note
Agents listed with a filled in checkbox and grey text are already present on this
server.
a) (Optional) To connect to an AMS 2140 unit via USB, you will need to install
the CSI USB driver manually. See: Install CSI USB Drivers
a) (Optional) If you require USB to connect to your AMS 2140 Machinery Health
Analyzer to AMS Machine Works, you must have the CSI USB Driver
installed. You must perform the following post-installation step: Install CSI
USB Drivers
5. (Optional) When you are installing a Portables Edge Agent you must specify which
port to communicate on. (Default port: 10077)
Note
The number of reboots that are required depends on your Windows configuration.
This error can be caused by using a different installer to run the uninstallation
process.
Check that you are using the same installer program that you installed AMS
Machine Works with.
Backups
To perform backups of an Internal MongoDB database, see: Manual Backup of the
MongoDB Database
An External MongoDB installation requires maintenance by a database administrator.
Backups are expected to be performed by the database administrator. Please contact your
database administrator or IT department for proper backup procedures as they relate to
your overall backup strategy. See: Manual Backup of the MongoDB Database
Restore
If you need to restore any of the databases, contact your IT department to guide you on
the proper restore procedure.
Prerequisites
Download and extract the mongodump.exe tool from the MongoDB website:
1. https://www.mongodb.com/docs/database-tools/mongodump/
2. https://www.mongodb.com
3. Or search for 'mongodump' in the search engine of your choice.
Procedure
1. Open the terminal application.
2. Change the directory to the location where the mongodump.exe was extracted.
Note
For more information about the mongodump.exe tool, please refer to the
MongoDB documentation website.
3. As an administrator user for the MongoDB database, run the mongodump.exe tool
with the following command:
mongodump.exe "mongodb://
<ADMIN_ACCOUNT_NAME>:<ADMIN_ACCOUT_PASSWORD>@localhost:27018/?
authSource=admin"
Postrequisites
To perform a restore operation please contact your system administrator and search the
MongoDB documentation website for mongorestore.
Prerequisites
1. AMS Machine Works v1.8 must be installed.
2. Get the installer package. See: Locate the Installer
CAUTION
It is strongly recommended that you pause Windows Automatic Updates during the
installation process. Failure to do so may lead to inconsistent results. See: Stop
Automatic Updates
Procedure
1. If your AMS Machine Works system includes any External Agent Servers, you must
stop every External Agent Server now. Open the Services app, and stop the
following services:
a.
b. Emerson MW Asset Monitor Agent
c. Emerson MW ATG Agent
d. Emerson MW Portables Edge Agent
e. Emerson MW Wireless Agent
Note
If a service is not present then that Agent was not installed, and no action needs to
be taken.
CAUTION
Run setup.exe from a folder close to the root of your file system. Long path
names can result in the installer failing.
3. If one of the following error screens is shown, contact Emerson Product Support.
See: Sending Log Files to Emerson Product Support
9. Recreate a User in the Machine Works OPC UA User group if you had one
configured before the update. See: Manage Certificates in OPC UA Clients and
Servers
10. The AMS Machine Works Vibration Analyzer (VibApp) must be uninstalled.
a) On your computer, open 'Add or remove programs'.
b) Select AMS Machine Works Vibration Analyzer, and click Uninstall.
11. Clear the cache of every browser used with AMS Machine Works before connecting
to the updated version of AMS Machine Works.
CAUTION
Not clearing the browser caches can lead to incorrect system performance and the
loss of data.
12. Install the AMS Machine Works Vibration Analyzer again. See: Install the Vibration
Analyzer - VibApp
Prerequisites
1. AMS Machine Works v2.0 must be installed. See: Update AMS Machine Works from
v1.8 to v2.0
2. AMS Machine Works v2.0 security certificates must be exported to every external
location where a Portables Edge Agent is going to be installed. See: Add AMS
Machine Works Certificates
Procedure
1. Disconnect every portable device in the AMS Machine Works user interface.
a) Launch the Portable Device Module.
b) Open the Devices tab.
c) Click Disconnect Device for every device which has a green or yellow status
in the Device List sidepanel.
2. Delete every Portable Agent in the AMS Machine Works user interface.
a) Launch the Portable Device Module.
b) Open the Agents tab.
c) For every Agent in the Agent List side panel, select Vertical Ellipsis → Delete
Agent
6. Install the new Portables Edge Agent in every location where it is needed.
• For machines with no AMS Machine Works software installed, see: Agent Server
Installation
• For machines with some AMS Machine Works v2.0 software installed, see:
Modify an AMS Machine Works v2.0 Installation
Note
1. A maximum of 1040 measurement points can be included in a single
route.
2. Form as many routes as you need to include every measurement
point with a Portable Alert Set assigned to it.
3. For example, you can create a set of routes named from Temp Route
1 to Temp Route X.
b) To register the measurement points, click the Export Route control in the
Routes section of the Portable Device Module for every route.
Note
• This process can take a long time to complete. Perform this action at a
time when your system is not under a heavy load, for example, overnight.
• The process to generate a .rdf file will time out on the first time you use
the Export Route function.
11. When the registration process completes for every Temp Route X, check that
every measurement point was registered.
a) Click Export Route for every Temp Route X again.
This should complete quickly and generate a .rdf file.
Need help?
If a .rdf file is still not generated, wait some time and repeat this step.
12. For each measurement point on a component with an Alert Set configured:
a) Click the X next to the name of the Alert Set to clear the Portable Alert Set.
b) Select the same Alert Set from the dropdown list.
Note
The Parameter Sets do not have to be cleared and reset.
13. Repeat the previous step for every Component contained in every Machine Train /
Roll / Pulley Section contained in every level of your Folder / Site / Default
Enterprise hierarchy.
CAUTION
Any Alert Set which is not manually cleared and reset will not function correctly and
the Alert will not function.
5 Support Tools
A group of support tools and utilities is included with the installation package in the
SupportTools folder.
Note
The ..Installer_2.0.0.XXX\SupportTools folder is in the hierarchy created when
you unzipped the Installer_2.0.0.XXX.zip file. See: Installation Procedures
Note
The Pre-Installation Checklist tool should be run prior to using the AMS Machine Works
installer. The tool should be used on every machine where you plan to use the AMS
Machine Works installer.
Procedure
1. Launch the PreInstallationChecklist.exe application from the
SupportTools folder to begin the analysis.
2. (Optional) Press the 'Y' key to perform an antivirus test, or press the 'N' key to skip
this test.
Note
Pressing the '?' key displays a short help text.
Attention
Antivirus software should be disabled while running the AMS Machine Works
Installer.
a) Every antivirus system reacts differently. The example below shows the
response of Windows Defender.
Note
The test involves creating a non-volatile file in your default application
for .txt files, which may trigger an antivirus reaction. (See: www.eicar.com)
Antivirus reactions are different for each antivirus software, the response
pictured is for Notepad and Windows Defender.
b) If the test did not trigger an antivirus reaction, click N to proceed. Click Y to
indicate that an antivirus response occurred, and you will proceed and also
receive a warning to turn off your antivirus software during the installation
process.
Note
The PreInstallationChecklist.exe application is typically located in the
SupportTools folder, and it will save its output to the same location. If you run the
application from another location it will save its output there.
Sending the Installation Logs, Service Logs, and Screenshots to Emerson Product
Support
Gather the screenshots and compressed log files in one directory.
When you contact Emerson Product Support, they will provide a link to a SharePoint
location where the log files can be uploaded.
Contact Information
Services are delivered through our global services network.
1. To contact your local Emerson Sales and Service provider, click Contact Us.
2. To contact the Global Service Center, click Technical Support.
Procedure
1. Run the application located at ..\SupportTools
\InstallationLogsCompressor.exe on the affected machine.
Note
The InstallationLogsCompressor.exe application is typically located in the
SupportTools folder, but it will save its output to the same location it is run from. For
example, if you run the application from the desktop, it will save its output there.
Procedure
1. Run the application located at ..\SupportTools
\ServiceLogsCompressor.exe on the affected machine.
2. Input the number of days of logs to compress. (Default: 5)
A file, named AMSMWLogs_*computerName*.zip, is created.
Note
The ServiceLogsCompressor.exe application is typically located in the
SupportTools folder, but it will save its output to the same location it is run from. For
example, if you run the application from the desktop, it will save its output there.
CAUTION
This tool can delete your entire database. To ensure data integrity you should first perform
a Manual Backup of the MongoDB Database.
The tool runs in either from the command line or in Interactive Mode.
Running the Data Retention Policy Tool from the command line with the --non-
interactive flag is recommended preparation for using the tool as a scheduled task.
See: Schedule the Data Retention Policy Tool
To operate the Data Retention Policy Tool in Interactive Mode, follow the on-screen
prompts for instructions.
Note
1. EmersonMWcoreData – The measurements, both scalars and block data.
2. EmersonMWCore — Do not modify this database unless you are a trained
service engineer with a specific reason.
Note
When you use the -s flag you must also use the -r flag to specify the amount of data
thinning to perform.
This command would cut off all scalar data older than February 3rd, 2025.
External MongoDB example: MW.Utils.RetentionTool.exe --non-interactive
-db EmersonMWcoreData -cns mongodb://mwservice:Abcd123!
@<server>:27018/?authSource=admin&tls=true -b -s -r 2880 -c 90
Where <server> is the name of your External MongoDB server. See: External MongoDB
Server Installation
This command would cut of both block data and scalar data older than 90 days.
Procedure
1. Determine which options you want to use with the Data Retention Policy Tool.
2. Launch the operating system's Task Scheduler, and click Create Basic Task... .
3. Enter a name and description for this task, and then click Next to continue.
4. Set the period for your task, and then click Next to continue.
5. Refine the period for the task, and then click Next to continue.
6. Set the type of Action to Start a program, and then click Next to continue.
Figure 5-11: Browse to the AMS Machine Works Retention Tool folder.
8. Add the command line arguments you need to use for your installation, and then
click Next to continue.
9. Review the task summary. If you are satisfied, then click Finish to complete the
process.
2. Agent Server
The application detects if any AMS Machine Works components or 3rd Party components
remain on the system.
Prerequisites
Remove all AMS Machine Works components and 3rd Party components.
Procedure
1. Run the application located at ..\SupportTools\UninstallCleaner.exe on
the affected machine.
Need help?
a. If the UninstallCleaner.exe displays a list of program to remove, close
the program and refer to the uninstallation steps in this manual. See:
Uninstall AMS Machine Works v2.0
2. When the application displays a list of files to delete, and processes to stop, decide
if you want to delete the listed files.
CAUTION
This action will delete all of your data. Back up any databases that you might need.
When you choose Y, the files are deleted, and the processes are stopped.
6 OPC UA Server
AMS Machine Works includes OPC UA Server functionality running as a service to provide
secure communication between devices which support the OPC UA standard. The service
automatically launched if you have an active license for it.
OPC Server functionality is not a standard part of every AMS Machine Works license. To
check if your installation has this functionality enabled go to the User Manager module in
AMS Machine Works and click the LICENSES tab.
You can upgrade your AMS Machine Works license at any time.
If you upgrade your AMS Machine Works license, you need to Reboot your server for the
functionality to become available.
Procedure
1. Generate a certificate in a compatible OPC client. See: OPC UA Software
Compatibility
a) With UaExpert, which is used in the Configure an OPC UA Client example
below, the file path is: C:\Users\Administrator\AppData\Roaming
\unifiedautomation\uaexpert\PKI\own\certs
2. (Optional) If you want users to use login and password authentication, then in the
operating system's Computer Management utility, add a User to the Machine
Works OPC UA Users group.
3. Copy the certificate generated in Step 1 from the folder it was saved to.
a) Paste the certificate into: C:\ProgramData\Emerson\AMSMachineWorks
\Data\DOPC\pki\server\trusted\certs\
Postrequisites
For an example installation with details see: Configure an OPC UA Client
Prerequisites
• Click the LICENSES tab in the User Manager to confirm that the OPC UA Server license
is enabled.
• Complete the steps found in: Manage Certificates in OPC UA Clients and Servers
• Server Information — From your OPC UA Client, supply the connection information of
the OPC UA Server. The URL for the OPC UA Server is opc.tcp://[server]:4840, where
[server] is the computer's name, IP address, or localhost of the AMS Machine Works
server.
• Security Settings — From your OPC UA client, select the security policy and message
security mode that applies to your network. The OPC UA Server supports these security
settings:
— Security Policy
• Aes256-Sha256-RsaPss
• Aes128-Sha256-RsaOaep
• Basic256Sha256
— Message Security Mode
• Sign
• Sign and Encrypt
• Encrypt Authentication Settings — An OPC UA client may be able to connect to the
OPC UA server via a predetermined username and password, or through certificate
validation. To enable an OPC UA client to connect to the server via username and
password, an Administrator must add the user to the Machine Works OPC UA Users
Windows Group.
Procedure
1. Download, install, and then run UaExpert from unified-automation.com. Enter
some value into the Organization field and then click OK to continue.
Note
This is third party software which is shown only for demonstration purposes. Other
clients are also compatible. See: OPC UA Software Compatibility
3. In the Custom Discovery section, double click the + symbol to add a server.
A popup window will open for you to enter the URL for the OPC UA Server.
4. Enter the server name, IP, or localhost, followed by :4840 and then click OK to
continue.
Note
This is the User that you added in the Manage Certificates in OPC UA Clients
and Servers steps.
You are now ready to connect to the server and acquire the hierarchy.
6. Right click on the server you have configured and select Connect.
The client is now fully configured, and you can interact with the AMS Machine Works
hierarchy as shown in the bottom left of the window.
7 Troubleshooting
This section presents troubleshooting tips. You can also refer to Knowledge Base Articles for additional
troubleshooting tips.
Index
A Installation Procedures (continued)
Pre-Installation Steps (continued)
AMS Machine Works IIS Application Pools and Applications Server Installation Pre-Check 46
14 Stop Automatic Updates 49
Introduction
Symbols 7
C
Compatibility M
Device Compatibility 40
Emerson Software Co-Deployment 42 Maintenance and Migration
OPC UA Software 41 Backup and Restore Procedures
Manual Backup of the MongoDB Database 114
Modification Options
I Modify an AMS Machine Works v2.0 Installation
Installation Procedures 110
Agent Server Installation 69 Uninstallation Options
AMS Machine Works Server Installation Uninstall AMS Machine Works v2.0 105
Choose AMS Machine Works Server Installation Update from v1.8 to v2.0
54 Update AMS Machine Works
Choose Internal vs. External MongoDB Server 56 Update the Portables Edge Agent 118
Choose the Installation Drive 63, 74
Complete the Reboot Cycle 67, 78 O
Confirm Installation 66, 77
Enter a Server Name 55 OPC UA Server
Launch Installer 51, 70 Configure OPC UA Client 136
Provide Passwords or Connection String 58 Manage Certificates 135
Select which Agents Servers to Install 64, 75 OPC Tag Information 143
Software License Agreement 53, 71 OPC Tree Structure 143
External Agent Server Installation
Choose Agent Server Installation 72
Choose the Installation Drive 63, 74
S
Complete the Reboot Cycle 67, 78 Support Tools
Confirm Installation 66, 77 Data Retention Policy Tool
Connect to a Server 73 Set a Schedule 128
Launch Installer 51, 70 Pre-Installation Checklist Tool 121
Select which Agents Servers to Install 64, 75 Sending Log Files to Emerson Product Support
Software License Agreement 53, 71 Installation Logs Compressor 124
External MongoDB Server Installation 80 Service Logs Compressor 125
Post-Installation Steps Uninstall Cleaner Utility 131
Add AMS Machine Works Certificates 98 System Planning
Check Services 94 AMS Machine Works Architecture
Deconflict Posts 96 Agent Layer 18
Enable Domain User Login 97 AMS Machine Works Application Layer 13
First Launch of AMS Machine Works 99 AMS Machine Works Core 13
Install CSI USB Drivers 101 Hardware Layer 18
Install the Vibration Analyzer - VibApp 100 AMS Machine Works Security 43
Monitor DSS Processing Capacity 102 Compatibility 40
Restart Automatic Updates 97 Database Components 15
Set Data Retention Policy and Create Backups Database deployment
100 MongoDB Database Deployments 23
Pre-Installation Steps Deployment Scenarios
Locate the Installer 50 Typical Deployment Scenarios 20
T
Troubleshooting
Installation Troubleshooting 145
OPC UA Server Troubleshooting 145
Security Troubleshooting 145
Vibration Analyzer Troubleshooting 146
Emerson
835 Innovation Drive
Knoxville, TN 37932 USA
T +1 865-675-2400
F +1 865-218-1401
www.Emerson.com
©2025, Emerson.
The contents of this publication are presented for informational purposes only, and while every
effort has been made to ensure their accuracy, they are not to be construed as warranties or
guarantees, express or implied, regarding the products or services described herein or their use or
applicability. All sales are governed by our terms and conditions, which are available on request. We
reserve the right to modify or improve the designs or specifications of our products at any time
without notice.
All rights reserved. AMS is a mark of one of the Emerson group of companies. The Emerson logo is a
trademark and service mark of Emerson Electric Co. All other marks are the property of their
respective owners.