Running modes, Informational parameters – Rockwell Automation FactoryTalk Historian SE 3.0 UniInt Interface User Guide User Manual

Page 10

Advertising
background image

Interface Startup Parameters

4

Software\FactoryTalk Historian\PIPC\interfaces"

and

/path="C:\Program

Files\Rockwell Software\FactoryTalk Historian\PIPC\interfaces"

.

Each entry in the following tables presents the parameter and its description. The Parameter
column includes the UniInt default value for the parameter if there is one and whether or not
the parameter is required or optional.

Note: Parameter requirements vary from interface to interface. Refer to the

interface-specific documentation for interface-specific parameter requirements and
for the exceptions for using standard UniInt parameters.

Running Modes

Interfaces typically run as detached or background processes until stopped by a manual
shutdown or a system shutdown. There are a few parameters that cause an interface to output
some information and then shutdown immediately. An example of one of these parameters is
the /help parameter. If a UniInt based interface is executed with the
/help parameter, the interface will start, notice the parameter /help request, output the
help informational messages and then shut down. There is a short list of these parameters in a
separate table labeled Informational Parameters because all of the parameters in this list will
cause a UniInt based interface to start, output some information and then shut down. These
command-line parameters must appear on the command-line by themselves.

Informational Parameters

Parameter

Description

/?

Optional

On Windows, /? is the same as the /help parameter.

On all other platforms /? is the same as /h.

/h

Optional

Print a summary of command-line options supported by UniInt. The
interface-specific command-line options will also be printed if this is
supported by the interface.

/help

Optional, Windows
Only

In addition to printing the summary of command-line options from the
/h parameter, print a summary of command-line options for installing,
removing, and starting a Windows service.

/v

Optional

Print the version of the interface, the PI API installed on the interface
computer and the version of UniInt the interface was built against.

Advertising