Installing the JAMS Web Client with the Installer

Installation Overview

note

The JAMS Web Client cannot be upgraded in place. Ensure you uninstall any previous version (0.0.1, 0.0.2, 0.0.3) of the JAMS Web Client and delete the JAMSBase database before starting the installer. Otherwise, you may encounter issues during installation or when working with objects, depending on the version.

• Included Components and Services
• Installing the JAMS Web Client
• Optional - Changing the Port
• Adjusting Gateway Configuration Settings
• Configuring Secure Communication

Included Components and Services

Components

• JAMSBase Database – A database that is included as part of the JAMS Web Client installation. This is a separate database from the main JAMS Database. It contains items related to only the JAMS Web Client, such as User Federations/Identity Providers and session management information.
• JAX – A chat assistant built into the JAMS Web Client screens. JAX requires the JAMS MCP to be installed.
• JAMS MCP – A connection layer that lets external AI tools, such as Claude and Cursor, access the JAMS Web Client.
• REST API – The JAMS Web Client includes a new REST API that can be used for testing. You can access it from https://localhost/swagger after you install the JAMS Web Client.

Services

• JAMS API – The service for the JAMS REST API.
• JAX – The service for the chat assistant.
• JAMS Gateway – The service that handles the requests and routes them as needed. It uses ports 80 and 443.
• JAMS Identity – The service that handles identity management.
• JAMS MCP – The service for the connection layer that enables external AI tools.
• JAMS Web UI – The service that runs the JAMS Web Client user interface.

Installing the JAMS Web Client

1. Copy the installer to the JAMS Web Client machine.
2. Right-click the JAMS Web Client installer and select Run as administrator.
3. On the Setup - JAMS screen, click Next.
   
4. If .NET is not installed, click Download and Install .NET Runtime on the .NET Prerequisite screen to download it.
   The JAMS Web Client requires .NET 10. If it is not installed, the installer displays a message and will attempt to install it. If an internet connection is not available, you will need to manually download and install the correct .NET version. Go to the .NET 10 download site to download the correct version.
   
5. On the Installation Folder screen, select the location where the Web Client will be installed. By default, it is installed in C:\Program Files\JAMS.
6. Click Next.
   
7. On the Select Components screen, click Next. All components are automatically selected.
   
8. On the JAMS Database screen, enter the server name\instance of the main JAMS database.
9. Enter the name of the JAMS database.
10. Select one of the following authentication modes:

• Windows Authentication
• SQL Server Authentication
• Active Directory Integrated Authentication
• Active Directory Password Authentication

11. Click Next.
    
12. On the JAMS Base Database screen, enter the server name\instance of the database for the JAMS Web Client, such as (local)\SQLExpress.
13. Verify the name of the JAMS Web Client database is set to JAMSBase by default.
14. Select the Allow creating the database if not exist checkbox to allow the JAMS Web Client database (JAMSBase) to be created.
15. Select one of the following authentication modes:

• Windows Authentication
• SQL Server Authentication
• Active Directory Integrated Authentication
• Active Directory Password Authentication

16. Click Next.
    
17. On the TLS Certificate screen, review the text and update the self-signed certificate after the installer finishes.
    
18. On the License Agreement screen, click I accept the license.
19. Click Next.
    
20. On the Ready to Install screen, click Install. The Installing JAMS screen is displayed and shows the progress of the installation.
    
21. On the Completing the JAMS Wizard page, click Finish.
    

note

If you installed the JAMS Web Client on a remote server, you may need to manually start the services for the JAMS Web Client. Ensure the JAMS API, JAMS Gateway, JAMS Identity, and JAMS Web UI services are running in the Windows Services application.

Optional - Changing the Gateway Port

By default, 443 is specified in the configuration files. If port 443 is unavailable or a different port is required, you can select a new port. Ensure you use this updated port in the sections below as they list 443 as the default.

note

Ensure the HTTPS port is the same in both configuration files in the procedure below. If a load balancer is used, update the load balancer listener and target group port accordingly.

1. Open the JAMS Web Client installation folder at C:\Program Files\JAMS.
2. Open the Shared folder and open the settings.json file.
3. Update the port for both the "Url" and "InternalUrl" properties.

Example:

"Gateway": { 
"Url": "https\://myserver:8443", 
"InternalUrl": "https\://localhost:8443", 
"AllowSelfSigned": true 
}

4. Save and close the file.
5. Open the JAMS Gateway folder in the Shared directory and open the settings.json file.
6. Update the port in the "Urls" property.

Example:

{
  "Urls": "http\://+:8080;https://+:8443"
}

7. Save and close the file.

8. Restart the following services on the JAMS Web Client machine:

   1. JAMS API
   2. JAMS Gateway
   3. JAMS Identity
   4. JAMS Web UI

Adjusting Gateway Configuration Settings

