Configure ACMsettings​.json

ACMsettings.json lists all the application-level configuration needed for the AVEVA Measurement Advisor Data Connector for Autosol Communication Manager (ACM). Use the file to set such configuration as batch limit, connections strings, and SCADA environments.

When your AVEVA Measurement Advisor Data Connector for ACM product must support multiple SCADA systems, set the ScadaEnv field to the name of the Autosol Communication Manager system served by this data connector. The ScadaEnv setting is used to create a dataset in the Measurement Advisor database. If meter/GQ names have the same names across systems, they will be made unique by the pre-pending of the related scadaEnv to the names. The default ScadaEnv value is NULL, which is for a single SCADA system.

Warning: Do not modify the ACMSettings.json file located in %DNAInstallRoot%\<silo>\config\Settings.

Note: The ACMsettings.json file must be configured on each server and in each silo (ACM and/or CloudData). When copying the file to the %DNADataRoot% directory, copy the entire file and not just those settings that are changing.

1. If a file named ACMsettings.json does not exist in %DNADataRoot%\<silo>\config\Settings, copy the file in %DNAInstallRoot%\<silo>\config\Settings to %DNADataRoot%\<silo>\config\Settings.

2. Edit the ACMsettings.json file located in %DNADataRoot%\<silo>\config\Settings to define your configuration. For more information, see the content below.

3. Once the file has been configured, restart the services to load the changes.

   Key Name	Description
   System Configuration Section
   EncryptedServiceAccessToken	Set to the encrypted service access token used to authenticate with CONNECT to transfer data to the cloud endpoint. For further information, see CONNECT Service Access Token for ACMsettings.json. Note: This can be blank if you are not connecting to Measurement Advisor in the cloud.
   EndpointURL	This is the base address for the data gateway endpoint. The data gateway is used as a web service through which the AVEVA Measurement Advisor client accesses the database to execute stored procedures. Set the EndpointURL to the Azure environment you will be connecting to. See the Sample File below and note that ".../ca/..." refers to a Canadian Azure location, and ".../us-east/..." refers to an East Coast U.S. Azure location.
   WebProxy	Enter the address of your organization's web proxy. If internet access passes through a proxy, the data access layer requires this setting. The format is <IP>:<Port>. For example, if the web proxy URL is http://10.0.0.1:8080, enter the following: "10.0.0.1:8080".
   EncryptedACMConnection	Update the value to the encrypted value of your buffer database connection string. For more information, see Encrypted Microsoft SQL Server Connection Strings for ACMsettings.json. Note: This can be blank if the Request Connector is on a separate server since it does not require access to the buffer database.
   EncryptedMeasurementConnection	Update the value to the encrypted value of your AVEVA Measurement Advisor SQL server connection string. For more information, see Encrypted Microsoft SQL Server Connection Strings for ACMsettings.json. Note: This can be blank if you are not connecting to an on-premises Measurement Advisor.
   ScadaEnv	When there are multiple Autosol Communication Manager systems connected to a single Measurement Advisor system, then set the ScadaEnv to a unique identifier for that Autosol Communication Manager system. The name used is arbitrary. In this case, set the configDesc item CD_MULTIPLE_SCADA_ENV to Y in AVEVA Measurement Advisor.
   MonitorACM Section (configuration specific to the Data Connector)
   BatchLimit	Enter the maximum number of records to include in each batch of records transferred.
   MonitoredStoredProcedures	The default list is [ "writeCombinedMtrGQRawHy", "writeCombinedMtrGQRawDy", "writeObjectEvent", "writeCombinedMtrConfigGQRecord", "scadaProcessListCheckin" ].
   DatabaseCheckInterval	Enter the required amount of elapsed time in seconds between database check ins.
   ProcessCheckInInterval	Enter the required amount of elapsed time between process check ins in seconds. This should be greater than the DatabaseCheckInterval. If it is not, it will be set to the DatabaseCheckInterval plus 300 seconds (5 minutes).
   MaxNumberOfRetriesPerBatch	Enter the maximum number of retries a batch will undergo if its first transfer attempt fails.
   MaxNumberOfRetriesPerRow	Enter the maximum number of retries an individual record will undergo if its first transfer attempt fails.
   OnPremMeasurementTransferEnabled	If you are using an on-premises version of AVEVA Measurement Advisor, set OnPremMeasurementTransferEnabled to true. Note: OnPremMeasurementTransferEnabled and CloudMeasurementTransferEnabled can be simultaneously enabled, if required.
   CloudMeasurementTransferEnabled	If you are using a cloud version of AVEVA Measurement Advisor, set CloudMeasurementTransferEnabled to true. Note: OnPremMeasurementTransferEnabled and CloudMeasurementTransferEnabled can be simultaneously enabled, if required.
   MSBuildLocation	Set to the location of the MSBuild.exe file. This is used by the ACMDataInterfaceGenerator.exe.
   LogLevel	The level of logging used by the monitor process. The default is 2. The log levels used by the monitor process are: 2 - Always 6 - Verbose
   MonitorMeas Section (configuration specific to the Request Connector)
   MonitoredStoredProcedures	The default is [ "scadaGQDownloadGet" ].
   MaxNumberOfRetriesPerRow	Enter the maximum number of retries an individual record will undergo if its first transfer attempt fails.
   TimeoutPerRow	Enter the elapsed time after which a timeout should occur on a data transfer (due to a slow network).
   DatabaseCheckInterval	Enter the required amount of elapsed time between database check ins.
   LogLevel	The level of logging used by the monitor process. The default is 2. The log levels used by the monitor process are: 2 - Always 6 - Verbose
   Secret Protector Section
   ProtectionRules	Enter your system's protection rules. The default is "AVEVA Apps". For more information, see Data Protection Settings for ACMsettings.json.
   BufferDatabase Section
   DbName	Enter the name of your system's buffer database. The default is "EFM".

Sample ACMsettings.json File:

{

"SystemConfiguration": {

"DataGateway": {

"EncryptedServiceAccessToken": "<Encrypted String>",

"EndpointURL": "https://measadv.connect.aveva.com/ca/datagateway/api/v1/measconnection/",

"WebProxy": ""

},

"EncryptedACMConnection": "<Encrypted String>",

"EncryptedMeasurementConnection": "<Encrypted String>",

"ScadaEnv": "ACM1"

},

"MonitorACM": {

"BatchLimit": 10,

"MonitoredStoredProcedures": [ "writeCombinedMtrGQRawHy", "writeCombinedMtrGQRawDy",

"writeObjectEvent", "writeCombinedMtrConfigGQRecord", "scadaProcessListCheckin" ],

"DatabaseCheckInterval": 150,

"ProcessCheckInInterval": 300,

"MaxNumberOfRetriesPerBatch": 10,

"MaxNumberOfRetriesPerRow": 5,

"OnPremMeasurementTransferEnabled": true,

"CloudMeasurementTransferEnabled": false,

"MSBuildLocation": "C:\\Program Files (x86)\\Microsoft Visual Studio\\2022\\BuildTools\\MSBuild\\Current\\Bin\\MSBuild.exe"

},

"MonitorMeas": {

"MonitoredStoredProcedures": [ "scadaGQDownloadGet" ],

"MaxNumberOfRetriesPerRow": 5,

"TimeoutPerRow": 300,

"DatabaseCheckInterval": 10

},

"Protector": {

"ProtectionRules": "AVEVA Apps"

},

"BufferDatabase": {

"DbName": "EFM"

}

}