Configuring AVEVA Gateway Data Publisher for Your AVEVA Gateway

Save PDF

Last UpdatedApr 28, 2025
5 minute read

All configurations for AVEVA™ Gateway Data Publisher for the required AVEVA Gateways are available in the <GatewayName>ServiceConfig.json file available at the following location: <install location of the gateway data publisher>\Examples\Configurations.

Note: If the location does not contain a file for any of your required AVEVA Gateways, then you must create a file in the same syntax and then create an instance for it using the InitGdpCfg.json file. For information on how to create an instance, see Creating AVEVA Gateway Data Publisher Instances.

The following image provides an example for an AVEVA™ E3D Design (Model) gateway.

The following table describes the parameters available in the file.

Location	Parameter Name	Purpose
Code Block 1	Logger > OutputPath	Specifies the location of the log file for the instance. The log files are generated in text document and JSON formats.
Code Block 1	Logger > LogLevel	Specifies logging level. Accepted values are "Error", "Warning", "Information", and "Trace".
Code Block 2	Triggerer > Delay	Specifies the time (in d:hh:mm:ss:ms) to be allowed after the availability of the trigger.start file.
	Triggerer > FileChanges	Specifies the file that should trigger the publish activity. By default, the trigger.start file used to trigger the publish activity. But any file can be configured as a triggerer using the FileFilter parameter. The file name must be specified in the glob format.
	Triggerer > Schedule	Enables you to auto-schedule the publish activity irrespective of whether a triggerer file is available or not. A publish activity is triggered for every time interval specified in the Interval parameter. The parameter accepts the time interval in the d:hh:mm:ss:ms format.
Code Block 3	Enqueuer > IgnoreFileFilters	Specifies the list of files that must be ignored while publishing. You can specify more than one file by using comma (,). The file name must be specified in the glob format.
	Enqueuer > DeleteFileFilters	Specifies the list of files that must be deleted after the publish activity is triggered. You can specify more than one file by using comma (,). The file name must be specified in the glob format.
	Enqueuer > IgnoreDeltaFilters	Specifies the list of files or folders that must always be published irrespective of whether they have been changed or not. You can specify more than one file or folder by using comma (,). The file name must be specified in the glob format. You can use this parameter in cases where you need to publish the entire data as a package and not just the changed data. Note that this parameter does not override the filters. Only the files that are passed by the filters are ignored for delta changes.
Code Block 4	Processor > Tables	Specifies the parameters for accepting an XLS, XLSX or a CSV file that contains the mappings for the metadata attributes. For more information, see Specifying Mappings for Metadata Attributes Using an Excel File.
	Processor > Rules > FilterId	Specifies the Id of the filter that needs to be applied while running the instance. For information about how to specify filters, see Specifying Filters.
	Processor > Rules > Actions	Specifies the list of actions that need to be performed for the given filter Id. Metadata attributes that are required for AVEVA™ Ingestion Service can be set through this parameter.
	Processor > Rules > Targets	Defines one or more target publisher names that will be used for publishing the data that passed trough filters. Default Gateway Data Publisher installation comes with two publisher target names: IngestionService and FakeService. IngestionService publisher performs actual publishing of data trough Data Pipeline Ingestion Service, these settings can be modified in another part of configuration (Code Block 5 - Publisher). FakeService performs simulation of publishing by logging information if data passed the filters and the type of metadata attached to it. If Targets property is not specified for a rule, IngestionService target will be used as default.
Code Block 5	Publisher > Token Name	Specifies the name of the access token that must be used to this instance of the AVEVA™ Gateway Data Publisher. For more information about access tokens and how to use them for AVEVA™ Gateway Data Publisher, see Adding Access Tokens for AVEVA Gateway Data Publisher.
	Publisher > BatchFileUploadLimit	Specifies the upper limit for the number of files in a batch publishing.
	Publisher > DelayBetweenRetries	Specifies the time interval (in the d:hh:mm:ss:ms format) between connection retries.
	Publisher > HttpTimeout	Specifies the timeout when the server does not respond within the specified timeout period.
	Publisher > MultiPartUploadPartSize	Enables you to define the file size for single uploading process. The uploading of file happens in the bundle or package process.
	Publisher > ConnectionRetries	Specifies the number times a connection is attempted in case of a network failure. After the number of attempts specified here are completed, the AVEVA™ Gateway Data Publisher pauses for the time specified in the DelayBetweenRetries parameter before resuming attempts.
	Publisher > DefaultEndPointUrl	Specifies the URL to which AVEVA™ Ingestion Service must publish the data. A valid URL must be specified before running AVEVA™ Gateway Data Publisher.
	Publisher > DefaultAssetId	The folder or account name using which the access token has been generated. A valid asset Id must be specified before running AVEVA™ Gateway Data Publisher.

Some Points about Rules

The following points about rules must be noted:

A rule is defined by the filter id and set of actions.
Each rule will run the defined actions if the filter passes the processed file.
The action defines what ingestion parameter should be set on processed file.
A filter is defined by its type, id and conditions. There is currently only one filter type available :
- FileNameFilterCfg - it allows to use the ‘PassFiles’ condition, that can contain regular expressions to pass the processed file by its name and extension.

Modifying Your Configurations

You can modify the <GatewayName>ServiceConfig.json file anytime, even when the AVEVA™ Gateway Data Publisher is running. After you make the changes and save the file, the AVEVA™ Gateway Data Publisher automatically detects the changes and recompiles the rules according to the changes made, without having to be restarted.

The changes are detected in the following sections: Logger, Tables, Rules, and Publisher. Changes in StagingAreaWatcher section are not detected, hence they won't be applied.

Each time a section change is detected, a console message is displayed informing you about it. If a change is made while the publishing process is in progress, AVEVA™ Gateway Data Publisher waits for the publishing process to complete before using the updated configuration. If there is no publishing process running while configuration section change is detected, the updated configuration is applied almost immediately.

The changes are not applied or discarded by the AVEVA™ Gateway Data Publisher in the following circumstances:

If the updated configuration contains a JSON schema error, the change is not detected and the old configuration will be used.
If the updated configuration contains a GDP schema error (for example, the entire Logger section is missing), the old configuration setting will be used for this particular section. This means that other valid configuration changes will be applied.
According to the point above, if the user removes the "Logger" section and restores it with the same settings as before removal, the configuration change is not detected because the used settings did not change at all.

AVEVA™ Gateway Data Publisher