Configure MeasDataProtectorSettings​.json

MeasDataProtectorSettings lists all the application-level configuration needed for the AVEVA Measurement Advisor File Import.

Warning: Do not modify the MeasDataProtectorSettings.json file located in %DNAInstallRoot%\MeasurementAdvisor\config\Settings. When copying the file to the %DNADataRoot% directory, copy the entire file and not just those settings that are changing.

1. If the MeasDataProtectorSettings.json file does not exist in %DNADataRoot%\MeasurementAdvisor\config\Settings, copy the file in %DNAInstallRoot%\MeasurementAdvisor\config\Settings to %DNADataRoot%\MeasurementAdvisor\config\Settings.

2. Edit the MeasDataProtectorSettings.json file located in %DNADataRoot%\MeasurementAdvisor\config\Settings to define your configuration.

   Note: The ProtectionRules must be set before using the SecretProtector to encrypt the service access token. If ProtectionRules is not set up, they may get a message like: The server could not be contacted.

3. For more information, see the content below.

   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. See Prepare to obtain your CONNECT access token.
   Secret Protector Section
   ProtectionRules	Protection rules define which users can use the secrets that have been protected. In the event that you are on a domain, you can choose how you want your protection rules to be configured — for a local install or a domain install — but in the event that you are not associated with a domain, you will only be able to configure a local installation. For a local installation: Setting this to LOCAL=user means that only the user that encrypted the secret can unencrypt it. Setting this to LOCAL=machine means that only the user local to the computer can unencrypt the encrypted secret. For a domain installation: On a domain installation, set this to a comma-separated list of Active Directory group names. Only users belonging to at least one of the groups can decrypt protected strings. Changing the protection rules: If the protection rules need to be changed, you must delete the keyring files in %DNADataRoot%\MeasurementAdvisor\config\keyring. The old keyring files keep the protection rules descriptor even if it has been changed in MeasDataProtectorSettings. The keyring needs to be deleted and recreated in order to update the protection rules.

4. To test that this has been correctly configured, execute the following command: .\MeasFileImport.exe -T UNDEFINED -S CLOUDDB

   It should record an error in the MeasFileImport.log file that reads:

   Could not retrieve details for the file import task(s) "Undefined".

   Here, UNDEFINED is used as an example. Any non-existent file import task would be sufficient to test the functioning of the configuration.

Sample MeasDataProtectorSettings.json file:

To obtain the <Encrypted String> shown in the sample MeasDataProtectorSettings.json file, see Prepare to obtain your CONNECT access token.

{

"SystemConfiguration": {

"DataGateway": {

"EncryptedServiceAccessToken": "<Encrypted String>",

}

},

"Protector": {

"ProtectionRules": "LOCAL=user"

}