Properties

The following properties apply to the BatchSecurity control.

AutoInit

When the AutoInit property is set to 1 (or checked on the Property page), the property initializes the connection to the Batch Server automatically when:

• The control is loaded in a running application.

• The application is switched from design mode to run mode (WindowMaker to WindowViewer).

The Security Manager service on the Batch Server must be running for the control to connect.

CheckByPassword

Set the CheckByPassword string property to the password for the Check-By user. This property is used for the windowless function clearance checks. Its use is described later in this chapter.

CheckByUserID

Set the CheckByUserID string property to the User ID for the Check-By user. This property is used for the windowless function clearance checks. Its use is described later in this chapter.

CheckByComment

Set the CheckByComment string property to the comment for the Check By user. This property is used for the windowless function clearance checks. Its use is described later in this chapter.

DoneByPassword

Set the DoneByPassword string property to the password for the Done-By user. This property is used for the windowless function clearance checks. Its use is described later in this chapter.

DoneByUserID

Set this string property to the User ID for the Done-By user. This property is used for the windowless function clearance checks. Its use is described later in this chapter.

DoneByComment

Set the DoneByComment string property to the comment for the Done-By user. This property is used for the windowless function clearance checks. Its use is described later in this chapter.

Host1

Set the Host1 property to the host name of the AVEVA Batch Management Server. In a redundant server architecture, this is the host name of the Primary Batch Server.

Host2

The Host2 property is only used with redundant server architectures. Set this property to the host name of the Redundant Batch Server.

LastErrorCode

The LastErrorCode property returns the error code (integer) of the most recent security request. A zero (0) indicates no error.

LastErrorMessage

The LastErrorMessage property returns the error message (string) of the most recent security request.

LastErrorRetriesExceeded

The LastErrorRetriesExceeded property returns the retries exceeded status (integer) of the most recent security request. The value is 1 if the retry limit has been exceeded. Otherwise, it is 0. Retries exceeded status can be cleared with the ResetRetries() method.

SecurityPending

The SecurityPending property returns a value (integer) indicating if a security request is pending. A non-zero value indicates a pending request. A zero (0) indicates no requests are pending. Any pending requests can be cancelled with the AbortPendingSecurity() method.

PortRedMngr

The PortRedMngr property is the user setting for the tcp application port definition used by the Redundancy Manager (RedMngr) on the batch server. It defaults to 9006 and should be the same as the tcp port definition for RedMngr on the batch server. This definition is found in the WINNT\system32\drivers\etc\services file on the batch server.

PortSecMngr

The PortSecMngr property is the user setting for the tcp application port definition used by the Security Manager (SecMngr) on the batch server. It defaults to 9004 and should be the same as the tcp port definition for SecMngr on the batch server. This definition is found in the WINNT\system32\drivers\etc\services file on the batch server.