How to Configure a Remote Collector (version 26)

*Starting in v26.6, ALL Collectors installed remotely from the destination Historian must be configured with a valid API token. Data will buffer on the Collector machine until it is configured so.

If Tag Security is enabled within the Identity service, a remote Collector will not be able to write to the Historian. The SaF service on the Collector server must be configured to use an API token. *If Tag Security is not enabled or the Collector is local to the Historian, the following procedure need not be completed.

Each API token is linked to an internal Canary user. In this case, that Canary user must be given write permissions to the Historian view or DataSet(s) within the Historian. See SaF to a Remote Historian where Tag Security is Enabled for more details.

Configuration

1. Create an API token within the Identity service if one is not already available. The Identity service is typically installed on the Historian server. The token will need copied to the Collector server.

   

2. Add the Canary user linked to the token to the Historian View/DataSet within Identity tile>Security>Tag Security and give it Write permissions.

   

3. Open the Canary Admin client on the Collector server and navigate to the Store and Forward tile>Configuration>Settings screen.
4. Paste the API token into the Identity API Token field.

   

5. Click APPLY.