CasClient Properties

The CasClient object contains the following properties. The GetReferences method must be called before the properties will be populated.

Property SubType Read Only Description

AccessControlService

String

Yes

Returns the name of the ACS associated with a given service. If no ACS is associated with a given service, an empty string is returned.

AuditService

String

Yes

Returns the name of the AUD associated with a given service. If no AUD is associated with a given service, an empty string is returned.

AuxilliaryService1

String

Yes

This property is currently not used by the Client object.

AuxilliaryService2

String

Yes

This property is currently not used by the Client object.

CommonAlarmService

String

Yes

This property is currently not used by the Client object.

ConfigurationManagementService

String

Yes

This property is currently not used by the Client object.

GeneralNotificationService

String

Yes

This property is currently not used by the Client object.

IsConnected

Boolean

Yes

Returns True if the Client object is connected to a SITE.SERVICE. Returns False if it is not.

SecurityApplication

String

Yes

Returns the configured security application for the service. This is the ACS_APPLICATION keyword in the service configuration file.

SecurityEvent

String

Yes

Returns the name of the configured security event(s) for the service. The value(s) correspond with security event keyword(s) in the Security Keywords section of the Service configuration file.

SecurityEvent requires an index parameter. The index parameters identify security event keywords as follows:

  • (0) = DBS_MAIN_SEC_EVENT
  • (1) = DBS_SEC_EVENT_1
  • (2) = DBS_SEC_EVENT_2
  • (3) = DBS_SEC_EVENT_3
  • (4) = DBS_SEC_EVENT_4
  • (5) = DBS_SEC_EVENT_5

For example, <SvcName>Client.SecurityEvent(0) returns the event associated with DBS_MAIN_SEC_EVENT.

See Security Keywords in the service configuration file.

SecurityLevel

String

Yes

Returns the security level of the current user for the configured app and event at the specified level. This property can be one of the following values:

  • N — Access Level 0: No Access
  • R — Access Level 1: Read Access
  • U — Access Level 2: Update Access
  • A — Access Level 3: Add Access
  • D — Access Level 4: Delete Access
  • M — Access Level 5: Admin Access.

ServiceDirectory

String

Yes

Returns the type of service to which the client is connected.

ServiceType

String

Yes

Returns the type of service to which the client is connected.

SiteService

String

No

The site and service to connect to, in "site.service" format.

SystemAdministrationService

String

Yes

This property is currently not used by the Client object.

SystemLoggingService

String

Yes

Returns the name of the ELS configured for this service. If no ELS is associated with a service, an empty string is returned.

Must call GetReferences method first.

TableReferenceService1

String

Yes

This property is currently not used by the Client object.

TableReferenceService2

String

Yes

This property is currently not used by the Client object.

TableReferenceService3

String

Yes

Returns the name of the AUD service configured for this service.

Must call GetReferences method first.

UserId

String

Yes

Returns the current user ID of the client program.

ValueHistoryService

String

Yes

This property is currently not used by the Client object.

Back to top