Installing a Collector via the Command Line

About this task

Installing a collector can potentially remove a collector that is already installed. For example, if you already installed the OSI PI Collector and then run the silent install for the Server 2 Server Collector, the OSI PI Collector can be uninstalled. If you are installing a new collector on a machine where there is an existing collector that you want to retain, you must use command line parameters for the existing collector as well.

About this task

Several Historian collectors can be installed silently. A silent install is a method of installing the application software and requires little or no user interaction. This method allows you to perform an unattended installation as it is not necessary for you to direct the installation process. This command line install applies to the following collectors:
  • Server to Server
  • OSI PI Wonderware Data
  • File Collector
  • Calculation Collector
  • iFIX Collector
  • iFIX Alarm and Event Collector
Command-Line Syntax

Collectors_Install.exe

Argument

-s, -silent

Using either of these flags directs the install to progress silently, with no user interaction.

Parameters

<CollectorName>_AddLocal (1=install and 0= uninstall)

<CollectorName>_sourceservername

Note: Cloud parameters do not apply to the File Collector or Calculation Collector.
<CollectorName> _destinationservername
  • For a Historian destination use the machine name.
  • For a Predix Cloud destination, use "Cloud"

<CollectorName>_clouddestaddress

<CollectorName>_identityissuer

<CollectorName>_clientid

<CollectorName>_zoneid

<CollectorName>_proxy

<CollectorName>_proxyusername

<CollectorName>_proxypassword

<CollectorName>_datapointattributekey1

<CollectorName>_datapointattributevalue1

<CollectorName>_datapointattributekey2

<CollectorName>_datapointattributevalue2

<CollectorName>_datapointattributekey3

<CollectorName>_datapointattributevalue3

<CollectorName>_datapointattributekey4

<CollectorName>_datapointattributevalue4

<CollectorName>_datapointattributekey5

<CollectorName>_datapointattributevalue5

Performing a silent install

Important: Installing a collector can potentially remove a collector that is already installed. For example, if you already installed the OSI PI Collector and then run the silent install for the Server 2 Server Collector, the OSI PI Collector can be uninstalled. If you are installing a new collector on a machine where there is an existing collector that you want to retain, you must use command line parameters for the existing collector as well.

Procedure

  1. Navigate to the Collectors folder on the install media.
  2. Open a command prompt window and enter the following command line: Collectors_Install.exe -s
  3. Add parameters as appropriate and assign the correct values to the parameters using the equal sign (=).
  4. Be sure to replace <CollectorName> with the name of your collector. For example, you might replace <CollectorName> with <HistorianS2SCollector>.
    For example, HistorianS2SCollector_AddLocal=1
    Note: If the parameters are not assigned a value, then the default values are used.
  5. After the Historian collector silent install, you must reboot, otherwise, subsequent installs will fail.

What to do next

Example 1:

This command installs the Historian Server 2 Server collector and sets the source server to be PC1 and destination server to be PC2.

>Collectors_Install.exe -s HistorianS2SCollector_AddLocal=1 HistorianS2SCollector_sourceservername=PC1 HistorianS2SCollector_destinationservername=PC2

Example 2:

This command installs the Historian File Collector and sets the destination server name to be PC1.

>Collectors_Install.exe -s HistorianFileCollector_AddLocal=1 HistorianFileCollector_destinationservername=PC1

Example 3:

This command installs the Historian Calculation Collector and the File Collector, and sets the destination server name to be PC1 for each collector.

>Collectors_Install.exe -s HistorianCalculationCollector_AddLocal=1 HistorianCalculationCollector_destinationservername=PC1 HistorianFileCollector_AddLocal=1 HistorianFileCollector_destinationservername=PC1

Example 4:

This command installs the Historian Server-To-Server collector, sets the destination server name to cloud (Predix or Azure IoT Hub), and uses proxy authentication to connect to the Historian server.

Collectors_Install.exe -s HistorianS2SCollector_AddLocal=1 HistorianS2SCollector_sourceservername=PC1 HistorianS2SCollector_destinationservername=Cloud HistorianS2SCollector_clouddestaddress=wss://gateway/stream/messages HistorianS2SCollector_identityissuer=myIdentifyIssuer HistorianS2SCollector_clientid=sampleClientid HistorianS2SCollector_zoneid=my-zone HistorianS2SCollector_proxy=proxyurl HistorianS2SCollector_proxyusername=myProxyUser HistorianS2SCollector_proxypassword=myProxyPassword