Sentinel Web Services Installation Guide
Sentinel Web Services Installation Guide
Installation Guide
Chapter 1: Introduction 1
Introduction 2
Chapter 2: Prerequisites 3
Prerequisites for Web Services Server 4
Chapter 4: Upgrade 16
Web Services Upgrade Steps (Execute as SmartSignal Services Account) 17
Chapter 5: Troubleshooting 22
Troubleshooting 23
Trademark Notices
© 2022, General Electric Company. All rights reserved.
1
Introduction
Topics:
• Introduction
2
Prerequisites
Topics:
Operating System Microsoft Windows Server 2019, 2016 or 2012 R2 64-Bit with
latest Service Pack
RAM 4 GB or more
Setup:
Confirm that the SmartSignal Services Account has local Administrator rights to the server hosting
the Web Services and Administrator privileges to the SmartSignal database (required only for
installation).
1. For Windows 2012 Server Only - Install Visual C++ Redistributables for Visual Studio 2015
2. Download and install MSOLEDB 18.5.0 or higher
https://docs.microsoft.com/en-us/sql/connect/oledb/release-notes-for-oledb-driver-for-sql-server?
view=sql-server-ver15#1863
3. Download and install .Net Core 3.1.x Hosting bundle (.Net Core Runtime 3.1.x + ASP.NET Core
Runtime 3.1.x + IIS support) as administrator
https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-aspnetcore-3.1.4-windows-
hosting-bundle-installer
14. Configure the SmartSignal PM2 Service to use SmartSignal Services Account
a. Open the Windows Services dialog box.
b. In the services list, select the SmartSignal_PM2 service.
c. Right-click on the SmartSignal_PM2 service and select Properties.
d. Select the Log On tab.
e. Select This Account radio button, and enter the user ID and password details for the SmartSignal
Services Account that the service is to run under.
f. Select OK.
g. Start the SmartSignal_PM2 service.
15. Confirm PM2 running using an Administrator Command Prompt
>pm2 list
16. Download and Install Application Request Routing 3.0 (ARR) x64 installer
https://www.iis.net/downloads/microsoft/application-request-routing
17. Run IISReset to restart IIS.
5. Select Next.
6. In the Select Features page, select Next.
7. In the Confirm Removal Selections page, select Remove.
8. In the Results page, select Close.
3
Installation Steps
Topics:
If alert-UI, app-hub, case-UI and charts-UI are not listed or online, enter the following commands in
the Administrator Command prompt:
12. Display the application status in PM2, using an Administrator Command prompt.
‘SmartSignal Reverse Proxy Services’ and ‘SmartSignal UAA Services’ should bind to certificate, as
displayed below.
Host name should be identical to SSL Certificate.
If SSL certificate is empty or assigned to a wrong certificate, you need select the right certificate and
save the change.
16. Test your Web Services Connection.
a) Open a Web Browser.
b) Enter the URL that you entered during the install, as https://<Your.URL.Here>
c) At the login prompt, enter the SmartSignal user account credentials, this may be the default Admin
account if no users have been created.
4
Upgrade
Topics:
Procedure
1. Stop the SmartSignal_PM2 service.
2. Use an elevated command prompt as the service account user, and execute the following
command:
• Database server that you are installing to: Browse to the name of the server hosting the
SmartSignal SQL Server database and dedicated instance name.
• Name of database catalog: Browse to your SmartSignal database.
10. Enter the SmartSignal Web Services information
• Web Site URL: Enter your Web Site URL, i.e. www.costo.com.
• SSL Certificate Path: Browse to your SSL certificate.
• SSL Certificate Password: Enter your SSL certificate password.
11. Select the security certificate file (.cer or .pfx) that you want to install.
Note: The SSL certificate is also installed when the website and the virtual directories are installed.
If alert-UI, app-hub, case-UI and charts-UI are not listed or online, then enter the following commands
in the Administrator Command Prompt:
‘SmartSignal Reverse Proxy Services’ and ‘SmartSignal UAA Services’ should bind to certificate.
Host name should be identical to SSL Certificate.
If SSL certificate is empty or assigned to an incorrect certificate, update the correct certificate and
save the change.
18. Restart IIS.
19. Test the Web Services Connection.
Open a Web Browser
Enter the URL that you entered during the install, as https://<Your.URL.Here>
20. At the login prompt, enter the SmartSignal user account credentials, this may be the default Admin
account if no users have been created.
Note:
Web Services Logs:
C:\ProgramData\SmartSignal\WebServices\Logs\restfulservice.log
C:\ProgramData\SmartSignal\WebServices\Logs\uaaservice.log
5
Troubleshooting
Topics:
• Troubleshooting
Issue: If bearer token is still in session of UAA , AppHUB failed to communicate with UAA service.
Check:
◦ The UAA URL in UAA service and AppHUB are same (case sensitive).
◦ AppHUB can access the UAA from UAA URL.
If UAA URL is a public web domain URL, because of the security setting, the public domain URL cannot
be resolved. We need set the IP and public web domain URL mapping in /etc/host file.
Issue: If bearer token is not in session of UAA , it implies that the AppHUB has taken the bearer token,
but failed to validate the token by public key.
Check:
<conditions
logicalGrouping="MatchAll">
<add input="{REQUEST_URI}"
pattern="/login.do"
negate="true" />
<add input="{REQUEST_URI}"
pattern="/oauth/token"
negate="true" />
<add input="{REQUEST_URI}"
pattern="/token_key"
negate="true" />
<add input="{REQUEST_URI}"
pattern="/logout"
negate="true" />
<add input="{REQUEST_URI}"
pattern="/appHubConfig"
negate="true" />
<add input="{REQUEST_URI}"
pattern="^/login$"
negate="true" />
<add input="{REQUEST_URI}"
pattern="/oauth/authorize"
negate="true" />
<add input="{REQUEST_URI}"
pattern="/resources"
negate="true" />
<add input="{REQUEST_URI}"
pattern="/logout\?redirect"
negate="true" />
</conditions>
For Example:
https://ReverseProxyUrl/login?state=/
should be converted to
https://ss-web-url/login?state=/
<conditions
logicalGrouping="MatchAny">
<add input="{REQUEST_URI}"
pattern="/login.do" />
<add input="{REQUEST_URI}"
pattern="/oauth/token" />
<add input="{REQUEST_URI}"
pattern="/token_key" />
<add input="{REQUEST_URI}"
pattern="/appHubConfig" />
<add input="{REQUEST_URI}"
pattern="^/login$" />
<add input="{REQUEST_URI}"
pattern="/oauth/authorize" />
<add input="{REQUEST_URI}"
pattern="/resources" />
<add input="{REQUEST_URI}"
pattern="/logout\?redirect" />
</conditions>
</conditions>
For Example:
https://ReverseProxyUrl/login?state=/
should be converted to
https://ss-web-url/login?state=/
For localhost, the loopback name resolution is handled within DNS itself.
SmartSignal Reverse Proxy Services’ and ‘SmartSignal UAA Services’ should bind to certificate, as
displayed below.
If SSL certificate is not assigned, you should select the right certificate and save the change.