CONNECT Service Access Token for ACMsettings.json
- Last UpdatedAug 27, 2024
- 2 minute read
Access tokens are authorization pass codes that you, as an account Administrator, generate and use in the ACMsettings.json file to enable the transmission of your data from an on-premises installation so that it can integrate with CONNECT applications.
Note: The expiry time of a service access token is set at the time that you create the token. Once a token expires—at an interval defined by your security policy—you must create a new one and update your configuration. For more information, see Check if Encrypted Connections Need Updating.
You will need to retrieve the access token from CONNECT and encrypt it as per the following procedures.
To generate the service access token
-
Generate and retrieve an AVEVA Measurement Advisor Advanced Service access token from CONNECT. For more information on obtaining the token, see Use Access Tokens and its subsections beginning at https://docs.aveva.com/bundle/aveva-connect/page/788600.html. When defining your advanced service access token, select the correct Service and Folder.
-
When configuring the group, select the following roles:
-
Meas Viewer
-
Meas AOR Config
-
Meas Data Entry Meter
-
Meas Data Entry GQ
-
Meas Data Entry Config
-
Meas Data Entry Event
-
Meas SCADA Commands
-
To encrypt the service access token
-
On the AVEVA Measurement Advisor Data Connector for ACM server, log on as a member of at least one of the Protected Rules groups defined in the the ACMsettings.json configuration file.
-
Select Start > Windows Powershell.
Windows PowerShell for DNA opens.
-
Execute the following commands:
Notes: For the Request Connector, perform these steps in the ACM silo (%DNAInstallRoot%\ACM\bin).
For the Data Connector, perform these steps in the CloudData silo (%DNAInstallRoot%\CloudData\bin).-
Enter cd %DNAInstallRoot%\<silo>\bin.
The above command points to the directory containing the folder where AVEVA Measurement Advisor Data Connector for ACM is installed.
-
Enter SecretProtector.exe protect "<Access Token Copied From AVEVA Connect>".
The above command creates and stores the key ring information in %DNADataRoot%\ACM\config\keyring (for the Request Connector) and %DNADataRoot%\CloudData\config\keyring (for the Data Connector). The key ring protects the access token by means of an encrypted key.
-
Copy the protected string (the output of the command in step c. above), and paste it into the EncryptedServiceAccessToken section of the ACMsettings.json file.
-
In the event that you have a dual-hosted AVEVA Measurement Advisor Data Connector for ACM, repeat steps 1–3 on the second server.
-