Manually run Studio Database Gateway

By default, Studio Database Gateway is run automatically when you run your project. But in some cases, you might need to manually run it.

Studio Database Gateway is installed as part of project runtime software. When your project is configured to connect to an external database and you use any of those runtimes to run your project, the project itself will try to automatically run the locally installed database gateway. This is reflected in the default database configuration in your project: the project looks for the database gateway at IP address 127.0.0.1 (that is, localhost), port 3997, as shown in the screen shot below.

If you do not need to change the configuration or access the database gateway's advanced features — that is, if you keep the default settings and simply run your project as is — you might never have occasion to manually run the database gateway. There are several reasons you might do so, however:

• If you have installed the Studio Database Gateway software on another computer, where the project runtime software cannot automatically run it;

• If you want to access the database gateway's advanced features while your project is not running;

• If you want to run the database gateway on a port other than the default port 3997; or

• If you want to run multiple instances of the database gateway on different ports.

When the Studio Database Gateway software is installed on another computer, it adds a shortcut to the Start menu, so you can use that to run it: click the Start button, and then, on the Start menu, click All Programs > Studio Database Gateway > Studio Database Gateway. (This option is not available for the version of Studio Database Gateway that is installed as part of the project runtime software.) The Studio Database Gateway icon appears in the notification area, at the far right of the Windows taskbar, to show that the program is running.

Otherwise, to manually run the database gateway, you must know where the Studio Database Gateway program file (StADOSvr.exe or StADOSvrCE.exe) is actually located. When it is installed as part of the project runtime software, it is located in the same program folder. The default location of the Studio Database Gateway program file is:

C:\Program Files (x86)\AVEVA\AVEVA Edge 2026\Bin\DatabaseGateway\StADOSvr.exe

When the Studio Database Gateway software is installed on another computer, the program file should be located at:

C:\Program Files\Studio Database Gateway 2026\StADOSvr.exe

In both cases, if you want to run a single instance of the database gateway on the default port 3997, simply double-click the program file. If you want to run the database gateway on a port other than the default port 3997, or if you want to run multiple instances of the database gateway on different ports, open a Command Prompt window and then type the following:

StADOSvr.exe <port number>

For example:

StADOSvr.exe 3998

There is no limit on the number of instances that you can run, as long as you have the necessary system resources and unused ports. For each instance, its port number, in this case 3997, is displayed in the title bar of the program window, as shown in the screen shot below.

Whenever you run Studio Database Gateway, you should note the host name or IP address of the computer and the number of the port on which the database gateway is running. You will need this information in order to update the database configuration in your project.

The account that runs the gateway is the account used when a Trend worksheet uses Use Gateway Credentials.

The project user, the logged-on Studio user and the account of a runtime on another computer are never passed to the gateway. For more information, see Configure Historian authentication.

Running Studio Database Gateway as an Administrator

Starting with version 20.0.3.0 of AVEVA Edge, some security features require the Studio Database Gateway to by run as an administrator in Windows. The steps to do this are:

1. Right-click on StADOSvr.exe, and select Run as administrator from the context menu.

   

2. A Windows User Account Control dialog will open. Select Yes to continue.

   

3. You can now continue as described above. If you open an instance of Studio Database Gateway, the File menu will now have more active options:

   

One gateway can serve only one credential mode, because AVEVA Historian Integrated Security applies to the whole gateway. To use both modes, run a second gateway on another TCP port from a separate copy of the gateway folder with its own StADOSvr.ini.

For more information on these options, see Studio Database Gateway.