SetVicParms

(Engine-Level Function)

Description:	Sets parameters for the VTScada Internet Client.
Returns:	Nothing
Usage:	Script Only.
Function Groups:	VTScada Internet Client
Related to:
Format:	SetVicParms(ReadTimeout, SessionTimeout, Mode[, AllowedOrigins])
Parameters:

ReadTimeout

Required. This is the length of time in seconds that the client will wait for the server to respond. Has a minimum of 5 seconds and a default of 15.

SessionTimeout

Required. This is the length of time in seconds that the server will wait for the client to respond. Has a minimum of 10 and a default of 60.

Mode

Required. VIC connection mode values are as follows (Defaults to 0)

Mode	Meaning
0	legacy
1	priority
2	sticky

AllowedOrigins

Optional. An array of the names of possible hosts that Anywhere clients will connect from. The VIC server will not communicate with Anywhere clients running from hosts not in that array.

Comments:

This module returns 1 if the parameters were set or Invalid if not.
Note that the changes made by this statement do not affect current VTScada Internet Connections. Only new connections will use the changed parameters. This statement is used internally by the VTScada System layer. Any changes made by this statement will be overwritten by the VTScada System layer on startup of the VTScada System layer and upon change of any setting in the Internet Client dialog.

Setting either the ReadTimeout or the SessionTimeout to values outside the recommended guidelines can have unpredictable effects on the ability of clients to maintain a reliable communication session with the server.

For the Anywhere Client, all entries in the server list are automatically added to the array of AllowedOrigins. Additional hosts may be added by specifying HostName = 1 in the [Clients-AdditionalAllowedOrigins] section of Setup.INI.