Adding Access Tokens for AVEVA Gateway Data Publisher

Access tokens are an authentication mechanism adopted by AVEVA. An access token must be set for using an instance of AVEVA™ Gateway Data Publisher. AVEVA™ Connect provides two types of access tokens.

• Account Access Token: Though Account Level Token has the highest level permission, it will still restrict the user from uploading the homepage and configuration files.

• Service Access Token:This type of access token can be used for uploading the data or configurations depending on role which was assigned to it. Access is granted according to the following rules:

  • Service Access Token created with the “Data Pipeline User” role grants the user permission to upload all files except the homepage and config files.

  • Service Access Token created with the “AIM Configuration” role grants the user permission to specifically upload only the homepage and config files.

Starting version 1.2, AVEVA™ Gateway Data Publisher enables you to add multiple access tokens for use with AVEVA™ Gateway Data Publisher and specify which token must be used for an instance.

To add multiple access tokens to AVEVA™ Gateway Data Publisher using the command line:

1. Generate the token in CONNECT with the required folder/role.

2. Run the RunGdpManagerAddToken.bat file as an administrator from the <installation location>\AVEVA Gateway Data Publisher\Examples\Startup folder.

3. On the command window that appears, paste the token you generated and press Enter.

4. Specify a name for the token or press Enter to accept the name "default". The token is added with the name.

5. Repeat Steps 1 through 4 for adding more access tokens.

   Note: You can edit the name of an access token or delete an access token using commands. For full list of commands for AVEVA™ Gateway Data Publisher, see Help Commands for AVEVA Gateway Data Publisher.

To add access tokens using GDP Service Manager:

6. Generate the token in CONNECT with the required folder/role.

7. Run the GDP Service Manager from the Start menu.

8. In the Authentication area, click + to add an access token.

9. For the Name box, provide a name for the token.

10. For the Value box, paste the token generated from CONNECT.

11. Click Save to save the token. The token is added.

12. Repeat Steps 1 through 6 for adding more access tokens.

    Note: You can edit the name of the token or delete a token using the Edit and Delete options on the GDP Service Manager.

After adding the access token, it can be used for an instance of the AVEVA™ Gateway Data Publisher. For information on how to use an access token for an instance, see Configuring AVEVA Gateway Data Publisher for Your AVEVA Gateway.

If the existing token reaches expiry date, gets compromised, or is deleted by an CONNECT administrator, you must specify a new access token. For information on how to generate an access token, refer to the documentation of CONNECT.