vizgateway.yaml - Integration - Ver. - Administration & Configuration - Hexagon

HxGN VDS Install and Setup

Search by Category
Administration & Configuration
VDS Version

The vizgateway.yaml file is the main settings file used to configure the Visualization Edge Gateway Service. This configuration file contains the admin and static_resources sections.


Contains the information required to connect to the administration port of the gateway service. By default, this administration port is limited to the local system on port 2241. This service is typically not required, and these values do not have to be changed.


Specifies the file that the administration port accesses are logged.


Specifies the address information used to connect to the administrator port.


Specifies the TCP/IP address information used to access the administrator port.


Specifies the protocol by which the administration port can be accessed.


Specifies the address to which the administration port responds.


Specifies the port value upon which the administration port listens for connection.

Code Example:


Details the apportionment of the services that are prepared to accept connections from outside of the local server. This section contains the addresses and filters used to separate requests to the proper local resource, and the rules required to translate the requests into the format required by each particular service.

We recommend that you do not modify this section without experience in networking and application proxy configuration. Only the sections used by the most common implementation and setup are provided in the list below.


Monitor connections on a port and apply filter chains to route these connections. The remaining section describes listener services used by the Visualization Edge Gateway Service. The service uses only one static listener object of moderate complexity.

Listener objects generally provide an externally visible listening address and the filter chains used to route the traffic between endpoints. This listener address specifies details of the TCP/IP address used as the external interface to the gateway.

Code Example:

Listeners provide a list of filters that are applied for each connection and the rules used to route requests to the individual service handlers. This list of filters is given in the form of a filter chain. Each filter in the filter chain provides a name, a typed_config, and a route_config.

The typed_config describes the request coming from the external listener address and lists details about how the individual request must be handled at a network connection granularity. Because VDS services can handle large amounts of data on distant servers with various caching options, we recommend that timeouts be disabled to allow high latency requests to connect correctly to the gateway service.

Code Example:

The route_config describes the internal route that the request takes to be delivered to services located inside the gateway boundary. These services include VDS requests and description queries. The internal route configurations make up the bulk of the configuration file; not all of the configurations used are included in the code example shown below.

Code Example:


Provides http-level operations performed on incoming requests.

We do not recommend modifying this internal function.

Code Example:


Provides transport-level details of transactions for the gateway service. This section primarily provides Transport Layer Security (TLS) certificates and keys used to provide secure TLS v1.2 based connections to clients external to the gateway service. The same certificate must be used in this section as the certificate used by the web server upon which the VDS server operates. This allows the Visualization Edge Gateway Service to operate transparently with respect to client connections.

Code Example:


Lists constraints on the runtime operation of the gateway service. These constraints allow the Visualization Edge Gateway Service to run within reasonable processing, memory, and network latency and bandwidth limits. These limits have been tested for consistent performance for a variety of system configurations and loads. Because the Visualization Edge Gateway Services are rarely a problem in properly sized and scaled deployments, we do not recommend modifying these parameters for performance optimization.

Code Example: