Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Gateway Data Publisher

Components of AVEVA Gateway Data Publisher

  • Last UpdatedMay 08, 2025
  • 4 minute read

After the AVEVA™ Gateway Data Publisher is installed, the options GDP Documentation, GDP Service Manager, Run Gdp Manager Example, Run Gdp Manager Add Token, and Run Gdp Manager Shutdown All are available in the Start menu.

Note: The corresponding .bat files are available in the installation location (<install location>\Examples\Startup).

You can use the options in the following manner:

  • The GDP Documentation option enables you to open the Gateway Data Publisher user documentation on a webpage.

  • The GDP Service Manager option enables you to run the AVEVA™ Gateway Data Publisher as a Windows service. For more information about the GDP Service Manager tool, see Running AVEVA Gateway Data Publisher as a Windows Service.

  • The Run Gdp Manager Example option enables you to run AVEVA™ Gateway Data Publisher as a command line process where you can view live feedback. This is helpful with establishing stable configuration for all instances before using AVEVA™ Gateway Data Publisher as a Windows service.

    Note: Before you click the Run Gdp Manager Example option, you must make sure that you have completed the activities mentioned in Before Using AVEVA Gateway Data Publisher.

  • The Run Gdp Manager Add Token option enables you to add the access tokens for AVEVA™ Gateway Data Publisher. See Adding Access Tokens for AVEVA Gateway Data Publisher for information on how to set the access token.

  • The Run Gdp Manager Shutdown All option enables you to close all instances of AVEVA™ Gateway Data Publisher. Information about how to use this option is provided later in this section.

Running the AVEVA Gateway Data Publisher Example

On clicking the Run Gdp Manager Example option, the following consoles are displayed.

  • AVEVA Gateway Data Publisher <Release No>-<date> (Manager): This console is the main console of AVEVA™ Gateway Data Publisher. It displays if AVEVA™ Gateway Data Publisher is running and, if yes, how many instances of it are currently running and the staging areas of each instance.Closing this console closes all the instances of AVEVA™ Gateway Data Publisher. The following image provides an example for this console.

  • AVEVA Gateway Data Publisher <Release No>-<date>: <gateway instance, watched directory>: Based on the number of instances of AVEVA™ Gateway Data Publisher, you can see more than one of this console. This console displays the log details of the respective AVEVA™ Gateway Data Publisher instance. Closing this console closes the AVEVA™ Gateway Data Publisher instance. The following image provides an example of this console.

    Note: The above consoles are not displayed if you are running the AVEVA™ Gateway Data Publisher as a Windows service. In such cases, you must view the log file available at the logs location path to view the log messages.

In addition, based on your configuration, few files are available at the installation location of AVEVA™ Gateway Data Publisher (<install location>\Examples\Configuration). The following image shows an example of these configuration files.

The files can be modified to suit your requirements. The following table describes the purpose of each file.

File Name

Purpose

InitGdpCfg.json

Specifies how to run the AVEVA™ Gateway Data Publisher instances. Enables you to turn the corresponding consoles on or off. For detailed information about this file, see Creating AVEVA Gateway Data Publisher Instances.

FiltersConfig.json

Contains the file extensions for each AVEVA™ Gateway Data Publisher instance that need to be considered for publishing. For detailed information about this file, see Specifying Filters.

<GatewayName>ServiceConfig.json

Contains the configurations for the corresponding AVEVA Gateway. For more information about this file, see Configuring AVEVA Gateway Data Publisher for Your AVEVA Gateway.

Mappings.xlsx

Contains the mappings for creating metadata. Can be an XLS, XLSX or a CSV file. For more information about this file, see Specifying Mappings for Metadata Attributes Using an Excel File.

Note: The end users do not have to monitor the components. They can directly view the data in AVEVA™ Asset Information Management.

Closing All Instances of AVEVA Gateway Data Publisher

On clicking the Run Gdp Manager Shutdown All option, a .bat script is run that closes all the AVEVA™ Gateway Data Publisher instances, which means that all processes related to AVEVA™ Gateway Data Publisher are stopped or shut down.

To start the AVEVA™ Gateway Data Publisher processes again, you must run the Run Gdp Manager Example option.

In This Topic
TitleResults for “How to create a CRG?”Also Available in