TWebServices

Overview

TWebServices is built-in component within the software platform. It enables external interactions by providing a web interface and APIs, allowing for remote system monitoring, control, and integration with other software components.

The TWebServices is simple solution, no configuration required, it implements the execution of Web Services, including the TProjectServer service, necessary to allow remote to access to the solution configuration.
The product installation, by default, uses the port 10108 and the entry point for TWebServices.

On this page:

TWebServices Setup

When is Required

TWebServices is not automatically added to run as a Windows Services during the product installation. It is only necessary to enable its execution if you want the solution files in your computer to be accessible for the configuration tools, or the SolutionsManager tool, running in remote computer. It also enables the WebUI to the Solutions Manager. When the service is enable, you can from another computer, where the product is NOT installed, just open the URL: http://<Server IP or Name>:10108/solutions.
Example: http://192.169.1.1:10108/solutions

This command will start the SolutionsManager in the remote computer accessing the solution files of the target computer.

Setup Process

In order to enable the execution of TWebServices, just follow the steps:

Step 1 - Open FrameworX, then navigate to the "Server Information", with a mouse-click on the title "Server Information", on the top-left side of the screen.

Step 2 In Add Services, click WebServices and Ok

After installation is complete:

If Windows open a dialog requesting Security elevation, accept it.

The Command prompt window will close automatically after the setup process is concluded.

The "Process Running" field in the Server Information dialog, doesn't have background refresh. If you want to know if the services are running (or if a solution is running with the TServer process), click the refresh icon.

Execution in Linux and Other Platforms

The process described can only be executed in a Windows Computer, as the web ui for the Solutions Manager doesn't have the options to setup services.

To installing in Linux, you can manually copy the files from the windows installation folder, located in the subfolder, "FrameworX/net8.0/", copying it to Linux folder "/home/FrameworX/", and run the TWebServices from there, or you can the automated tools to install the software components in Linux.

For more information, go to page Linux Deployment.

Preventing Ports Conflict

If you have error messages during the setup, or if you are not able to remotely connect with your server, you need to verity the ports in use you computer, making sure no other application is also using the port 10108, you can use the Command Prompt window to run:

netstat -aon

This will display all the ports in use. Look after 10108 string sequence on the Local Address column and get the PID (process identification).

tasklist

This will display all the process names and their identifications, so you can find which one is using the port 10108.

If the application using Port 10108 is an application you can stop it and use the standard Product installation; otherwise you need use the TWebServices n another port.

Custom Port Setup

This procedure describes how to run TWebService in another port.

Step 1 - Access the directory: C:\Users\Public\Documents\FrameworX\MachineSettings\

Step 2 - Edit the TWebServices.json file, by right clicking on it and selecting “Edit”in Notepad.Then, change the parameter “portnumber” by typing the desired port number: