OriginatingPIUser Property (IMessageSendNames Interface)

                    

 

OriginatingPIUser is a read-only property of the IMessageSendNames interface that returns the message parameter name expected by the MessageLog2.SendLogMessage method for specifying the user defined property OriginatingPIUser.

 

An originating PI user represents the authenticated PI user sending a message as determined by an application.  The MessageLog2.SendLogMessage method will automatically add the ProcessPIUser to any log message sent to a PI server's Message log (remote messages).  When sending messages to the local log the PI-SDK can not determine the proper PI user so this property is not added automatically though can be explicitly sent by an application.  In some cases, such as an application server, the PI user associated with the application's process may not be the PI user that the message pertains to.  In this case the application may choose to use the OriginatingPIUser property of a message to clearly define the authenticated PI user sending the message or related to the message's contents.

 

Syntax

object.OriginatingPIUser

The object placeholder is an object expression that evaluates to a IMessageSendNames  interface.

Remarks
The IMessageSendNames interface can be obtained directly from the MessageLog2.MessageSendNames property or by using QueryInterface (assignment, in VB, casting in .Net) on a MessageLog or MessageLog2 object.

When adding to the NamedValues collection, the IMessageSendNames interface acts with Intellisense to show the available parameter options and ensures only names that are supported are used.

 

Enabling Operational Intelligence