Based on your environment, you may need to modify the Gateway configuration to ensure the JAMS Web Client is accessible. Review the procedure and table below to choose the option for your environment.

warning

The Gateway Url must be the exact hostname that end users type in their browser. If they do not match, you will see an "Invalid redirect_uri" message when logging in.

1. Open the JAMS Web Client installation folder at C:\Program Files\JAMS.
2. Open the Shared folder and open the settings.json.
3. Make changes to the Url option in Gateway section based on your environment. Example values are shown below. If you changed the port in the previous section, ensure you use the updated value in the examples below.
   
   Windows VM (Azure or AWS)

 "Gateway": { 
   "Url": "https://public-IPAddress:443", 
   "InternalUrl": "https://localhost:443", 
   "AllowSelfSigned": true 
 } 

Requirements and Notes

• Enter the public DNS or IP address for the JAMS Web Client.
• Add an inbound security rule in Azure to allow inbound TCP 443.
• Update the Windows Firewall to allow inbound TCP 443.

Windows VM (Azure or AWS) with load balancer

"Gateway": { 
  "Url": "https://myazure.centralus.cloudapp. azure.com:12345", 
  "InternalUrl": "https://localhost:443", 
  "AllowSelfSigned": true
}

Requirements and Notes

• Enter the load balancer public DNS name.
• The load balancer health probes must pass.
• The network security group must allow traffic from the load balancer to the VM.

Amazon EC2 instance via public DNS

"Gateway": {
 "Url": "https://ec2-11-222-33-44.compute-1 .amazonaws.com:443", 
 "InternalUrl": "https://localhost:443", 
 "AllowSelfSigned": true
}

Requirements and Notes

• Use the public IPv4 DNS for the EC2 instance.
• Update the AWS security group to allow inbound TCP 443.
• Update the Windows Firewall to allow inbound TCP 443.

Amazon EC2 instance via public IP

"Gateway": { 
 "Url": "https://192.168.1.1:443", 
 "InternalUrl": "https://localhost:443", 
 "AllowSelfSigned": true 
}

Requirements and Notes

• Update the AWS security group to allow inbound TCP 443.
• Update the Windows Firewall to allow inbound TCP 443.
• Auto-assigned public IPs change when the instance stops/starts. Use an Elastic IP if the address must be stable.

Amazon EC2 instance with load balancer

"Gateway": { 
   "Url": "https://myapp-lb-123456789. 
   us-east-1.elb.amazonaws.com:443", 
   "InternalUrl": "https://localhost:443", 
   "AllowSelfSigned": true 
}

With a custom domain:

"Gateway": { 
   "Url": "https://app.example.com", 
   "InternalUrl": "https://localhost:443", 
   "AllowSelfSigned": true 
}

Requirements and Notes

• Enter the load balancer URL or the EC2 public DNS name.
• The load balancer must be internet-accessible (not internal).
• The target group must have healthy targets.
• The security group must allow traffic from the load balancer to the EC2 instance on port 443.
• If you have a custom domain, a DNS record (CNAME or Route 53 alias) must point to the load balancer DNS.

4. Save and close the file.

5. Restart the following services on the JAMS Web Client machine:

   • JAMS API
   • JAMS Gateway
   • JAMS Identity
   • JAMS Web UI

6. From another machine, open a browser and navigate to the updated URL to confirm access to the JAMS Web Client.

Configuring Secure Communication

To have secure communication between the JAMS Web Client and the JAMS Scheduler, a Listener must exist on the JAMS Scheduler and a Connector must be created manually on the machine where JAMS Web Client is installed.

• The JAMS Scheduler/JAMS Agent and JAMS Web Client are on the same server.
• The JAMS Scheduler/JAMS Agent and JAMS Web Client are on different servers.

Listener Configuration

A Listener is automatically created on the JAMS Scheduler machine as part of the installer.

Key Points:

• A Listener uses Port 5773, which must be open between the JAMS Web Client and JAMS Scheduler.
• Only one Listener can be created per JAMS Scheduler.
• A Listener requires a root Certificate Authority, which is created by the installer.

Connector Configuration

Key Points:

• A Connector must be created manually on the JAMS Web Client machine after the Listener is created.
• A Connector is created by manually running the ADD SCHEDULER CONNECTOR command in the JAMSRegister application as described in the sections below.
  • Running the command requests a new certificate from the JAMS Server and stores it in the local machine store.
  • It also creates a SchedulerClient.config that is used by the JAMS Web Client.
  • If you change the location for the /CONFIGFOLDER, you will need to copy the SchedulerClient.config file to the JAMS API folder.

important

If you are recreating the Connector, delete the existing SchedulerClient.config first.

Before You Begin

Before you begin, confirm whether your JAMS Scheduler and JAMS Web Client are installed on the same server or on separate servers. The steps differ between these two configurations.

