Modify a Collector Instance | Historian for Cloud 2024 Documentation

Before you begin

Stop the collector whose instance you want to modify.

About this task

This topic describes how to modify the destination details of a collector instance using the RemoteCollectorConfigurator utility. You can also modify a collector instance using Configuration Hub.

Procedure

If you want to use the Command Prompt window:
1. Run the RemoteCollectorConfigurator.exe file. By default, it is located in the following folder: C:\Program Files\GE Digital\NonWebCollectorInstantiationTool.
2. If you want to manually enter the installation parameters and values, run the following command:
```
RemoteCollectorConfigurator.exe "<Destination Historian>" "<Destination Historian username>" 
"<Destination Historian password>" InterfaceEditDestinationViaCmd "{\"<parameter>\":\"<value>\",
\"<parameter>\":\"<value>\"}"
```
  If you want to use a JSON file containing the installation parameters and values, run the following command:
```
RemoteCollectorConfigurator.exe "<Destination Historian>" "<Destination Historian username>" 
"<Destination Historian password>" InterfaceEditDestinationViaFile "<path to the JSON file>"
```
  Instead of manually creating the JSON file, you can use the RemoteCollectorConfigurator utility to generate it automatically.
  You can leave the Historian username and password blank if there are no Historian security user groups.
  For information on the parameters, refer to Collector Instance Parameters.
If you want to use an interactive UI:
1. Run the RemoteCollectorConfigurator.exe file. By default, it is located in the following folder: C:\Program Files\GE Digital\NonWebCollectorInstantiationTool.
  A list of options to manage collector instances appears.
2. Connect to the collector machine by entering 1 or 2, depending on whether collectors are installed locally or on a remote machine.
3. Enter 6.
  You are prompted to choose between entering the installation parameters manually and providing a JSON file.
4. If you want to manually enter the parameters and values, enter 1, and then run the following command:
```
{"<parameter>":"<value>","<parameter>":"<value>"}
```
  If you want to use a JSON file containing the installation parameters and values, enter 2, and then enter the path to the JSON file that you have created. Instead of manually creating the JSON file, you can use the RemoteCollectorConfigurator utility to generate it automatically.
  You can leave the Historian username and password blank if there are no Historian security user groups.
  For information on the parameters, refer to Collector Instance Parameters.

Results

The destination of the collector instance is modified.