note

Opening port 5773 is a network or firewall configuration task. Confirm with your network or infrastructure team that this port is open between the JAMS Web Client and JAMS Scheduler before proceeding with the connector setup below.

Verify the Root CA and Scheduler Listener are on the JAMS Scheduler

1. Go to the JAMS Scheduler server.
2. Open C:\Program Files\MVPSI\JAMS\Scheduler.
3. Right-click JAMSRegister.exe and select Run as Administrator.
4. Run the command below to list the root CA and the Listener.

 LIST SCHEDULER CONFIGURATION

5. The lines starting with "Scheduler" are the important ones, and they indicate that the Listener is set up. In most cases, the "Scheduler Certificate Issuer" should be identical to the "Default Root CA Subject".

note

If there are no Scheduler lines, you need to run the following command in JAMSRegister:
ADD SCHEDULER LISTENER /NEWCERT
You will need to restart the JAMSScheduler service to apply this change.

6. Follow the steps in the section below that applies to your environment.

Option 1: Setting up the Connectors when the JAMS Scheduler/JAMS Agent and JAMS Web Client are on the same server

1. Go to the JAMS Scheduler server or JAMS Agent server.
2. Open C:\Program Files\MVPSI\JAMS\Scheduler or C:\Program Files\MVPSI\JAMS\Agent.
3. Right-click JAMSRegister.exe and select Run as Administrator.
4. Run the command below in JAMSRegister to add the Connector and create the SchedulerClient.config file.
   Ensure you update the /SERVER value and provide the path to JAMS API folder using /CONFIGFOLDER Parameter. The default path is used in the example below. If you change the location for the /CONFIGFOLDER, you will need to copy the SchedulerClient.config file to the JAMS API folder.

ADD SCHEDULER CONNECTOR /REQCERT /SERVER=<TargetJAMSSchedulerServerName> /CLIENTNAME=WebClient /CONFIGFOLDER="C:\Program Files\JAMS\JAMS API"

5. Verify the SchedulerClient.config file was created by running the command below.

   LIST CLIENT CONFIGURATION /CONFIGFOLDER="C:\Program Files\JAMS\JAMS API"

   

   1. A successful result shows both a Client Configuration line and a Connector Certificate Issuer line. If only the Client Configuration line appears, the connector was not created successfully - run the ADD SCHEDULER CONNECTOR command again.
   2. Verify the "Connector Certificate Issuer" is identical to the "Scheduler Certificate Issuer" displayed in the step from Verify the Root CA and Scheduler Listener are on the JAMS Scheduler.

6. Open the Windows Services application and restart the JAMS API service.

Option 2: Setting up the Connectors when the JAMS Scheduler/JAMS Agent and JAMS Web Client are on different servers

1. On the JAMS Scheduler server, create a temporary folder, such as c:\TEMP.
2. Open C:\Program Files\MVPSI\JAMS\Scheduler.
3. Right-click JAMSRegister.exe and select Run as Administrator.
4. Run the command below to export the root Certificate Authority into a file in the c:\TEMP folder.

EXPORT ROOT CA /FILENAME="c:\TEMP\root.cer"

5. Run the command below to create a SchedulerClient.config file in the c:\TEMP folder.

ADD SCHEDULER CONNECTOR /REQCERT /SERVER=localhost /CLIENTNAME=WebClient /CONFIGFOLDER="c:\TEMP"

6. Open the SchedulerClient.config file from c:\temp and copy the thumbprint value from the "Thumbprint": property because it is needed for the next step. The thumbprint is a 40-character hexadecimal string, for example: A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2. Copy the value only, without the surrounding quotation marks.
7. Run the command below to export the certificate by thumbprint.
   Ensure you update the value for the /THUMBPRINT.

EXPORT SCHEDULER CONNECTOR CERTIFICATE /FILENAME="c:\TEMP\connector.cer" /THUMBPRINT=<The thumbprint taken from SchedulerClient.config> /PROMPT

8. When prompted, enter a password to protect the certificate. You will need this password when importing the certificate on the JAMS Web Client machine in a later step. Confirm the password when prompted.
9. Create a zip file of the files in the TEMP folder, including the root.cer, SchedulerClient.config, and connector.cer files.
10. Transfer the zip file to the JAMS Web Client machine using your preferred method, such as a shared network path. Unzip the contents to a temporary location on that machine.
11. Copy and paste the SchedulerClient.config file into C:\Program Files\JAMS\JAMS API.
12. Open the certlm tool "Manage Machine Certificates".
13. Import the root.cer file into the "Trusted Root Certification Authorities" Certificates folder.
14. Import the connector.cer file into the “Personal” Certificates folder.
15. Enter the password you entered when exporting the file in a previous step.
16. Open the Windows Services application and restart the JAMS API service.

Next Step

Creating an Admin/Service User